cancel(name, body=None, x__xgafv=None)

Cancels a Rollout. The rollout will not be started on new clusters, however the rollout running on the cluster will be allowed to finish.

Args:
name: string, Required. The name of the rollout to cancel. projects/{project}/locations/{location}/rollouts/{rollout} (required)
body: object, The request body.
The object takes the form of:

{ # Request message for cancelling a rollout.
}

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.
},
}

close()

Close httplib2 connections.

delete(name, requestId=None, x__xgafv=None)

Removes a Rollout.

Args:
name: string, Required. The name of the rollout to delete. projects/{project}/locations/{location}/rollouts/{rollout} (required)
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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.
},
}

forceCompleteStage(name, body=None, x__xgafv=None)

Force-completes a rollout stage. Only the active stage of an active rollout can be force-completed.

Args:
name: string, Required. The name of the rollout. Format: projects/{project}/locations/{location}/rollouts/{rollout} (required)
body: object, The request body.
The object takes the form of:

{ # Request message for force-completing a rollout stage.
"stageNumber": 42, # Required. The stage number to force-complete.
}

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)

Retrieves a single rollout.

Args:
  name: string, Required. The name of the rollout to retrieve. projects/{project}/locations/{location}/rollouts/{rollout} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Rollout contains the Rollout metadata and configuration. Next ID: 28
  "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed.
  "createTime": "A String", # Output only. The timestamp at which the Rollout was created.
  "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted.
  "displayName": "A String", # Optional. Human readable display name of the Rollout.
  "etag": "A String", # Output only. etag of the Rollout Ex. abc1234
  "intent": "A String", # Output only. The intent of the rollout.
  "labels": { # Optional. Labels for this Rollout.
    "a_key": "A String",
  },
  "membershipStates": { # Output only. States of upgrading control plane or node pool targets of a single cluster (GKE Hub membership) that's part of this Rollout. The key is the membership name of the cluster. The value is the state of the cluster.
    "a_key": { # Metadata about single cluster (GKE Hub membership) that's part of this Rollout.
      "lastUpdateTime": "A String", # Optional. Output only. The time this status and any related Rollout-specific details for the membership were updated.
      "stageAssignment": 42, # Output only. The stage assignment of this cluster in this rollout.
      "targets": [ # Output only. The targets of the rollout - clusters or node pools that are being upgraded. All targets belongs to the same cluster, identified by the membership name (key of membership_states map).
        { # Metadata about the status of targets (clusters or node pools) involved in the Rollout.
          "cluster": "A String", # Optional. Output only. The resource link of the Cluster resource upgraded in this Rollout. It is formatted as: `//{api_service}/projects/{project_number}/locations/{location}/clusters/{cluster_name}`. .
          "nodePool": "A String", # Optional. Output only. The resource link of the NodePool resource upgraded in this Rollout. It is formatted as: `//{api_service}/projects/{project_number}/locations/{location}/clusters/{cluster_name}/nodePools/{node_pool_name}`.
          "operation": "A String", # Optional. Output only. The operation resource name performing the mutation.
          "reason": "A String", # Optional. Output only. A human-readable description of the current status.
          "state": "A String", # Output only. The high-level, machine-readable status of this Rollout for the target.
        },
      ],
    },
  },
  "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.
  "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`.
  "stages": [ # Output only. The stages of the Rollout.
    { # Stage represents a single stage in the Rollout.
      "clusterSelector": { # Selector for clusters. # Output only. The selector from the sequence that was used to create this stage. Example CEL expression: resource.labels.canary == 'true'
        "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`.
      },
      "endTime": "A String", # Optional. Output only. The time at which the stage ended.
      "fleetProjects": [ # Output only. The fleet projects from the sequence that was used to create this stage. Expected format: projects/{project_number}
        "A String",
      ],
      "soakDuration": "A String", # Optional. Duration to soak after this stage before starting the next stage.
      "stageNumber": 42, # Output only. The stage number to which this status applies.
      "startTime": "A String", # Optional. Output only. The time at which the stage started.
      "state": "A String", # Output only. The state of the stage.
    },
  ],
  "state": "A String", # Output only. State specifies various states of the Rollout.
  "stateReason": "A String", # Output only. A human-readable description explaining the reason for the current state.
  "stateReasonType": "A String", # Output only. StateReasonType specifies the reason type of the Rollout state.
  "trigger": "A String", # Output only. The trigger of the rollout.
  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout resources. If a Rollout 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 was last updated.
  "versionUpgrade": { # Config for version upgrade of clusters. # Optional. Config for version upgrade of clusters.
    "desiredVersion": "A String", # Optional. Desired version of the component.
    "type": "A String", # Optional. Type of version upgrade specifies which component should be upgraded.
  },
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Retrieves the list of all rollouts.

Args:
  parent: string, Required. The parent, which owns this collection of rollout. Format: projects/{project}/locations/{location} (required)
  filter: string, Optional. Lists Rollouts that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
  pageSize: integer, The maximum number of rollout to return. The service may return fewer than this value. If unspecified, at most 50 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollouts` 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 rollouts.
  "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.
  "rollouts": [ # The rollouts from the specified parent resource.
    { # Rollout contains the Rollout metadata and configuration. Next ID: 28
      "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed.
      "createTime": "A String", # Output only. The timestamp at which the Rollout was created.
      "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted.
      "displayName": "A String", # Optional. Human readable display name of the Rollout.
      "etag": "A String", # Output only. etag of the Rollout Ex. abc1234
      "intent": "A String", # Output only. The intent of the rollout.
      "labels": { # Optional. Labels for this Rollout.
        "a_key": "A String",
      },
      "membershipStates": { # Output only. States of upgrading control plane or node pool targets of a single cluster (GKE Hub membership) that's part of this Rollout. The key is the membership name of the cluster. The value is the state of the cluster.
        "a_key": { # Metadata about single cluster (GKE Hub membership) that's part of this Rollout.
          "lastUpdateTime": "A String", # Optional. Output only. The time this status and any related Rollout-specific details for the membership were updated.
          "stageAssignment": 42, # Output only. The stage assignment of this cluster in this rollout.
          "targets": [ # Output only. The targets of the rollout - clusters or node pools that are being upgraded. All targets belongs to the same cluster, identified by the membership name (key of membership_states map).
            { # Metadata about the status of targets (clusters or node pools) involved in the Rollout.
              "cluster": "A String", # Optional. Output only. The resource link of the Cluster resource upgraded in this Rollout. It is formatted as: `//{api_service}/projects/{project_number}/locations/{location}/clusters/{cluster_name}`. .
              "nodePool": "A String", # Optional. Output only. The resource link of the NodePool resource upgraded in this Rollout. It is formatted as: `//{api_service}/projects/{project_number}/locations/{location}/clusters/{cluster_name}/nodePools/{node_pool_name}`.
              "operation": "A String", # Optional. Output only. The operation resource name performing the mutation.
              "reason": "A String", # Optional. Output only. A human-readable description of the current status.
              "state": "A String", # Output only. The high-level, machine-readable status of this Rollout for the target.
            },
          ],
        },
      },
      "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.
      "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`.
      "stages": [ # Output only. The stages of the Rollout.
        { # Stage represents a single stage in the Rollout.
          "clusterSelector": { # Selector for clusters. # Output only. The selector from the sequence that was used to create this stage. Example CEL expression: resource.labels.canary == 'true'
            "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`.
          },
          "endTime": "A String", # Optional. Output only. The time at which the stage ended.
          "fleetProjects": [ # Output only. The fleet projects from the sequence that was used to create this stage. Expected format: projects/{project_number}
            "A String",
          ],
          "soakDuration": "A String", # Optional. Duration to soak after this stage before starting the next stage.
          "stageNumber": 42, # Output only. The stage number to which this status applies.
          "startTime": "A String", # Optional. Output only. The time at which the stage started.
          "state": "A String", # Output only. The state of the stage.
        },
      ],
      "state": "A String", # Output only. State specifies various states of the Rollout.
      "stateReason": "A String", # Output only. A human-readable description explaining the reason for the current state.
      "stateReasonType": "A String", # Output only. StateReasonType specifies the reason type of the Rollout state.
      "trigger": "A String", # Output only. The trigger of the rollout.
      "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout resources. If a Rollout 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 was last updated.
      "versionUpgrade": { # Config for version upgrade of clusters. # Optional. Config for version upgrade of clusters.
        "desiredVersion": "A String", # Optional. Desired version of the component.
        "type": "A String", # Optional. Type of version upgrade specifies which component should be upgraded.
      },
    },
  ],
}

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.

pause(name, body=None, x__xgafv=None)

Pauses a running Rollout. The rollout will not be started on new clusters, however the rollout running on the cluster will be allowed to finish.

Args:
name: string, Required. The name of the rollout to pause. projects/{project}/locations/{location}/rollouts/{rollout} (required)
body: object, The request body.
The object takes the form of:

{ # Request message for pausing a rollout.
}

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.
},
}

resume(name, body=None, x__xgafv=None)

Resume a paused Rollout. The rollout will be resumed and allowed to be started on clusters.

Args:
name: string, Required. The name of the rollout to resume. projects/{project}/locations/{location}/rollouts/{rollout} (required)
body: object, The request body.
The object takes the form of:

{ # Request message for resuming a rollout.
"scheduleOffset": "A String", # Optional. The duration to offset the Rollout schedule by.
"validateOnly": True or False, # Optional. If set, resume rollout will be executed in dry-run mode.
}

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.
},
}

GKE Hub API . projects . locations . rollouts

Instance Methods

Method Details