As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ClusterManager

class google.cloud.container_v1beta1.services.cluster_manager.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/.nox/docs/lib/python3.8/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>)[source]

Google Kubernetes Engine Cluster Manager v1beta1

Instantiates the cluster manager client.

Parameters
  • 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, ClusterManagerTransport]) – 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 transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Cancels the specified operation.

Parameters
  • request (google.cloud.container_v1beta1.types.CancelOperationRequest) – The request object. CancelOperationRequest cancels a single operation.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • operation_id (str) –

    Required. Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

    This corresponds to the operation_id field on the request instance; if request is provided, this should not be set.

  • 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.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Completes master IP rotation.

Parameters
  • request (google.cloud.container_v1beta1.types.CompleteIPRotationRequest) – The request object. CompleteIPRotationRequest moves the cluster master back into single-IP mode.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

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.

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
  • request (google.cloud.container_v1beta1.types.CreateClusterRequest) – The request object. CreateClusterRequest creates a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster (google.cloud.container_v1beta1.types.Cluster) –

    Required. A cluster resource

    This corresponds to the cluster field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Creates a node pool for a cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.CreateNodePoolRequest) – The request object. CreateNodePoolRequest creates a node pool for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool (google.cloud.container_v1beta1.types.NodePool) – Required. The node pool to create. This corresponds to the node_pool field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

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
  • request (google.cloud.container_v1beta1.types.DeleteClusterRequest) – The request object. DeleteClusterRequest deletes a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Deletes a node pool from a cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.DeleteNodePoolRequest) – The request object. DeleteNodePoolRequest deletes a node pool for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool_id (str) –

    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 node_pool_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ClusterManagerAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ClusterManagerAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ClusterManagerAsyncClient

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Cluster[source]

Gets the details for a specific cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.GetClusterRequest) – The request object. GetClusterRequest gets the settings of a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

A Google Kubernetes Engine cluster.

Return type

google.cloud.container_v1beta1.types.Cluster

async get_json_web_keys(request: Optional[google.cloud.container_v1beta1.types.cluster_service.GetJSONWebKeysRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.GetJSONWebKeysResponse[source]

Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.

Parameters
  • request (google.cloud.container_v1beta1.types.GetJSONWebKeysRequest) – The request object. GetJSONWebKeysRequest gets the public component of the keys used by the cluster to sign token requests. This will be the jwks_uri for the discover document returned by getOpenIDConfig. See the OpenID Connect Discovery 1.0 specification for details.

  • 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

GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

Return type

google.cloud.container_v1beta1.types.GetJSONWebKeysResponse

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.NodePool[source]

Retrieves the requested node pool.

Parameters
  • request (google.cloud.container_v1beta1.types.GetNodePoolRequest) – The request object. GetNodePoolRequest retrieves a node pool for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool_id (str) –

    Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.

    This corresponds to the node_pool_id field on the request instance; if request is provided, this should not be set.

  • 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

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. These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade.

maxUnavailable controls the number of nodes that can be simultaneously unavailable.

maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes.

(maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available.

Return type

google.cloud.container_v1beta1.types.NodePool

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Gets the specified operation.

Parameters
  • request (google.cloud.container_v1beta1.types.GetOperationRequest) – The request object. GetOperationRequest gets a single operation.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • operation_id (str) –

    Required. Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

    This corresponds to the operation_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ServerConfig[source]

Returns configuration info about the Google Kubernetes Engine service.

Parameters
  • request (google.cloud.container_v1beta1.types.GetServerConfigRequest) – The request object. Gets the current Kubernetes Engine service configuration.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone to return operations for. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • 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

Kubernetes Engine service configuration.

Return type

google.cloud.container_v1beta1.types.ServerConfig

get_transport_class()Type[google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ListClustersResponse[source]

Lists all clusters owned by a project in either the specified zone or all zones.

Parameters
  • request (google.cloud.container_v1beta1.types.ListClustersRequest) – The request object. ListClustersRequest lists clusters.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides, or “-” for all zones. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • 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

ListClustersResponse is the result of ListClustersRequest.

Return type

google.cloud.container_v1beta1.types.ListClustersResponse

async list_locations(request: Optional[google.cloud.container_v1beta1.types.cluster_service.ListLocationsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ListLocationsResponse[source]

Fetches locations that offer Google Kubernetes Engine.

Parameters
  • request (google.cloud.container_v1beta1.types.ListLocationsRequest) – The request object. ListLocationsRequest is used to request the locations that offer GKE.

  • parent (str) –

    Required. Contains the name of the resource requested. Specified in the format projects/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

ListLocationsResponse returns the list of all GKE locations and their recommendation state.

Return type

google.cloud.container_v1beta1.types.ListLocationsResponse

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ListNodePoolsResponse[source]

Lists the node pools for a cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.ListNodePoolsRequest) – The request object. ListNodePoolsRequest lists the node pool(s) for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

ListNodePoolsResponse is the result of ListNodePoolsRequest.

Return type

google.cloud.container_v1beta1.types.ListNodePoolsResponse

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ListOperationsResponse[source]

Lists all operations in a project in the specified zone or all zones.

Parameters
  • request (google.cloud.container_v1beta1.types.ListOperationsRequest) – The request object. ListOperationsRequest lists operations.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone to return operations for, or - for all zones. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • 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

ListOperationsResponse is the result of ListOperationsRequest.

Return type

google.cloud.container_v1beta1.types.ListOperationsResponse

async list_usable_subnetworks(request: Optional[google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.services.cluster_manager.pagers.ListUsableSubnetworksAsyncPager[source]

Lists subnetworks that can be used for creating clusters in a project.

Parameters
  • request (google.cloud.container_v1beta1.types.ListUsableSubnetworksRequest) – The request object. ListUsableSubnetworksRequest requests the list of usable subnetworks. available to a user for creating clusters.

  • parent (str) –

    Required. The parent project where subnetworks are usable. Specified in the format projects/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.container_v1beta1.services.cluster_manager.pagers.ListUsableSubnetworksAsyncPager

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_topic_path(path: str)Dict[str, str]

Parses a topic path into its component segments.

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Parameters
  • request (google.cloud.container_v1beta1.types.RollbackNodePoolUpgradeRequest) – 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 (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool_id (str) –

    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 node_pool_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the addons for a specific cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.SetAddonsConfigRequest) – The request object. SetAddonsRequest sets the addons associated with the cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • addons_config (google.cloud.container_v1beta1.types.AddonsConfig) –

    Required. The desired configurations for the various addons available to run in the cluster.

    This corresponds to the addons_config field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets labels on a cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.SetLabelsRequest) – 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 (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • resource_labels (Sequence[google.cloud.container_v1beta1.types.SetLabelsRequest.ResourceLabelsEntry]) –

    Required. The labels to set for that cluster.

    This corresponds to the resource_labels field on the request instance; if request is provided, this should not be set.

  • label_fingerprint (str) –

    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 get() request to the resource to get the latest fingerprint.

    This corresponds to the label_fingerprint field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.SetLegacyAbacRequest) – The request object. SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • enabled (bool) –

    Required. Whether ABAC authorization will be enabled in the cluster.

    This corresponds to the enabled field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.

Parameters
  • request (google.cloud.container_v1beta1.types.SetLocationsRequest) – The request object. SetLocationsRequest sets the locations of the cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • locations (Sequence[str]) –

    Required. The desired list of Google Compute Engine zones in which the cluster’s nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.

    This list must always include the cluster’s primary zone.

    This corresponds to the locations field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the logging service for a specific cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.SetLoggingServiceRequest) – The request object. SetLoggingServiceRequest sets the logging service of a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • logging_service (str) –

    Required. The logging service the cluster should use to write logs. Currently available options:

    • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model

    • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).

    • none - no logs will be exported from the cluster.

    If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

    This corresponds to the logging_service field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the maintenance policy for a cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.SetMaintenancePolicyRequest) – The request object. SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

  • project_id (str) –

    Required. The Google Developers Console project ID or project number.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. The name of the Google Compute Engine zone in which the cluster resides.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. The name of the cluster to update.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • maintenance_policy (google.cloud.container_v1beta1.types.MaintenancePolicy) –

    Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.

    This corresponds to the maintenance_policy field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async set_master_auth(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetMasterAuthRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Parameters
Returns

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the monitoring service for a specific cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.SetMonitoringServiceRequest) – The request object. SetMonitoringServiceRequest sets the monitoring service of a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • monitoring_service (str) –

    Required. The monitoring service the cluster should use to write metrics. Currently available options:

    • ”monitoring.googleapis.com/kubernetes” - The Cloud Monitoring service with a Kubernetes-native resource model

    • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).

    • none - No metrics will be exported from the cluster.

    If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

    This corresponds to the monitoring_service field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Enables or disables Network Policy for a cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.SetNetworkPolicyRequest) – The request object. SetNetworkPolicyRequest enables/disables network policy for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • network_policy (google.cloud.container_v1beta1.types.NetworkPolicy) –

    Required. Configuration options for the NetworkPolicy feature.

    This corresponds to the network_policy field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async set_node_pool_autoscaling(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetNodePoolAutoscalingRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the autoscaling settings of a specific node pool.

Parameters
Returns

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the NodeManagement options for a node pool.

Parameters
  • request (google.cloud.container_v1beta1.types.SetNodePoolManagementRequest) – The request object. SetNodePoolManagementRequest sets the node management properties of a node pool.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool_id (str) –

    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 node_pool_id field on the request instance; if request is provided, this should not be set.

  • management (google.cloud.container_v1beta1.types.NodeManagement) –

    Required. NodeManagement configuration for the node pool.

    This corresponds to the management field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async set_node_pool_size(request: Optional[google.cloud.container_v1beta1.types.cluster_service.SetNodePoolSizeRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying [NodePool.locations][google.container.v1beta1.NodePool.locations].

Parameters
Returns

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Starts master IP rotation.

Parameters
  • request (google.cloud.container_v1beta1.types.StartIPRotationRequest) – 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 (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

static topic_path(project: str, topic: str)str

Returns a fully-qualified topic string.

property transport: google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

ClusterManagerTransport

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Updates the settings for a specific cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.UpdateClusterRequest) – The request object. UpdateClusterRequest updates the settings of a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • update (google.cloud.container_v1beta1.types.ClusterUpdate) –

    Required. A description of the update.

    This corresponds to the update field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Updates the master for a specific cluster.

Parameters
  • request (google.cloud.container_v1beta1.types.UpdateMasterRequest) – The request object. UpdateMasterRequest updates the master of the cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • master_version (str) –

    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 master_version field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

async update_node_pool(request: Optional[google.cloud.container_v1beta1.types.cluster_service.UpdateNodePoolRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Updates the version and/or image type of a specific node pool.

Parameters
Returns

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

class google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Google Kubernetes Engine Cluster Manager v1beta1

Instantiates the cluster manager client.

Parameters
  • 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, ClusterManagerTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

cancel_operation(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.CancelOperationRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, operation_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Cancels the specified operation.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.CancelOperationRequest, dict]) – The request object. CancelOperationRequest cancels a single operation.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • operation_id (str) –

    Required. Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

    This corresponds to the operation_id field on the request instance; if request is provided, this should not be set.

  • 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.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

complete_ip_rotation(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.CompleteIPRotationRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Completes master IP rotation.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.CompleteIPRotationRequest, dict]) – The request object. CompleteIPRotationRequest moves the cluster master back into single-IP mode.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

create_cluster(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.CreateClusterRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

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.

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
  • request (Union[google.cloud.container_v1beta1.types.CreateClusterRequest, dict]) – The request object. CreateClusterRequest creates a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster (google.cloud.container_v1beta1.types.Cluster) –

    Required. A cluster resource

    This corresponds to the cluster field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

create_node_pool(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.CreateNodePoolRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Creates a node pool for a cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.CreateNodePoolRequest, dict]) – The request object. CreateNodePoolRequest creates a node pool for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool (google.cloud.container_v1beta1.types.NodePool) – Required. The node pool to create. This corresponds to the node_pool field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

delete_cluster(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.DeleteClusterRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

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
  • request (Union[google.cloud.container_v1beta1.types.DeleteClusterRequest, dict]) – The request object. DeleteClusterRequest deletes a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

delete_node_pool(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.DeleteNodePoolRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Deletes a node pool from a cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.DeleteNodePoolRequest, dict]) – The request object. DeleteNodePoolRequest deletes a node pool for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool_id (str) –

    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 node_pool_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ClusterManagerClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ClusterManagerClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ClusterManagerClient

get_cluster(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.GetClusterRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Cluster[source]

Gets the details for a specific cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.GetClusterRequest, dict]) – The request object. GetClusterRequest gets the settings of a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

A Google Kubernetes Engine cluster.

Return type

google.cloud.container_v1beta1.types.Cluster

get_json_web_keys(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.GetJSONWebKeysRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.GetJSONWebKeysResponse[source]

Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.GetJSONWebKeysRequest, dict]) – The request object. GetJSONWebKeysRequest gets the public component of the keys used by the cluster to sign token requests. This will be the jwks_uri for the discover document returned by getOpenIDConfig. See the OpenID Connect Discovery 1.0 specification for details.

  • 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

GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

Return type

google.cloud.container_v1beta1.types.GetJSONWebKeysResponse

get_node_pool(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.GetNodePoolRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.NodePool[source]

Retrieves the requested node pool.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.GetNodePoolRequest, dict]) – The request object. GetNodePoolRequest retrieves a node pool for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool_id (str) –

    Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.

    This corresponds to the node_pool_id field on the request instance; if request is provided, this should not be set.

  • 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

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. These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade.

maxUnavailable controls the number of nodes that can be simultaneously unavailable.

maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes.

(maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available.

Return type

google.cloud.container_v1beta1.types.NodePool

get_operation(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.GetOperationRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, operation_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Gets the specified operation.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.GetOperationRequest, dict]) – The request object. GetOperationRequest gets a single operation.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • operation_id (str) –

    Required. Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

    This corresponds to the operation_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

get_server_config(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.GetServerConfigRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ServerConfig[source]

Returns configuration info about the Google Kubernetes Engine service.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.GetServerConfigRequest, dict]) – The request object. Gets the current Kubernetes Engine service configuration.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone to return operations for. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • 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

