Console
    Start free

    MCP Tools Reference: saasservicemgmt

    Tool: list_rollout_kinds

    Lists RolloutKind resources. Required parameter: 'parent' (e.g. projects/my-project/locations/us-central1). Optional parameters: 'page_size', 'page_token', 'filter', 'order_by'.

    The following sample demonstrate how to use curl to invoke the list_rollout_kinds MCP tool.

    Curl Request 
      
curl  
--location  
 'https://saasservicemgmt.googleapis.com/mcp' 
  
 \ 
--header  
 'content-type: application/json' 
  
 \ 
--header  
 'accept: application/json, text/event-stream' 
  
 \ 
--data  
 '{ 
 "method": "tools/call", 
 "params": { 
 "name": "list_rollout_kinds", 
 "arguments": { 
 // provide these details according to the tool' 
s  
MCP  
specification  
 } 
  
 } 
,  
 "jsonrpc" 
:  
 "2.0" 
,  
 "id" 
:  
 1 
 } 
 '

    Input Schema

    The request structure for the ListRolloutKinds method.

    ListRolloutKindsRequest

    JSON representation 
     { 
 "parent" 
 : 
 string 
 , 
 "pageSize" 
 : 
 integer 
 , 
 "pageToken" 
 : 
 string 
 , 
 "filter" 
 : 
 string 
 , 
 "orderBy" 
 : 
 string 
 }
    Fields
    parent

    string

    Required. The parent of the rollout kind.
    pageSize

    integer

    The maximum number of rollout kinds to send per page.
    pageToken

    string

    The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
    filter

    string

    Filter the list as specified in https://google.aip.dev/160 .
    orderBy

    string

    Order results as specified in https://google.aip.dev/132 .

    Output Schema

    The response structure for the ListRolloutKinds method.

    ListRolloutKindsResponse

    JSON representation 
     { 
 "rolloutKinds" 
 : 
 [ 
 { 
 object (  RolloutKind 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "unreachable" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    rolloutKinds[]

    object ( RolloutKind )

    The resulting rollout kinds.
    nextPageToken

    string

    If present, the next page token can be provided to a subsequent ListRolloutKinds call to list the next page. If empty, there are no more pages.
    unreachable[]

    string

    Locations that could not be reached.

    RolloutKind

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "unitKind" 
 : 
 string 
 , 
 "rolloutOrchestrationStrategy" 
 : 
 string 
 , 
 "unitFilter" 
 : 
 string 
 , 
 "updateUnitKindStrategy" 
 : 
 enum ( UpdateUnitKindStrategy 
) 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "annotations" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "uid" 
 : 
 string 
 , 
 "etag" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 // Union field _error_budget 
can be only one of the following: 
 "errorBudget" 
 : 
 { 
 object (  ErrorBudget 
 
) 
 } 
 // End of list of possible types for union field _error_budget 
. 
 }
    Fields
    name

    string

    Identifier. The resource name (full URI of the resource) following the standard naming scheme:

    "projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}"

    unitKind

    string

    Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.

    rolloutOrchestrationStrategy

    string

    Optional. The strategy used for executing a Rollout. This is a required field.

    There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime"

    A rollout with one of these simple strategies will rollout across all locations defined in the associated UnitKind's Saas Locations.

    unitFilter

    string

    Optional. CEL( https://github.com/google/cel-spec ) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout.

    updateUnitKindStrategy

    enum ( UpdateUnitKindStrategy )

    Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.

    labels

    map (key: string, value: string)

    Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    annotations

    map (key: string, value: string)

    Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

    More info: https://kubernetes.io/docs/user-guide/annotations

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    uid

    string

    Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

    etag

    string

    Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

    createTime

    string ( Timestamp format)

    Output only. The timestamp when the resource was created.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    updateTime

    string ( Timestamp format)

    Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    Union field _error_budget .

    _error_budget can be only one of the following:

    errorBudget

    object ( ErrorBudget )

    Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.

    ErrorBudget

    JSON representation 
     { 
 // Union field _allowed_count 
can be only one of the following: 
 "allowedCount" 
 : 
 integer 
 // End of list of possible types for union field _allowed_count 
. 
 // Union field _allowed_percentage 
can be only one of the following: 
 "allowedPercentage" 
 : 
 integer 
 // End of list of possible types for union field _allowed_percentage 
. 
 }
    Fields

    Union field _allowed_count .

    _allowed_count can be only one of the following:

    allowedCount

    integer

    Optional. The maximum number of failed units allowed in a location without pausing the rollout.

    Union field _allowed_percentage .

    _allowed_percentage can be only one of the following:

    allowedPercentage

    integer

    Optional. The maximum percentage of units allowed to fail (0, 100] within a location without pausing the rollout.

    LabelsEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 }
    Fields
    key

    string

    value

    string

    AnnotationsEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 }
    Fields
    key

    string

    value

    string

    Timestamp

    JSON representation 
     { 
 "seconds" 
 : 
 string 
 , 
 "nanos" 
 : 
 integer 
 }
    Fields
    seconds

    string ( int64 format)

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
    nanos

    integer

    Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

    Tool Annotations

    Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: