Close httplib2 connections.
create(parent, body=None, rolloutSequenceId=None, x__xgafv=None)
Create a new rollout sequence resource.
Remove a RolloutSequence.
Retrieve a single rollout sequence.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Retrieve the list of all rollout sequences.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update a rollout sequence.
close()
Close httplib2 connections.
create(parent, body=None, rolloutSequenceId=None, x__xgafv=None)
Create a new rollout sequence resource.
Args:
parent: string, Required. The parent resource where this rollout sequence will be created. projects/{project}/locations/{location} (required)
body: object, The request body.
The object takes the form of:
{ # RolloutSequence defines the desired order of upgrades.
"createTime": "A String", # Output only. The timestamp at which the Rollout Sequence was created.
"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted.
"displayName": "A String", # Optional. Human readable display name of the Rollout Sequence.
"etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234
"labels": { # Optional. Labels for this Rollout Sequence.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME}
"stages": [ # Required. Ordered list of stages that constitutes this Rollout.
{ # Rollout stage.
"clusterSelector": { # Selector for clusters. # Optional. Filter members of fleets (above) to a subset of clusters. If not specified, all clusters in the fleets are selected.
"labelSelector": "A String", # The label selector must be a valid CEL (go/cel) expression which evaluates resource.labels.
},
"fleetProjects": [ # Required. List of Fleet projects to select the clusters from. Expected format: projects/{project}
"A String",
],
"soakDuration": "A String", # Optional. Soak time after upgrading all the clusters in the stage.
},
],
"uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout Sequence resources. If a Rollout Sequence resource is deleted and another resource with the same name is created, it gets a different uid.
"updateTime": "A String", # Output only. The timestamp at which the Rollout Sequence was last updated.
}
rolloutSequenceId: string, Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, x__xgafv=None)
Remove a RolloutSequence.
Args:
name: string, Required. The name of the rollout sequence to delete. projects/{project}/locations/{location}/rolloutSequences/{rollout_sequence} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Retrieve a single rollout sequence.
Args:
name: string, Required. The name of the rollout sequence to retrieve. projects/{project}/locations/{location}/rolloutSequences/{rollout_sequence} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # RolloutSequence defines the desired order of upgrades.
"createTime": "A String", # Output only. The timestamp at which the Rollout Sequence was created.
"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted.
"displayName": "A String", # Optional. Human readable display name of the Rollout Sequence.
"etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234
"labels": { # Optional. Labels for this Rollout Sequence.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME}
"stages": [ # Required. Ordered list of stages that constitutes this Rollout.
{ # Rollout stage.
"clusterSelector": { # Selector for clusters. # Optional. Filter members of fleets (above) to a subset of clusters. If not specified, all clusters in the fleets are selected.
"labelSelector": "A String", # The label selector must be a valid CEL (go/cel) expression which evaluates resource.labels.
},
"fleetProjects": [ # Required. List of Fleet projects to select the clusters from. Expected format: projects/{project}
"A String",
],
"soakDuration": "A String", # Optional. Soak time after upgrading all the clusters in the stage.
},
],
"uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout Sequence resources. If a Rollout Sequence resource is deleted and another resource with the same name is created, it gets a different uid.
"updateTime": "A String", # Output only. The timestamp at which the Rollout Sequence was last updated.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Retrieve the list of all rollout sequences.
Args:
parent: string, Required. The parent, which owns this collection of rollout sequences. Format: projects/{project}/locations/{location} (required)
filter: string, Optional. Lists Rollout Sequences that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
pageSize: integer, Optional. The maximum number of rollout sequences to return. The service may return fewer than this value. If unspecified, at most 50 rollout sequences will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListRolloutSequences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRolloutSequences` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing rollout sequences.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"rolloutSequences": [ # The rollout sequences from the specified parent resource.
{ # RolloutSequence defines the desired order of upgrades.
"createTime": "A String", # Output only. The timestamp at which the Rollout Sequence was created.
"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted.
"displayName": "A String", # Optional. Human readable display name of the Rollout Sequence.
"etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234
"labels": { # Optional. Labels for this Rollout Sequence.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME}
"stages": [ # Required. Ordered list of stages that constitutes this Rollout.
{ # Rollout stage.
"clusterSelector": { # Selector for clusters. # Optional. Filter members of fleets (above) to a subset of clusters. If not specified, all clusters in the fleets are selected.
"labelSelector": "A String", # The label selector must be a valid CEL (go/cel) expression which evaluates resource.labels.
},
"fleetProjects": [ # Required. List of Fleet projects to select the clusters from. Expected format: projects/{project}
"A String",
],
"soakDuration": "A String", # Optional. Soak time after upgrading all the clusters in the stage.
},
],
"uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout Sequence resources. If a Rollout Sequence resource is deleted and another resource with the same name is created, it gets a different uid.
"updateTime": "A String", # Output only. The timestamp at which the Rollout Sequence was last updated.
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update a rollout sequence.
Args:
name: string, Identifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME} (required)
body: object, The request body.
The object takes the form of:
{ # RolloutSequence defines the desired order of upgrades.
"createTime": "A String", # Output only. The timestamp at which the Rollout Sequence was created.
"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted.
"displayName": "A String", # Optional. Human readable display name of the Rollout Sequence.
"etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234
"labels": { # Optional. Labels for this Rollout Sequence.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME}
"stages": [ # Required. Ordered list of stages that constitutes this Rollout.
{ # Rollout stage.
"clusterSelector": { # Selector for clusters. # Optional. Filter members of fleets (above) to a subset of clusters. If not specified, all clusters in the fleets are selected.
"labelSelector": "A String", # The label selector must be a valid CEL (go/cel) expression which evaluates resource.labels.
},
"fleetProjects": [ # Required. List of Fleet projects to select the clusters from. Expected format: projects/{project}
"A String",
],
"soakDuration": "A String", # Optional. Soak time after upgrading all the clusters in the stage.
},
],
"uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout Sequence resources. If a Rollout Sequence resource is deleted and another resource with the same name is created, it gets a different uid.
"updateTime": "A String", # Output only. The timestamp at which the Rollout Sequence was last updated.
}
updateMask: string, Optional. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}