Kubernetes Engine service configuration.

Return type

google.cloud.container_v1beta1.types.ServerConfig

list_clusters(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.ListClustersRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ListClustersResponse[source]

Lists all clusters owned by a project in either the specified zone or all zones.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.ListClustersRequest, dict]) – The request object. ListClustersRequest lists clusters.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides, or “-” for all zones. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • 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

ListClustersResponse is the result of ListClustersRequest.

Return type

google.cloud.container_v1beta1.types.ListClustersResponse

list_locations(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.ListLocationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ListLocationsResponse[source]

Fetches locations that offer Google Kubernetes Engine.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.ListLocationsRequest, dict]) – The request object. ListLocationsRequest is used to request the locations that offer GKE.

  • parent (str) –

    Required. Contains the name of the resource requested. Specified in the format projects/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

ListLocationsResponse returns the list of all GKE locations and their recommendation state.

Return type

google.cloud.container_v1beta1.types.ListLocationsResponse

list_node_pools(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.ListNodePoolsRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ListNodePoolsResponse[source]

Lists the node pools for a cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.ListNodePoolsRequest, dict]) – The request object. ListNodePoolsRequest lists the node pool(s) for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

ListNodePoolsResponse is the result of ListNodePoolsRequest.

Return type

google.cloud.container_v1beta1.types.ListNodePoolsResponse

