- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.1
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.4
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.2
- 2.10.8
- 2.9.0
- 2.8.1
- 2.7.1
- 2.6.1
- 2.5.0
- 2.4.1
- 2.3.1
- 2.2.0
- 2.1.0
- 2.0.1
- 1.0.3
- 0.5.0
- 0.4.0
- 0.3.0
ClusterManagerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-container/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Google Kubernetes Engine Cluster Manager v1beta1
Methods
ClusterManagerAsyncClient
ClusterManagerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-container/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiate the cluster manager client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
cancel_operation
cancel_operation(request: Optional[google.cloud.container_v1beta1.types.cluster_service.CancelOperationRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, operation_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Cancels the specified operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. CancelOperationRequest cancels a single operation. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
operation_id |
Required. Deprecated. The server-assigned |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
complete_ip_rotation
complete_ip_rotation(request: Optional[google.cloud.container_v1beta1.types.cluster_service.CompleteIPRotationRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Completes master IP rotation.
Parameters | |
---|---|
Name | Description |
request |
The request object. CompleteIPRotationRequest moves the cluster master back into single-IP mode. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
create_cluster
create_cluster(request: Optional[google.cloud.container_v1beta1.types.cluster_service.CreateClusterRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster: Optional[google.cloud.container_v1beta1.types.cluster_service.Cluster] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
By default, the cluster is created in the project's default
network <https://cloud.google.com/compute/docs/networks-and-firewalls#networks>
__.
One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster.
Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
Parameters | |
---|---|
Name | Description |
request |
The request object. CreateClusterRequest creates a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster |
Required. A |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
create_node_pool
create_node_pool(request: Optional[google.cloud.container_v1beta1.types.cluster_service.CreateNodePoolRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool: Optional[google.cloud.container_v1beta1.types.cluster_service.NodePool] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a node pool for a cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. CreateNodePoolRequest creates a node pool for a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. This corresponds to the |
node_pool |
Required. The node pool to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
delete_cluster
delete_cluster(request: Optional[google.cloud.container_v1beta1.types.cluster_service.DeleteClusterRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
Firewalls and routes that were configured during cluster creation are also deleted.
Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.
Parameters | |
---|---|
Name | Description |
request |
The request object. DeleteClusterRequest deletes a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
delete_node_pool
delete_node_pool(request: Optional[google.cloud.container_v1beta1.types.cluster_service.DeleteNodePoolRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a node pool from a cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. DeleteNodePoolRequest deletes a node pool for a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
node_pool_id |
Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
{@api.name} | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
{@api.name} | The constructed client. |
get_cluster
get_cluster(request: Optional[google.cloud.container_v1beta1.types.cluster_service.GetClusterRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the details for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. GetClusterRequest gets the settings of a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| A Google Kubernetes Engine cluster. |
get_node_pool
get_node_pool(request: Optional[google.cloud.container_v1beta1.types.cluster_service.GetNodePoolRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the requested node pool.
Parameters | |
---|---|
Name | Description |
request |
The request object. GetNodePoolRequest retrieves a node pool for a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
node_pool_id |
Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. |
get_operation
get_operation(request: Optional[google.cloud.container_v1beta1.types.cluster_service.GetOperationRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, operation_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the specified operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. GetOperationRequest gets a single operation. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
operation_id |
Required. Deprecated. The server-assigned |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
get_server_config
get_server_config(request: Optional[google.cloud.container_v1beta1.types.cluster_service.GetServerConfigRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns configuration info about the Google Kubernetes Engine service.
Parameters | |
---|---|
Name | Description |
request |
The request object. Gets the current Kubernetes Engine service configuration. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Kubernetes Engine service configuration. |
get_transport_class
get_transport_class()
Return an appropriate transport class.
list_clusters
list_clusters(request: Optional[google.cloud.container_v1beta1.types.cluster_service.ListClustersRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all clusters owned by a project in either the specified zone or all zones.
Parameters | |
---|---|
Name | Description |
request |
The request object. ListClustersRequest lists clusters. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| ListClustersResponse is the result of ListClustersRequest. |
list_locations
list_locations(request: Optional[google.cloud.container_v1beta1.types.cluster_service.ListLocationsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches locations that offer Google Kubernetes Engine.
Parameters | |
---|---|
Name | Description |
request |
The request object. ListLocationsRequest is used to request the locations that offer GKE. |
parent |
Required. Contains the name of the resource requested. Specified in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| ListLocationsResponse returns the list of all GKE locations and their recommendation state. |
list_node_pools
list_node_pools(request: Optional[google.cloud.container_v1beta1.types.cluster_service.ListNodePoolsRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists the node pools for a cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. ListNodePoolsRequest lists the node pool(s) for a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| ListNodePoolsResponse is the result of ListNodePoolsRequest. |
list_operations
list_operations(request: Optional[google.cloud.container_v1beta1.types.cluster_service.ListOperationsRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all operations in a project in the specified zone or all zones.
Parameters | |
---|---|
Name | Description |
request |
The request object. ListOperationsRequest lists operations. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| ListOperationsResponse is the result of ListOperationsRequest. |
list_usable_subnetworks
list_usable_subnetworks(request: Optional[google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists subnetworks that can be used for creating clusters in a project.
Parameters | |
---|---|
Name | Description |
request |
The request object. ListUsableSubnetworksRequest requests the list of usable subnetworks. available to a user for creating clusters. |
parent |
Required. The parent project where subnetworks are usable. Specified in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. Iterating over this object will yield results and resolve additional pages automatically. |
rollback_node_pool_upgrade
rollback_node_pool_upgrade(request: Optional[google.cloud.container_v1beta1.types.cluster_service.RollbackNodePoolUpgradeRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
Parameters | |
---|---|
Name | Description |
request |
The request object. RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. This corresponds to the |
node_pool_id |
Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_addons_config
set_addons_config(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetAddonsConfigRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, addons_config: Optional[google.cloud.container_v1beta1.types.cluster_service.AddonsConfig] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the addons for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetAddonsRequest sets the addons associated with the cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
addons_config |
Required. The desired configurations for the various addons available to run in the cluster. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_labels
set_labels(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetLabelsRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, resource_labels: Optional[Sequence[google.cloud.container_v1beta1.types.cluster_service.SetLabelsRequest.ResourceLabelsEntry]] = None, label_fingerprint: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets labels on a cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
resource_labels |
:class:
Required. The labels to set for that cluster. This corresponds to the |
label_fingerprint |
Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up- to-date fingerprint hash when updating or changing labels. Make a |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_legacy_abac
set_legacy_abac(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetLegacyAbacRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, enabled: Optional[bool] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Enables or disables the ABAC authorization mechanism on a cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. This corresponds to the |
enabled |
Required. Whether ABAC authorization will be enabled in the cluster. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_locations
set_locations(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetLocationsRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, locations: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the locations for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetLocationsRequest sets the locations of the cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
locations |
:class:
Required. The desired list of Google Compute Engine |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_logging_service
set_logging_service(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetLoggingServiceRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, logging_service: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the logging service for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetLoggingServiceRequest sets the logging service of a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
logging_service |
Required. The logging service the cluster should use to write metrics. Currently available options: - "logging.googleapis.com" - the Google Cloud Logging service - "none" - no metrics will be exported from the cluster This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_maintenance_policy
set_maintenance_policy(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetMaintenancePolicyRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, maintenance_policy: Optional[google.cloud.container_v1beta1.types.cluster_service.MaintenancePolicy] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the maintenance policy for a cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetMaintenancePolicyRequest sets the maintenance policy for a cluster. |
project_id |
Required. The Google Developers Console |
zone |
Required. The name of the Google Compute Engine |
cluster_id |
Required. The name of the cluster to update. This corresponds to the |
maintenance_policy |
Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_master_auth
set_master_auth(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetMasterAuthRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetMasterAuthRequest updates the admin password of a cluster. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_monitoring_service
set_monitoring_service(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetMonitoringServiceRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, monitoring_service: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the monitoring service for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetMonitoringServiceRequest sets the monitoring service of a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
monitoring_service |
Required. The monitoring service the cluster should use to write metrics. Currently available options: - "monitoring.googleapis.com" - the Google Cloud Monitoring service - "none" - no metrics will be exported from the cluster This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_network_policy
set_network_policy(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetNetworkPolicyRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, network_policy: Optional[google.cloud.container_v1beta1.types.cluster_service.NetworkPolicy] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Enables or disables Network Policy for a cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetNetworkPolicyRequest enables/disables network policy for a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
network_policy |
Required. Configuration options for the NetworkPolicy feature. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_node_pool_autoscaling
set_node_pool_autoscaling(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetNodePoolAutoscalingRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the autoscaling settings of a specific node pool.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_node_pool_management
set_node_pool_management(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetNodePoolManagementRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool_id: Optional[str] = None, management: Optional[google.cloud.container_v1beta1.types.cluster_service.NodeManagement] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the NodeManagement options for a node pool.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetNodePoolManagementRequest sets the node management properties of a node pool. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. This corresponds to the |
node_pool_id |
Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. This corresponds to the |
management |
Required. NodeManagement configuration for the node pool. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_node_pool_size
set_node_pool_size(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetNodePoolSizeRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the size for a specific node pool.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetNodePoolSizeRequest sets the size a node pool. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
start_ip_rotation
start_ip_rotation(request: Optional[google.cloud.container_v1beta1.types.cluster_service.StartIPRotationRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Starts master IP rotation.
Parameters | |
---|---|
Name | Description |
request |
The request object. StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
update_cluster
update_cluster(request: Optional[google.cloud.container_v1beta1.types.cluster_service.UpdateClusterRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, update: Optional[google.cloud.container_v1beta1.types.cluster_service.ClusterUpdate] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the settings for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. UpdateClusterRequest updates the settings of a cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
update |
Required. A description of the update. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
update_master
update_master(request: Optional[google.cloud.container_v1beta1.types.cluster_service.UpdateMasterRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, master_version: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the master for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. UpdateMasterRequest updates the master of the cluster. |
project_id |
Required. Deprecated. The Google Developers Console |
zone |
Required. Deprecated. The name of the Google Compute Engine |
cluster_id |
Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
master_version |
Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
update_node_pool
update_node_pool(request: Optional[google.cloud.container_v1beta1.types.cluster_service.UpdateNodePoolRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the version and/or image type of a specific node pool.
Parameters | |
---|---|
Name | Description |
request |
The request object. SetNodePoolVersionRequest updates the version of a node pool. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |