docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/container_v1beta1.projects.zones.operations.html b/docs/dyn/container_v1beta1.projects.zones.operations.html
index 943b5af..a6dd83c 100644
--- a/docs/dyn/container_v1beta1.projects.zones.operations.html
+++ b/docs/dyn/container_v1beta1.projects.zones.operations.html
@@ -102,17 +102,17 @@
The object takes the form of:
{ # CancelOperationRequest cancels a single operation.
- "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project
+ "name": "A String", # The name (project, location, operation id) of the operation to cancel.
+ # Specified in the format `projects/*/locations/*/operations/*`.
+ "operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation.
+ # This field has been deprecated and replaced by the name field.
+ "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project
# number](https://support.google.com/cloud/answer/6158840).
# This field has been deprecated and replaced by the name field.
- "name": "A String", # The name (project, location, operation id) of the operation to cancel.
- # Specified in the format 'projects/*/locations/*/operations/*'.
- "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine
+ "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine
# [zone](https://cloud.google.com/compute/docs/zones#available) in which the
# operation resides. This field has been deprecated and replaced by the name
# field.
- "operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation.
- # This field has been deprecated and replaced by the name field.
}
x__xgafv: string, V1 error format.
@@ -150,7 +150,7 @@
operationId: string, Required. Deprecated. The server-assigned `name` of the operation.
This field has been deprecated and replaced by the name field. (required)
name: string, The name (project, location, operation id) of the operation to get.
-Specified in the format 'projects/*/locations/*/operations/*'.
+Specified in the format `projects/*/locations/*/operations/*`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -161,61 +161,61 @@
{ # This operation resource represents operations that may have happened or are
# happening on the cluster. All fields are output only.
- "status": "A String", # The current status of the operation.
- "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
- "endTime": "A String", # [Output only] The time the operation completed, in
- # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "name": "A String", # The server-assigned ID for the operation.
- "zone": "A String", # The name of the Google Compute Engine
- # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
- # operation is taking place. This field is deprecated, use location instead.
- "clusterConditions": [ # Which conditions caused the current cluster state.
+ "nodepoolConditions": [ # Which conditions caused the current node pool state.
{ # StatusCondition describes why a cluster or a node pool has a certain status
# (e.g., ERROR or DEGRADED).
- "message": "A String", # Human-friendly representation of the condition
- "code": "A String", # Machine-friendly representation of the condition
+ "code": "A String", # Machine-friendly representation of the condition
+ "message": "A String", # Human-friendly representation of the condition
},
],
- "startTime": "A String", # [Output only] The time the operation started, in
- # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "detail": "A String", # Detailed operation progress, if available.
- "targetLink": "A String", # Server-defined URL for the target of the operation.
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
- "status": "A String", # Status of an operation stage.
- # Unset for single-stage operations.
- "metrics": [ # Progress metric bundle, for example:
- # metrics: [{name: "nodes done", int_value: 15},
- # {name: "nodes total", int_value: 32}]
- # or
- # metrics: [{name: "progress", double_value: 0.56},
- # {name: "progress scale", double_value: 1.0}]
- { # Progress metric is (string, int|float|string) pair.
- "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
- "intValue": "A String", # For metrics with integer value.
- "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
- "doubleValue": 3.14, # For metrics with floating point value.
- },
- ],
- "stages": [ # Substages of an operation or a stage.
- # Object with schema name: OperationProgress
- ],
- "name": "A String", # A non-parameterized string describing an operation stage.
- # Unset for single-stage operations.
- },
- "nodepoolConditions": [ # Which conditions caused the current node pool state.
- { # StatusCondition describes why a cluster or a node pool has a certain status
- # (e.g., ERROR or DEGRADED).
- "message": "A String", # Human-friendly representation of the condition
- "code": "A String", # Machine-friendly representation of the condition
- },
- ],
- "selfLink": "A String", # Server-defined URL for the resource.
- "location": "A String", # [Output only] The name of the Google Compute Engine
+ "location": "A String", # [Output only] The name of the Google Compute Engine
# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
# or
# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
# in which the cluster resides.
+ "endTime": "A String", # [Output only] The time the operation completed, in
+ # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "startTime": "A String", # [Output only] The time the operation started, in
+ # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "clusterConditions": [ # Which conditions caused the current cluster state.
+ { # StatusCondition describes why a cluster or a node pool has a certain status
+ # (e.g., ERROR or DEGRADED).
+ "code": "A String", # Machine-friendly representation of the condition
+ "message": "A String", # Human-friendly representation of the condition
+ },
+ ],
+ "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "stages": [ # Substages of an operation or a stage.
+ # Object with schema name: OperationProgress
+ ],
+ "status": "A String", # Status of an operation stage.
+ # Unset for single-stage operations.
+ "metrics": [ # Progress metric bundle, for example:
+ # metrics: [{name: "nodes done", int_value: 15},
+ # {name: "nodes total", int_value: 32}]
+ # or
+ # metrics: [{name: "progress", double_value: 0.56},
+ # {name: "progress scale", double_value: 1.0}]
+ { # Progress metric is (string, int|float|string) pair.
+ "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
+ "doubleValue": 3.14, # For metrics with floating point value.
+ "intValue": "A String", # For metrics with integer value.
+ "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
+ },
+ ],
+ "name": "A String", # A non-parameterized string describing an operation stage.
+ # Unset for single-stage operations.
+ },
+ "zone": "A String", # The name of the Google Compute Engine
+ # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
+ # operation is taking place. This field is deprecated, use location instead.
+ "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
+ "selfLink": "A String", # Server-defined URL for the resource.
+ "targetLink": "A String", # Server-defined URL for the target of the operation.
+ "detail": "A String", # Detailed operation progress, if available.
+ "operationType": "A String", # The operation type.
+ "status": "A String", # The current status of the operation.
+ "name": "A String", # The server-assigned ID for the operation.
}</pre>
</div>
@@ -232,8 +232,8 @@
operations for, or `-` for all zones. This field has been deprecated and
replaced by the parent field. (required)
parent: string, The parent (project and location) where the operations will be listed.
-Specified in the format 'projects/*/locations/*'.
-Location "-" matches all zones and all regions.
+Specified in the format `projects/*/locations/*`.
+Location "-" matches all zones and all regions.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -243,69 +243,69 @@
An object of the form:
{ # ListOperationsResponse is the result of ListOperationsRequest.
- "operations": [ # A list of operations in the project in the specified zone.
+ "operations": [ # A list of operations in the project in the specified zone.
{ # This operation resource represents operations that may have happened or are
# happening on the cluster. All fields are output only.
- "status": "A String", # The current status of the operation.
- "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
- "endTime": "A String", # [Output only] The time the operation completed, in
- # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "name": "A String", # The server-assigned ID for the operation.
- "zone": "A String", # The name of the Google Compute Engine
- # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
- # operation is taking place. This field is deprecated, use location instead.
- "clusterConditions": [ # Which conditions caused the current cluster state.
+ "nodepoolConditions": [ # Which conditions caused the current node pool state.
{ # StatusCondition describes why a cluster or a node pool has a certain status
# (e.g., ERROR or DEGRADED).
- "message": "A String", # Human-friendly representation of the condition
- "code": "A String", # Machine-friendly representation of the condition
+ "code": "A String", # Machine-friendly representation of the condition
+ "message": "A String", # Human-friendly representation of the condition
},
],
- "startTime": "A String", # [Output only] The time the operation started, in
- # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "detail": "A String", # Detailed operation progress, if available.
- "targetLink": "A String", # Server-defined URL for the target of the operation.
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
- "status": "A String", # Status of an operation stage.
- # Unset for single-stage operations.
- "metrics": [ # Progress metric bundle, for example:
- # metrics: [{name: "nodes done", int_value: 15},
- # {name: "nodes total", int_value: 32}]
- # or
- # metrics: [{name: "progress", double_value: 0.56},
- # {name: "progress scale", double_value: 1.0}]
- { # Progress metric is (string, int|float|string) pair.
- "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
- "intValue": "A String", # For metrics with integer value.
- "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
- "doubleValue": 3.14, # For metrics with floating point value.
- },
- ],
- "stages": [ # Substages of an operation or a stage.
- # Object with schema name: OperationProgress
- ],
- "name": "A String", # A non-parameterized string describing an operation stage.
- # Unset for single-stage operations.
- },
- "nodepoolConditions": [ # Which conditions caused the current node pool state.
- { # StatusCondition describes why a cluster or a node pool has a certain status
- # (e.g., ERROR or DEGRADED).
- "message": "A String", # Human-friendly representation of the condition
- "code": "A String", # Machine-friendly representation of the condition
- },
- ],
- "selfLink": "A String", # Server-defined URL for the resource.
- "location": "A String", # [Output only] The name of the Google Compute Engine
+ "location": "A String", # [Output only] The name of the Google Compute Engine
# [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
# or
# [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
# in which the cluster resides.
+ "endTime": "A String", # [Output only] The time the operation completed, in
+ # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "startTime": "A String", # [Output only] The time the operation started, in
+ # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "clusterConditions": [ # Which conditions caused the current cluster state.
+ { # StatusCondition describes why a cluster or a node pool has a certain status
+ # (e.g., ERROR or DEGRADED).
+ "code": "A String", # Machine-friendly representation of the condition
+ "message": "A String", # Human-friendly representation of the condition
+ },
+ ],
+ "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "stages": [ # Substages of an operation or a stage.
+ # Object with schema name: OperationProgress
+ ],
+ "status": "A String", # Status of an operation stage.
+ # Unset for single-stage operations.
+ "metrics": [ # Progress metric bundle, for example:
+ # metrics: [{name: "nodes done", int_value: 15},
+ # {name: "nodes total", int_value: 32}]
+ # or
+ # metrics: [{name: "progress", double_value: 0.56},
+ # {name: "progress scale", double_value: 1.0}]
+ { # Progress metric is (string, int|float|string) pair.
+ "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
+ "doubleValue": 3.14, # For metrics with floating point value.
+ "intValue": "A String", # For metrics with integer value.
+ "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
+ },
+ ],
+ "name": "A String", # A non-parameterized string describing an operation stage.
+ # Unset for single-stage operations.
+ },
+ "zone": "A String", # The name of the Google Compute Engine
+ # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
+ # operation is taking place. This field is deprecated, use location instead.
+ "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
+ "selfLink": "A String", # Server-defined URL for the resource.
+ "targetLink": "A String", # Server-defined URL for the target of the operation.
+ "detail": "A String", # Detailed operation progress, if available.
+ "operationType": "A String", # The operation type.
+ "status": "A String", # The current status of the operation.
+ "name": "A String", # The server-assigned ID for the operation.
},
],
- "missingZones": [ # If any zones are listed here, the list of operations returned
+ "missingZones": [ # If any zones are listed here, the list of operations returned
# may be missing the operations from those zones.
- "A String",
+ "A String",
],
}</pre>
</div>