list_operations(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.ListOperationsRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.ListOperationsResponse[source]

Lists all operations in a project in the specified zone or all zones.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.ListOperationsRequest, dict]) – The request object. ListOperationsRequest lists operations.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone to return operations for, or - for all zones. This field has been deprecated and replaced by the parent field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • 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

ListOperationsResponse is the result of ListOperationsRequest.

Return type

google.cloud.container_v1beta1.types.ListOperationsResponse

list_usable_subnetworks(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.services.cluster_manager.pagers.ListUsableSubnetworksPager[source]

Lists subnetworks that can be used for creating clusters in a project.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.ListUsableSubnetworksRequest, dict]) – The request object. ListUsableSubnetworksRequest requests the list of usable subnetworks. available to a user for creating clusters.

  • parent (str) –

    Required. The parent project where subnetworks are usable. Specified in the format projects/*.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.container_v1beta1.services.cluster_manager.pagers.ListUsableSubnetworksPager

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_topic_path(path: str)Dict[str, str][source]

Parses a topic path into its component segments.

rollback_node_pool_upgrade(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.RollbackNodePoolUpgradeRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.RollbackNodePoolUpgradeRequest, dict]) – 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 (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool_id (str) –

    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 node_pool_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_addons_config(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetAddonsConfigRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the addons for a specific cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetAddonsConfigRequest, dict]) – The request object. SetAddonsRequest sets the addons associated with the cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • addons_config (google.cloud.container_v1beta1.types.AddonsConfig) –

    Required. The desired configurations for the various addons available to run in the cluster.

    This corresponds to the addons_config field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_labels(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetLabelsRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets labels on a cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetLabelsRequest, dict]) – 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 (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • resource_labels (Sequence[google.cloud.container_v1beta1.types.SetLabelsRequest.ResourceLabelsEntry]) –

    Required. The labels to set for that cluster.

    This corresponds to the resource_labels field on the request instance; if request is provided, this should not be set.

  • label_fingerprint (str) –

    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 get() request to the resource to get the latest fingerprint.

    This corresponds to the label_fingerprint field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_legacy_abac(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetLegacyAbacRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetLegacyAbacRequest, dict]) – The request object. SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • enabled (bool) –

    Required. Whether ABAC authorization will be enabled in the cluster.

    This corresponds to the enabled field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_locations(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetLocationsRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetLocationsRequest, dict]) – The request object. SetLocationsRequest sets the locations of the cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • locations (Sequence[str]) –

    Required. The desired list of Google Compute Engine zones in which the cluster’s nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.

    This list must always include the cluster’s primary zone.

    This corresponds to the locations field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_logging_service(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetLoggingServiceRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the logging service for a specific cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetLoggingServiceRequest, dict]) – The request object. SetLoggingServiceRequest sets the logging service of a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • logging_service (str) –

    Required. The logging service the cluster should use to write logs. Currently available options:

    • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model

    • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).

    • none - no logs will be exported from the cluster.

    If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

    This corresponds to the logging_service field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_maintenance_policy(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetMaintenancePolicyRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the maintenance policy for a cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetMaintenancePolicyRequest, dict]) – The request object. SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

  • project_id (str) –

    Required. The Google Developers Console project ID or project number.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. The name of the Google Compute Engine zone in which the cluster resides.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. The name of the cluster to update.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • maintenance_policy (google.cloud.container_v1beta1.types.MaintenancePolicy) –

    Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.

    This corresponds to the maintenance_policy field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_master_auth(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetMasterAuthRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Parameters
Returns

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_monitoring_service(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetMonitoringServiceRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the monitoring service for a specific cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetMonitoringServiceRequest, dict]) – The request object. SetMonitoringServiceRequest sets the monitoring service of a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • monitoring_service (str) –

    Required. The monitoring service the cluster should use to write metrics. Currently available options:

    • ”monitoring.googleapis.com/kubernetes” - The Cloud Monitoring service with a Kubernetes-native resource model

    • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).

    • none - No metrics will be exported from the cluster.

    If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

    This corresponds to the monitoring_service field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_network_policy(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetNetworkPolicyRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Enables or disables Network Policy for a cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetNetworkPolicyRequest, dict]) – The request object. SetNetworkPolicyRequest enables/disables network policy for a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • network_policy (google.cloud.container_v1beta1.types.NetworkPolicy) –

    Required. Configuration options for the NetworkPolicy feature.

    This corresponds to the network_policy field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_node_pool_autoscaling(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetNodePoolAutoscalingRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the autoscaling settings of a specific node pool.

Parameters
Returns

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_node_pool_management(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetNodePoolManagementRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Sets the NodeManagement options for a node pool.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.SetNodePoolManagementRequest, dict]) – The request object. SetNodePoolManagementRequest sets the node management properties of a node pool.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • node_pool_id (str) –

    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 node_pool_id field on the request instance; if request is provided, this should not be set.

  • management (google.cloud.container_v1beta1.types.NodeManagement) –

    Required. NodeManagement configuration for the node pool.

    This corresponds to the management field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

set_node_pool_size(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.SetNodePoolSizeRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying [NodePool.locations][google.container.v1beta1.NodePool.locations].

Parameters
Returns

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

start_ip_rotation(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.StartIPRotationRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Starts master IP rotation.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.StartIPRotationRequest, dict]) – 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 (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

static topic_path(project: str, topic: str)str[source]

Returns a fully-qualified topic string.

property transport: google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

ClusterManagerTransport

update_cluster(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.UpdateClusterRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Updates the settings for a specific cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.UpdateClusterRequest, dict]) – The request object. UpdateClusterRequest updates the settings of a cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • update (google.cloud.container_v1beta1.types.ClusterUpdate) –

    Required. A description of the update.

    This corresponds to the update field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

update_master(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.UpdateMasterRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Updates the master for a specific cluster.

Parameters
  • request (Union[google.cloud.container_v1beta1.types.UpdateMasterRequest, dict]) – The request object. UpdateMasterRequest updates the master of the cluster.

  • project_id (str) –

    Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

    This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

  • zone (str) –

    Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

    This corresponds to the zone field on the request instance; if request is provided, this should not be set.

  • cluster_id (str) –

    Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

    This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

  • master_version (str) –

    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 master_version field on the request instance; if request is provided, this should not be set.

  • 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

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

update_node_pool(request: Optional[Union[google.cloud.container_v1beta1.types.cluster_service.UpdateNodePoolRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.container_v1beta1.types.cluster_service.Operation[source]

Updates the version and/or image type of a specific node pool.

Parameters
Returns

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Return type

google.cloud.container_v1beta1.types.Operation

class google.cloud.container_v1beta1.services.cluster_manager.pagers.ListUsableSubnetworksAsyncPager(method: Callable[[...], Awaitable[google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksResponse]], request: google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksRequest, response: google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_usable_subnetworks requests.

This class thinly wraps an initial google.cloud.container_v1beta1.types.ListUsableSubnetworksResponse object, and provides an __aiter__ method to iterate through its subnetworks field.

If there are more pages, the __aiter__ method will make additional ListUsableSubnetworks requests and continue to iterate through the subnetworks field on the corresponding responses.

All the usual google.cloud.container_v1beta1.types.ListUsableSubnetworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.container_v1beta1.services.cluster_manager.pagers.ListUsableSubnetworksPager(method: Callable[[...], google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksResponse], request: google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksRequest, response: google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_usable_subnetworks requests.

This class thinly wraps an initial google.cloud.container_v1beta1.types.ListUsableSubnetworksResponse object, and provides an __iter__ method to iterate through its subnetworks field.

If there are more pages, the __iter__ method will make additional ListUsableSubnetworks requests and continue to iterate through the subnetworks field on the corresponding responses.

All the usual google.cloud.container_v1beta1.types.ListUsableSubnetworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters