- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.1
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.4
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.2
- 2.10.8
- 2.9.0
- 2.8.1
- 2.7.1
- 2.6.1
- 2.5.0
- 2.4.1
- 2.3.1
- 2.2.0
- 2.1.0
- 2.0.1
- 1.0.3
- 0.5.0
- 0.4.0
- 0.3.0
ClusterManagerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.container_v1.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>)Google Kubernetes Engine Cluster Manager v1
Inheritance
builtins.object > ClusterManagerClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| ClusterManagerTransport | The transport used by the client instance. |
Methods
ClusterManagerClient
ClusterManagerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.container_v1.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>)Instantiates the cluster manager client.
| Name | Description |
| credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
| transport |
Union[str, 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 |
| 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 |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)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
cancel_operation(request: Optional[Union[google.cloud.container_v1.types.cluster_service.CancelOperationRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, operation_id: Optional[str] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Cancels the specified operation.
from google.cloud import container_v1
def sample_cancel_operation():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.CancelOperationRequest(
)
# Make the request
client.cancel_operation(request=request)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.CancelOperationRequest, dict]
The request object. CancelOperationRequest cancels a single operation. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| operation_id |
str
Deprecated. The server-assigned |
| name |
str
The name (project, location, operation id) of the operation to cancel. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
complete_ip_rotation
complete_ip_rotation(request: Optional[Union[google.cloud.container_v1.types.cluster_service.CompleteIPRotationRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Completes master IP rotation.
from google.cloud import container_v1
def sample_complete_ip_rotation():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.CompleteIPRotationRequest(
)
# Make the request
response = client.complete_ip_rotation(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.CompleteIPRotationRequest, dict]
The request object. CompleteIPRotationRequest moves the cluster master back into single-IP mode. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
| name |
str
The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
create_cluster
create_cluster(request: Optional[Union[google.cloud.container_v1.types.cluster_service.CreateClusterRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster: Optional[google.cloud.container_v1.types.cluster_service.Cluster] = None, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
By default, the cluster is created in the project's default
network <https://cloud.google.com/compute/docs/networks-and-firewalls#networks>__.
One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster.
Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
.. code-block:: python
from google.cloud import container_v1
def sample_create_cluster():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.CreateClusterRequest(
)
# Make the request
response = client.create_cluster(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.CreateClusterRequest, dict]
The request object. CreateClusterRequest creates a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster |
google.cloud.container_v1.types.Cluster
Required. A |
| parent |
str
The parent (project and location) where the cluster will be created. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
create_node_pool
create_node_pool(request: Optional[Union[google.cloud.container_v1.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_v1.types.cluster_service.NodePool] = None, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a node pool for a cluster.
from google.cloud import container_v1
def sample_create_node_pool():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.CreateNodePoolRequest(
)
# Make the request
response = client.create_node_pool(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.CreateNodePoolRequest, dict]
The request object. CreateNodePoolRequest creates a node pool for a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. This corresponds to the |
| node_pool |
google.cloud.container_v1.types.NodePool
Required. The node pool to create. This corresponds to the |
| parent |
str
The parent (project, location, cluster id) where the node pool will be created. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
delete_cluster
delete_cluster(request: Optional[Union[google.cloud.container_v1.types.cluster_service.DeleteClusterRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
Firewalls and routes that were configured during cluster creation are also deleted.
Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.
.. code-block:: python
from google.cloud import container_v1
def sample_delete_cluster():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.DeleteClusterRequest(
)
# Make the request
response = client.delete_cluster(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.DeleteClusterRequest, dict]
The request object. DeleteClusterRequest deletes a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. This corresponds to the |
| name |
str
The name (project, location, cluster) of the cluster to delete. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
delete_node_pool
delete_node_pool(request: Optional[Union[google.cloud.container_v1.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, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a node pool from a cluster.
from google.cloud import container_v1
def sample_delete_node_pool():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.DeleteNodePoolRequest(
)
# Make the request
response = client.delete_node_pool(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.DeleteNodePoolRequest, dict]
The request object. DeleteNodePoolRequest deletes a node pool for a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
| node_pool_id |
str
Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. This corresponds to the |
| name |
str
The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| ClusterManagerClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| ClusterManagerClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| ClusterManagerClient | The constructed client. |
get_cluster
get_cluster(request: Optional[Union[google.cloud.container_v1.types.cluster_service.GetClusterRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the details of a specific cluster.
from google.cloud import container_v1
def sample_get_cluster():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.GetClusterRequest(
)
# Make the request
response = client.get_cluster(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.GetClusterRequest, dict]
The request object. GetClusterRequest gets the settings of a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. This corresponds to the |
| name |
str
The name (project, location, cluster) of the cluster to retrieve. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Cluster | A Google Kubernetes Engine cluster. |
get_json_web_keys
get_json_web_keys(request: Optional[Union[google.cloud.container_v1.types.cluster_service.GetJSONWebKeysRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
.. code-block:: python
from google.cloud import container_v1
def sample_get_json_web_keys():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.GetJSONWebKeysRequest(
)
# Make the request
response = client.get_json_web_keys(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.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. |
| Type | Description |
| google.cloud.container_v1.types.GetJSONWebKeysResponse | GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Name | Description |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_node_pool
get_node_pool(request: Optional[Union[google.cloud.container_v1.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, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Retrieves the requested node pool.
from google.cloud import container_v1
def sample_get_node_pool():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.GetNodePoolRequest(
)
# Make the request
response = client.get_node_pool(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.GetNodePoolRequest, dict]
The request object. GetNodePoolRequest retrieves a node pool for a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
| node_pool_id |
str
Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. This corresponds to the |
| name |
str
The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.NodePool | NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. |
get_operation
get_operation(request: Optional[Union[google.cloud.container_v1.types.cluster_service.GetOperationRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, operation_id: Optional[str] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the specified operation.
from google.cloud import container_v1
def sample_get_operation():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.GetOperationRequest(
)
# Make the request
response = client.get_operation(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.GetOperationRequest, dict]
The request object. GetOperationRequest gets a single operation. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| operation_id |
str
Deprecated. The server-assigned |
| name |
str
The name (project, location, operation id) of the operation to get. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
get_server_config
get_server_config(request: Optional[Union[google.cloud.container_v1.types.cluster_service.GetServerConfigRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns configuration info about the Google Kubernetes Engine service.
.. code-block:: python
from google.cloud import container_v1
def sample_get_server_config():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.GetServerConfigRequest(
)
# Make the request
response = client.get_server_config(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.GetServerConfigRequest, dict]
The request object. Gets the current Kubernetes Engine service configuration. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| name |
str
The name (project and location) of the server config to get, specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.ServerConfig | Kubernetes Engine service configuration. |
list_clusters
list_clusters(request: Optional[Union[google.cloud.container_v1.types.cluster_service.ListClustersRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists all clusters owned by a project in either the specified zone or all zones.
.. code-block:: python
from google.cloud import container_v1
def sample_list_clusters():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.ListClustersRequest(
)
# Make the request
response = client.list_clusters(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.ListClustersRequest, dict]
The request object. ListClustersRequest lists clusters. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| parent |
str
The parent (project and location) where the clusters will be listed. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.ListClustersResponse | ListClustersResponse is the result of ListClustersRequest. |
list_node_pools
list_node_pools(request: Optional[Union[google.cloud.container_v1.types.cluster_service.ListNodePoolsRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the node pools for a cluster.
from google.cloud import container_v1
def sample_list_node_pools():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.ListNodePoolsRequest(
)
# Make the request
response = client.list_node_pools(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.ListNodePoolsRequest, dict]
The request object. ListNodePoolsRequest lists the node pool(s) for a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. This corresponds to the |
| parent |
str
The parent (project, location, cluster id) where the node pools will be listed. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.ListNodePoolsResponse | ListNodePoolsResponse is the result of ListNodePoolsRequest. |
list_operations
list_operations(request: Optional[Union[google.cloud.container_v1.types.cluster_service.ListOperationsRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists all operations in a project in a specific zone or all zones.
.. code-block:: python
from google.cloud import container_v1
def sample_list_operations():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.ListOperationsRequest(
)
# Make the request
response = client.list_operations(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.ListOperationsRequest, dict]
The request object. ListOperationsRequest lists operations. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.ListOperationsResponse | ListOperationsResponse is the result of ListOperationsRequest. |
list_usable_subnetworks
list_usable_subnetworks(request: Optional[Union[google.cloud.container_v1.types.cluster_service.ListUsableSubnetworksRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists subnetworks that are usable for creating clusters in a project.
.. code-block:: python
from google.cloud import container_v1
def sample_list_usable_subnetworks():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.ListUsableSubnetworksRequest(
)
# Make the request
page_result = client.list_usable_subnetworks(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.ListUsableSubnetworksRequest, dict]
The request object. ListUsableSubnetworksRequest requests the list of usable subnetworks available to a user for creating clusters. |
| 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. |
| Type | Description |
| google.cloud.container_v1.services.cluster_manager.pagers.ListUsableSubnetworksPager | ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_topic_path
parse_topic_path(path: str)Parses a topic path into its component segments.
rollback_node_pool_upgrade
rollback_node_pool_upgrade(request: Optional[Union[google.cloud.container_v1.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, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
.. code-block:: python
from google.cloud import container_v1
def sample_rollback_node_pool_upgrade():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.RollbackNodePoolUpgradeRequest(
)
# Make the request
response = client.rollback_node_pool_upgrade(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.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
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. This corresponds to the |
| node_pool_id |
str
Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. This corresponds to the |
| name |
str
The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_addons_config
set_addons_config(request: Optional[Union[google.cloud.container_v1.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_v1.types.cluster_service.AddonsConfig] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the addons for a specific cluster.
from google.cloud import container_v1
def sample_set_addons_config():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetAddonsConfigRequest(
)
# Make the request
response = client.set_addons_config(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetAddonsConfigRequest, dict]
The request object. SetAddonsConfigRequest sets the addons associated with the cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
| addons_config |
google.cloud.container_v1.types.AddonsConfig
Required. The desired configurations for the various addons available to run in the cluster. This corresponds to the |
| name |
str
The name (project, location, cluster) of the cluster to set addons. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_labels
set_labels(request: Optional[Union[google.cloud.container_v1.types.cluster_service.SetLabelsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets labels on a cluster.
from google.cloud import container_v1
def sample_set_labels():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetLabelsRequest(
label_fingerprint="label_fingerprint_value",
)
# Make the request
response = client.set_labels(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.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 |
| 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. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_legacy_abac
set_legacy_abac(request: Optional[Union[google.cloud.container_v1.types.cluster_service.SetLegacyAbacRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, enabled: Optional[bool] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Enables or disables the ABAC authorization mechanism on a cluster.
.. code-block:: python
from google.cloud import container_v1
def sample_set_legacy_abac():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetLegacyAbacRequest(
enabled=True,
)
# Make the request
response = client.set_legacy_abac(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetLegacyAbacRequest, dict]
The request object. SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. This corresponds to the |
| enabled |
bool
Required. Whether ABAC authorization will be enabled in the cluster. This corresponds to the |
| name |
str
The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_locations
set_locations(request: Optional[Union[google.cloud.container_v1.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, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the locations for a specific cluster. Deprecated. Use
projects.locations.clusters.update <https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update>__
instead.
.. code-block:: python
from google.cloud import container_v1
def sample_set_locations():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetLocationsRequest(
locations=['locations_value_1', 'locations_value_2'],
)
# Make the request
response = client.set_locations(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetLocationsRequest, dict]
The request object. SetLocationsRequest sets the locations of the cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
| locations |
Sequence[str]
Required. The desired list of Google Compute Engine |
| name |
str
The name (project, location, cluster) of the cluster to set locations. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_logging_service
set_logging_service(request: Optional[Union[google.cloud.container_v1.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, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the logging service for a specific cluster.
from google.cloud import container_v1
def sample_set_logging_service():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetLoggingServiceRequest(
logging_service="logging_service_value",
)
# Make the request
response = client.set_logging_service(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetLoggingServiceRequest, dict]
The request object. SetLoggingServiceRequest sets the logging service of a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
| logging_service |
str
Required. The logging service the cluster should use to write logs. Currently available options: - |
| name |
str
The name (project, location, cluster) of the cluster to set logging. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_maintenance_policy
set_maintenance_policy(request: Optional[Union[google.cloud.container_v1.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_v1.types.cluster_service.MaintenancePolicy] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the maintenance policy for a cluster.
from google.cloud import container_v1
def sample_set_maintenance_policy():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetMaintenancePolicyRequest(
project_id="project_id_value",
zone="zone_value",
cluster_id="cluster_id_value",
)
# Make the request
response = client.set_maintenance_policy(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetMaintenancePolicyRequest, dict]
The request object. SetMaintenancePolicyRequest sets the maintenance policy for a cluster. |
| project_id |
str
Required. The Google Developers Console |
| zone |
str
Required. The name of the Google Compute Engine |
| cluster_id |
str
Required. The name of the cluster to update. This corresponds to the |
| maintenance_policy |
google.cloud.container_v1.types.MaintenancePolicy
Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. This corresponds to the |
| name |
str
The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_master_auth
set_master_auth(request: Optional[Union[google.cloud.container_v1.types.cluster_service.SetMasterAuthRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
.. code-block:: python
from google.cloud import container_v1
def sample_set_master_auth():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetMasterAuthRequest(
action="SET_USERNAME",
)
# Make the request
response = client.set_master_auth(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetMasterAuthRequest, dict]
The request object. SetMasterAuthRequest updates the admin password of a cluster. |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_monitoring_service
set_monitoring_service(request: Optional[Union[google.cloud.container_v1.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, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the monitoring service for a specific cluster.
from google.cloud import container_v1
def sample_set_monitoring_service():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetMonitoringServiceRequest(
monitoring_service="monitoring_service_value",
)
# Make the request
response = client.set_monitoring_service(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetMonitoringServiceRequest, dict]
The request object. SetMonitoringServiceRequest sets the monitoring service of a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
| monitoring_service |
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 - |
| name |
str
The name (project, location, cluster) of the cluster to set monitoring. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_network_policy
set_network_policy(request: Optional[Union[google.cloud.container_v1.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_v1.types.cluster_service.NetworkPolicy] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Enables or disables Network Policy for a cluster.
from google.cloud import container_v1
def sample_set_network_policy():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetNetworkPolicyRequest(
)
# Make the request
response = client.set_network_policy(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetNetworkPolicyRequest, dict]
The request object. SetNetworkPolicyRequest enables/disables network policy for a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
| network_policy |
google.cloud.container_v1.types.NetworkPolicy
Required. Configuration options for the NetworkPolicy feature. This corresponds to the |
| name |
str
The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_node_pool_autoscaling
set_node_pool_autoscaling(request: Optional[Union[google.cloud.container_v1.types.cluster_service.SetNodePoolAutoscalingRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the autoscaling settings for the specified node pool.
.. code-block:: python
from google.cloud import container_v1
def sample_set_node_pool_autoscaling():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetNodePoolAutoscalingRequest(
)
# Make the request
response = client.set_node_pool_autoscaling(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetNodePoolAutoscalingRequest, dict]
The request object. SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_node_pool_management
set_node_pool_management(request: Optional[Union[google.cloud.container_v1.types.cluster_service.SetNodePoolManagementRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the NodeManagement options for a node pool.
from google.cloud import container_v1
def sample_set_node_pool_management():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetNodePoolManagementRequest(
)
# Make the request
response = client.set_node_pool_management(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetNodePoolManagementRequest, dict]
The request object. SetNodePoolManagementRequest sets the node management properties of a node pool. |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
set_node_pool_size
set_node_pool_size(request: Optional[Union[google.cloud.container_v1.types.cluster_service.SetNodePoolSizeRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the size for a specific node pool. The new size will be
used for all replicas, including future replicas created by
modifying
NodePool.locations][google.container.v1.NodePool.locations].
.. code-block:: python
from google.cloud import container_v1
def sample_set_node_pool_size():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.SetNodePoolSizeRequest(
node_count=1070,
)
# Make the request
response = client.set_node_pool_size(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.SetNodePoolSizeRequest, dict]
The request object. SetNodePoolSizeRequest sets the size of a node pool. |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
start_ip_rotation
start_ip_rotation(request: Optional[Union[google.cloud.container_v1.types.cluster_service.StartIPRotationRequest, dict]] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Starts master IP rotation.
from google.cloud import container_v1
def sample_start_ip_rotation():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.StartIPRotationRequest(
)
# Make the request
response = client.start_ip_rotation(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.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
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the |
| name |
str
The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
topic_path
topic_path(project: str, topic: str)Returns a fully-qualified topic string.
update_cluster
update_cluster(request: Optional[Union[google.cloud.container_v1.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_v1.types.cluster_service.ClusterUpdate] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the settings of a specific cluster.
from google.cloud import container_v1
def sample_update_cluster():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.UpdateClusterRequest(
)
# Make the request
response = client.update_cluster(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.UpdateClusterRequest, dict]
The request object. UpdateClusterRequest updates the settings of a cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
| update |
google.cloud.container_v1.types.ClusterUpdate
Required. A description of the update. This corresponds to the |
| name |
str
The name (project, location, cluster) of the cluster to update. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
update_master
update_master(request: Optional[Union[google.cloud.container_v1.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, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the master for a specific cluster.
from google.cloud import container_v1
def sample_update_master():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.UpdateMasterRequest(
master_version="master_version_value",
)
# Make the request
response = client.update_master(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.UpdateMasterRequest, dict]
The request object. UpdateMasterRequest updates the master of the cluster. |
| project_id |
str
Deprecated. The Google Developers Console |
| zone |
str
Deprecated. The name of the Google Compute Engine |
| cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the |
| master_version |
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 |
| name |
str
The name (project, location, cluster) of the cluster to update. Specified in the format |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
update_node_pool
update_node_pool(request: Optional[Union[google.cloud.container_v1.types.cluster_service.UpdateNodePoolRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the version and/or image type for the specified node pool.
.. code-block:: python
from google.cloud import container_v1
def sample_update_node_pool():
# Create a client
client = container_v1.ClusterManagerClient()
# Initialize request argument(s)
request = container_v1.UpdateNodePoolRequest(
node_version="node_version_value",
image_type="image_type_value",
)
# Make the request
response = client.update_node_pool(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.container_v1.types.UpdateNodePoolRequest, dict]
The request object. UpdateNodePoolRequests update a node pool's image and/or version. |
| 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. |
| Type | Description |
| google.cloud.container_v1.types.Operation | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |