# Class ClusterManagerClient (2.65.0) 2.65.0 (latest) 2.62.0 2.61.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.1 2.55.1 2.54.0 2.53.0 2.52.0 2.50.0 2.49.0 2.48.0 2.47.1 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.27.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.4 2.16.0 2.15.0 2.14.0 2.13.0 2.12.2 2.11.2 2.10.8 2.9.0 2.8.1 2.7.1 2.6.1 2.5.0 2.4.1 2.3.1 2.2.0 2.1.0 2.0.1 1.0.3 0.5.0 0.4.0 0.3.0 ClusterManagerClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport, typing.Callable[ [...], google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport, ], ] ] = None, client_options: typing.Optional[ typing.Union[google.api_core.client_options.ClientOptions, dict] ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Google Kubernetes Engine Cluster Manager v1beta1 ## Properties ### api_endpoint Return the API endpoint used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The API endpoint used by the client instance. | ### transport Returns the transport used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `ClusterManagerTransport` | The transport used by the client instance. | ### universe_domain Return the universe domain used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The universe domain used by the client instance. | ## Methods ### ClusterManagerClient ClusterManagerClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport, typing.Callable[ [...], google.cloud.container_v1beta1.services.cluster_manager.transports.base.ClusterManagerTransport, ], ] ] = None, client_options: typing.Optional[ typing.Union[google.api_core.client_options.ClientOptions, dict] ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Instantiates the cluster manager client. | **Parameters** || |---|---| | **Name** | **Description** | | `credentials` | `Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. | | `transport` | `Optional[Union[str,ClusterManagerTransport,Callable[..., ClusterManagerTransport]]]` The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the ClusterManagerTransport constructor. If set to None, a transport is chosen automatically. | | `client_options` | `Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS 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. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS. | | `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. | | **Exceptions** || |---|---| | **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] > **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! ### ca_pool_path ca_pool_path(project: str, location: str, ca_pool: str) -> str Returns a fully-qualified ca_pool string. ### cancel_operation cancel_operation( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.CancelOperationRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, operation_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Cancels the specified operation. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_cancel_operation(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CancelOperationRequest.html( ) # Make the request client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_cancel_operation(request=request) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CancelOperationRequest, dict]` The request object. CancelOperationRequest cancels a single operation. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ in which the operation resides. This field has been deprecated and replaced by the name field. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set. | | `operation_id` | `str` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### check_autopilot_compatibility check_autopilot_compatibility( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.CheckAutopilotCompatibilityRequest, dict, ] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.container_v1beta1.types.cluster_service.CheckAutopilotCompatibilityResponse ) Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_check_autopilot_compatibility(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CheckAutopilotCompatibilityRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_check_autopilot_compatibility(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CheckAutopilotCompatibilityRequest, dict]` The request object. CheckAutopilotCompatibilityRequest requests getting the blockers for the given operation in the 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CheckAutopilotCompatibilityResponse` | CheckAutopilotCompatibilityResponse has a list of compatibility issues. | ### common_billing_account_path common_billing_account_path(billing_account: str) -> str Returns a fully-qualified billing_account string. ### common_folder_path common_folder_path(folder: str) -> str Returns a fully-qualified folder string. ### common_location_path common_location_path(project: str, location: str) -> str Returns a fully-qualified location string. ### common_organization_path common_organization_path(organization: str) -> str Returns a fully-qualified organization string. ### common_project_path common_project_path(project: str) -> str Returns a fully-qualified project string. ### complete_control_plane_upgrade complete_control_plane_upgrade( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.CompleteControlPlaneUpgradeRequest, dict, ] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation CompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_complete_control_plane_upgrade(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CompleteControlPlaneUpgradeRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_complete_control_plane_upgrade(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CompleteControlPlaneUpgradeRequest, dict]` The request object. CompleteControlPlaneUpgradeRequest sets the name of target cluster to complete upgrade. | | `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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.Operation` | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. | ### complete_ip_rotation complete_ip_rotation( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.CompleteIPRotationRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Completes master IP rotation. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_complete_ip_rotation(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CompleteIPRotationRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_complete_ip_rotation(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CompleteIPRotationRequest, dict]` The request object. CompleteIPRotationRequest moves the cluster master back into single-IP mode. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.Operation` | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. | ### complete_node_pool_upgrade complete_node_pool_upgrade( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.CompleteNodePoolUpgradeRequest, dict, ] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_complete_node_pool_upgrade(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CompleteNodePoolUpgradeRequest.html( ) # Make the request client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_complete_node_pool_upgrade(request=request) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CompleteNodePoolUpgradeRequest, dict]` The request object. CompleteNodePoolUpgradeRequest sets the name of target node pool to complete upgrade. | | `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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### create_cluster create_cluster( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.CreateClusterRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster: typing.Optional[ google.cloud.container_v1beta1.types.cluster_service.Cluster ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation 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. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_create_cluster(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CreateClusterRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_create_cluster(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CreateClusterRequest, dict]` The request object. CreateClusterRequest creates a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.Cluster` Required. A `cluster resource https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters`__ 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.CreateNodePoolRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, node_pool: typing.Optional[ google.cloud.container_v1beta1.types.cluster_service.NodePool ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Creates a node pool for a cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_create_node_pool(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CreateNodePoolRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_create_node_pool(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.CreateNodePoolRequest, dict]` The request object. CreateNodePoolRequest creates a node pool for a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` | `https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.Operation` | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. | ### crypto_key_version_path crypto_key_version_path( project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str ) -> str Returns a fully-qualified crypto_key_version string. ### delete_cluster delete_cluster( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.DeleteClusterRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation 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. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_delete_cluster(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.DeleteClusterRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_delete_cluster(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.DeleteClusterRequest, dict]` The request object. DeleteClusterRequest deletes a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.DeleteNodePoolRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, node_pool_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Deletes a node pool from a cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_delete_node_pool(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.DeleteNodePoolRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_delete_node_pool(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.DeleteNodePoolRequest, dict]` The request object. DeleteNodePoolRequest deletes a node pool for a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.Operation` | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. | ### fetch_cluster_upgrade_info fetch_cluster_upgrade_info( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.FetchClusterUpgradeInfoRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.ClusterUpgradeInfo Fetch upgrade information of a specific cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_fetch_cluster_upgrade_info(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.FetchClusterUpgradeInfoRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_fetch_cluster_upgrade_info(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.FetchClusterUpgradeInfoRequest, dict]` The request object. FetchClusterUpgradeInfoRequest fetches the upgrade information of a cluster. | | `name` | `str` Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects//locations//clusters/` or `projects//zones//clusters/`. This corresponds to the `name` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ClusterUpgradeInfo` | ClusterUpgradeInfo contains the upgrade information of a cluster. | ### fetch_node_pool_upgrade_info fetch_node_pool_upgrade_info( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.FetchNodePoolUpgradeInfoRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.NodePoolUpgradeInfo Fetch upgrade information of a specific node pool. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_fetch_node_pool_upgrade_info(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.FetchNodePoolUpgradeInfoRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_fetch_node_pool_upgrade_info(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.FetchNodePoolUpgradeInfoRequest, dict]` The request object. FetchNodePoolUpgradeInfoRequest fetches the upgrade information of a node pool. | | `name` | `str` Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects//locations//clusters//nodePools/` or `projects//zones//clusters//nodePools/`. This corresponds to the `name` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.NodePoolUpgradeInfo` | NodePoolUpgradeInfo contains the upgrade information of a node pool. | ### from_service_account_file from_service_account_file(filename: str, *args, **kwargs) Creates an instance of this client using the provided credentials file. | **Parameter** || |---|---| | **Name** | **Description** | | `filename` | `str` The path to the service account private key json file. | | **Returns** || |---|---| | **Type** | **Description** | | `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. | **Parameter** || |---|---| | **Name** | **Description** | | `info` | `dict` The service account private key info. | | **Returns** || |---|---| | **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. | **Parameter** || |---|---| | **Name** | **Description** | | `filename` | `str` The path to the service account private key json file. | | **Returns** || |---|---| | **Type** | **Description** | | `ClusterManagerClient` | The constructed client. | ### get_cluster get_cluster( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.GetClusterRequest, dict ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Cluster Gets the details for a specific cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_get_cluster(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetClusterRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_get_cluster(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetClusterRequest, dict]` The request object. GetClusterRequest gets the settings of a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.Cluster` | A Google Kubernetes Engine cluster. | ### get_json_web_keys get_json_web_keys( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.GetJSONWebKeysRequest, dict, ] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.GetJSONWebKeysResponse Gets the public component of the cluster signing keys in JSON Web Key format. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_get_json_web_keys(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetJSONWebKeysRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_get_json_web_keys(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetJSONWebKeysResponse` | GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517 | ### get_mtls_endpoint_and_cert_source get_mtls_endpoint_and_cert_source( client_options: typing.Optional[ google.api_core.client_options.ClientOptions ] = None, ) Deprecated. 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 variable 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 . | **Parameter** || |---|---| | **Name** | **Description** | | `client_options` | `google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method. | | **Exceptions** || |---|---| | **Type** | **Description** | | `google.auth.exceptions.MutualTLSChannelError` | If any errors happen. | | **Returns** || |---|---| | **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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.GetNodePoolRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, node_pool_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.NodePool Retrieves the requested node pool. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_get_node_pool(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetNodePoolRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_get_node_pool(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetNodePoolRequest, dict]` The request object. GetNodePoolRequest retrieves a node pool for a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.GetOperationRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, operation_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Gets the specified operation. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_get_operation(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetOperationRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_get_operation(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetOperationRequest, dict]` The request object. GetOperationRequest gets a single operation. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.GetServerConfigRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.ServerConfig Returns configuration info about the Google Kubernetes Engine service. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_get_server_config(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetServerConfigRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_get_server_config(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.GetServerConfigRequest, dict]` The request object. Gets the current Kubernetes Engine service configuration. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ServerConfig` | Kubernetes Engine service configuration. | ### list_clusters list_clusters( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.ListClustersRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.ListClustersResponse Lists all clusters owned by a project in either the specified zone or all zones. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_list_clusters(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListClustersRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_list_clusters(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListClustersRequest, dict]` The request object. ListClustersRequest lists clusters. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListClustersResponse` | ListClustersResponse is the result of ListClustersRequest. | ### list_locations list_locations( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.ListLocationsRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.ListLocationsResponse Fetches locations that offer Google Kubernetes Engine. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_list_locations(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListLocationsRequest.html( parent="parent_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_list_locations(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListLocationsResponse` | ListLocationsResponse returns the list of all GKE locations and their recommendation state. | ### list_node_pools list_node_pools( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.ListNodePoolsRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.ListNodePoolsResponse Lists the node pools for a cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_list_node_pools(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListNodePoolsRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_list_node_pools(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListNodePoolsRequest, dict]` The request object. ListNodePoolsRequest lists the node pool(s) for a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListNodePoolsResponse` | ListNodePoolsResponse is the result of ListNodePoolsRequest. | ### list_operations list_operations( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.ListOperationsRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.ListOperationsResponse Lists all operations in a project in the specified zone or all zones. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_list_operations(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListOperationsRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_list_operations(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListOperationsRequest, dict]` The request object. ListOperationsRequest lists operations. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListOperationsResponse` | ListOperationsResponse is the result of ListOperationsRequest. | ### list_usable_subnetworks list_usable_subnetworks( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.ListUsableSubnetworksRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.container_v1beta1.services.cluster_manager.pagers.ListUsableSubnetworksPager ) Lists subnetworks that can be used for creating clusters in a project. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_list_usable_subnetworks(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.ListUsableSubnetworksRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_list_usable_subnetworks(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.pagers.ListUsableSubnetworksPager` | ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. Iterating over this object will yield results and resolve additional pages automatically. | ### parse_ca_pool_path parse_ca_pool_path(path: str) -> typing.Dict[str, str] Parses a ca_pool path into its component segments. ### parse_common_billing_account_path parse_common_billing_account_path(path: str) -> typing.Dict[str, str] Parse a billing_account path into its component segments. ### parse_common_folder_path parse_common_folder_path(path: str) -> typing.Dict[str, str] Parse a folder path into its component segments. ### parse_common_location_path parse_common_location_path(path: str) -> typing.Dict[str, str] Parse a location path into its component segments. ### parse_common_organization_path parse_common_organization_path(path: str) -> typing.Dict[str, str] Parse a organization path into its component segments. ### parse_common_project_path parse_common_project_path(path: str) -> typing.Dict[str, str] Parse a project path into its component segments. ### parse_crypto_key_version_path parse_crypto_key_version_path(path: str) -> typing.Dict[str, str] Parses a crypto_key_version path into its component segments. ### parse_subnetwork_path parse_subnetwork_path(path: str) -> typing.Dict[str, str] Parses a subnetwork path into its component segments. ### parse_topic_path parse_topic_path(path: str) -> typing.Dict[str, str] Parses a topic path into its component segments. ### rollback_node_pool_upgrade rollback_node_pool_upgrade( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.RollbackNodePoolUpgradeRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, node_pool_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_rollback_node_pool_upgrade(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.RollbackNodePoolUpgradeRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_rollback_node_pool_upgrade(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/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` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetAddonsConfigRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, addons_config: typing.Optional[ google.cloud.container_v1beta1.types.cluster_service.AddonsConfig ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets the addons for a specific cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_addons_config(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetAddonsConfigRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_addons_config(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetAddonsConfigRequest, dict]` The request object. SetAddonsRequest sets the addons associated with the cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` | `https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetLabelsRequest, dict ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, resource_labels: typing.Optional[typing.MutableMapping[str, str]] = None, label_fingerprint: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets labels on a cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_labels(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetLabelsRequest.html( label_fingerprint="label_fingerprint_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_labels(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/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` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` | `MutableMapping[str, str]` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetLegacyAbacRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, enabled: typing.Optional[bool] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Enables or disables the ABAC authorization mechanism on a cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_legacy_abac(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetLegacyAbacRequest.html( enabled=True, ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_legacy_abac(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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 `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetLocationsRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, locations: typing.Optional[typing.MutableSequence[str]] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets the locations for a specific cluster. Deprecated. Use `projects.locations.clusters.update `__ instead. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_locations(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetLocationsRequest.html( locations=['locations_value1', 'locations_value2'], ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_locations(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetLocationsRequest, dict]` The request object. SetLocationsRequest sets the locations of the cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` | `MutableSequence[str]` Required. The desired list of Google Compute Engine `zones https://cloud.google.com/compute/docs/zones#available`__ 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetLoggingServiceRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, logging_service: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets the logging service for a specific cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_logging_service(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetLoggingServiceRequest.html( logging_service="logging_service_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_logging_service(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetLoggingServiceRequest, dict]` The request object. SetLoggingServiceRequest sets the logging service of a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetMaintenancePolicyRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, maintenance_policy: typing.Optional[ google.cloud.container_v1beta1.types.cluster_service.MaintenancePolicy ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets the maintenance policy for a cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_maintenance_policy(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetMaintenancePolicyRequest.html( project_id="project_id_value", zone="zone_value", cluster_id="cluster_id_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_maintenance_policy(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/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 https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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 https://cloud.google.com/compute/docs/zones#available`__ 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` | `https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetMasterAuthRequest, dict, ] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_master_auth(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetMasterAuthRequest.html( action="SET_USERNAME", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_master_auth(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetMonitoringServiceRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, monitoring_service: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets the monitoring service for a specific cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_monitoring_service(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetMonitoringServiceRequest.html( monitoring_service="monitoring_service_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_monitoring_service(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetMonitoringServiceRequest, dict]` The request object. SetMonitoringServiceRequest sets the monitoring service of a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetNetworkPolicyRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, network_policy: typing.Optional[ google.cloud.container_v1beta1.types.cluster_service.NetworkPolicy ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Enables or disables Network Policy for a cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_network_policy(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetNetworkPolicyRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_network_policy(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetNetworkPolicyRequest, dict]` The request object. SetNetworkPolicyRequest enables/disables network policy for a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` | `https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetNodePoolAutoscalingRequest, dict, ] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets the autoscaling settings of a specific node pool. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_node_pool_autoscaling(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetNodePoolAutoscalingRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_node_pool_autoscaling(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetNodePoolManagementRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, node_pool_id: typing.Optional[str] = None, management: typing.Optional[ google.cloud.container_v1beta1.types.cluster_service.NodeManagement ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Sets the NodeManagement options for a node pool. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_node_pool_management(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetNodePoolManagementRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_node_pool_management(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetNodePoolManagementRequest, dict]` The request object. SetNodePoolManagementRequest sets the node management properties of a node pool. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` 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` | `https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.SetNodePoolSizeRequest, dict, ] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation 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]`. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_set_node_pool_size(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.SetNodePoolSizeRequest.html( node_count=1070, ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_set_node_pool_size(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.StartIPRotationRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Starts master IP rotation. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_start_ip_rotation(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.StartIPRotationRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_start_ip_rotation(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/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` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.Operation` | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. | ### subnetwork_path subnetwork_path(project: str, region: str, subnetwork: str) -> str Returns a fully-qualified subnetwork string. ### topic_path topic_path(project: str, topic: str) -> str Returns a fully-qualified topic string. ### update_cluster update_cluster( request: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.UpdateClusterRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, update: typing.Optional[ google.cloud.container_v1beta1.types.cluster_service.ClusterUpdate ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Updates the settings for a specific cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_update_cluster(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.UpdateClusterRequest.html( ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_update_cluster(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.UpdateClusterRequest, dict]` The request object. UpdateClusterRequest updates the settings of a cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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` | `https://docs.cloud.google.com/python/docs/reference/container/latest/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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.UpdateMasterRequest, dict, ] ] = None, *, project_id: typing.Optional[str] = None, zone: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, master_version: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Updates the master for a specific cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_update_master(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.UpdateMasterRequest.html( master_version="master_version_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_update_master(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.UpdateMasterRequest, dict]` The request object. UpdateMasterRequest updates the master of the cluster. | | `project_id` | `str` Deprecated. The Google Developers Console `project ID or project number https://cloud.google.com/resource-manager/docs/creating-managing-projects`__. 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` Deprecated. The name of the Google Compute Engine `zone https://cloud.google.com/compute/docs/zones#available`__ 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` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.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: typing.Optional[ typing.Union[ google.cloud.container_v1beta1.types.cluster_service.UpdateNodePoolRequest, dict, ] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.container_v1beta1.types.cluster_service.Operation Updates the version and/or image type of a specific node pool. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import container_v1beta1 def sample_update_node_pool(): # Create a client client = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html() # Initialize request argument(s) request = container_v1beta1.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.UpdateNodePoolRequest.html( node_version="node_version_value", image_type="image_type_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.services.cluster_manager.ClusterManagerClient.html#google_cloud_container_v1beta1_services_cluster_manager_ClusterManagerClient_update_node_pool(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.UpdateNodePoolRequest, dict]` The request object. SetNodePoolVersionRequest updates the version of a node pool. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.Operation` | This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |