| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="gkehub_v1beta.html">GKE Hub API</a> . <a href="gkehub_v1beta.projects.html">projects</a> . <a href="gkehub_v1beta.projects.locations.html">locations</a> . <a href="gkehub_v1beta.projects.locations.rollouts.html">rollouts</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#forceCompleteStage">forceCompleteStage(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Force-completes a rollout stage. Only the active stage of an active rollout can be force-completed.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a single rollout.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the list of all rollouts.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="forceCompleteStage">forceCompleteStage(name, body=None, x__xgafv=None)</code> |
| <pre>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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>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 |
| "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. |
| "endTime": "A String", # Optional. Output only. The time at which the stage ended. |
| "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. |
| "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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>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 |
| "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. |
| "endTime": "A String", # Optional. Output only. The time at which the stage ended. |
| "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. |
| "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. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
