As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit Python 2 support on Google Cloud.
Source code for google.cloud.container_v1beta1.services.cluster_manager.client
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from collections import OrderedDict
from distutils import util
import os
import re
from typing import Dict, Optional, Sequence, Tuple, Type, Union
import pkg_resources
import warnings
from google.api_core import client_options as client_options_lib # type: ignore
from google.api_core import exceptions as core_exceptions # type: ignore
from google.api_core import gapic_v1 # type: ignore
from google.api_core import retry as retries # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport import mtls # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.auth.exceptions import MutualTLSChannelError # type: ignore
from google.oauth2 import service_account # type: ignore
OptionalRetry = Union[retries.Retry, object]
from google.cloud.container_v1beta1.services.cluster_manager import pagers
from google.cloud.container_v1beta1.types import cluster_service
from google.rpc import status_pb2 # type: ignore
from .transports.base import ClusterManagerTransport, DEFAULT_CLIENT_INFO
from .transports.grpc import ClusterManagerGrpcTransport
from .transports.grpc_asyncio import ClusterManagerGrpcAsyncIOTransport
class ClusterManagerClientMeta(type):
"""Metaclass for the ClusterManager client.
This provides class-level methods for building and retrieving
support objects (e.g. transport) without polluting the client instance
objects.
"""
_transport_registry = (
OrderedDict()
) # type: Dict[str, Type[ClusterManagerTransport]]
_transport_registry["grpc"] = ClusterManagerGrpcTransport
_transport_registry["grpc_asyncio"] = ClusterManagerGrpcAsyncIOTransport
def get_transport_class(cls, label: str = None,) -> Type[ClusterManagerTransport]:
"""Returns an appropriate transport class.
Args:
label: The name of the desired transport. If none is
provided, then the first transport in the registry is used.
Returns:
The transport class to use.
"""
# If a specific transport is requested, return that one.
if label:
return cls._transport_registry[label]
# No transport is requested; return the default (that is, the first one
# in the dictionary).
return next(iter(cls._transport_registry.values()))
[docs]class ClusterManagerClient(metaclass=ClusterManagerClientMeta):
"""Google Kubernetes Engine Cluster Manager v1beta1"""
@staticmethod
def _get_default_mtls_endpoint(api_endpoint):
"""Converts api endpoint to mTLS endpoint.
Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
"*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
Args:
api_endpoint (Optional[str]): the api endpoint to convert.
Returns:
str: converted mTLS api endpoint.
"""
if not api_endpoint:
return api_endpoint
mtls_endpoint_re = re.compile(
r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?"
)
m = mtls_endpoint_re.match(api_endpoint)
name, mtls, sandbox, googledomain = m.groups()
if mtls or not googledomain:
return api_endpoint
if sandbox:
return api_endpoint.replace(
"sandbox.googleapis.com", "mtls.sandbox.googleapis.com"
)
return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com")
DEFAULT_ENDPOINT = "container.googleapis.com"
DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore
DEFAULT_ENDPOINT
)
[docs] @classmethod
def from_service_account_info(cls, info: dict, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
info.
Args:
info (dict): The service account private key info.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
ClusterManagerClient: The constructed client.
"""
credentials = service_account.Credentials.from_service_account_info(info)
kwargs["credentials"] = credentials
return cls(*args, **kwargs)
[docs] @classmethod
def from_service_account_file(cls, filename: str, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
file.
Args:
filename (str): The path to the service account private key json
file.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
ClusterManagerClient: The constructed client.
"""
credentials = service_account.Credentials.from_service_account_file(filename)
kwargs["credentials"] = credentials
return cls(*args, **kwargs)
from_service_account_json = from_service_account_file
@property
def transport(self) -> ClusterManagerTransport:
"""Returns the transport used by the client instance.
Returns:
ClusterManagerTransport: The transport used by the client
instance.
"""
return self._transport
[docs] @staticmethod
def topic_path(project: str, topic: str,) -> str:
"""Returns a fully-qualified topic string."""
return "projects/{project}/topics/{topic}".format(project=project, topic=topic,)
[docs] @staticmethod
def parse_topic_path(path: str) -> Dict[str, str]:
"""Parses a topic path into its component segments."""
m = re.match(r"^projects/(?P<project>.+?)/topics/(?P<topic>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_billing_account_path(billing_account: str,) -> str:
"""Returns a fully-qualified billing_account string."""
return "billingAccounts/{billing_account}".format(
billing_account=billing_account,
)
[docs] @staticmethod
def parse_common_billing_account_path(path: str) -> Dict[str, str]:
"""Parse a billing_account path into its component segments."""
m = re.match(r"^billingAccounts/(?P<billing_account>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_folder_path(folder: str,) -> str:
"""Returns a fully-qualified folder string."""
return "folders/{folder}".format(folder=folder,)
[docs] @staticmethod
def parse_common_folder_path(path: str) -> Dict[str, str]:
"""Parse a folder path into its component segments."""
m = re.match(r"^folders/(?P<folder>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_organization_path(organization: str,) -> str:
"""Returns a fully-qualified organization string."""
return "organizations/{organization}".format(organization=organization,)
[docs] @staticmethod
def parse_common_organization_path(path: str) -> Dict[str, str]:
"""Parse a organization path into its component segments."""
m = re.match(r"^organizations/(?P<organization>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_project_path(project: str,) -> str:
"""Returns a fully-qualified project string."""
return "projects/{project}".format(project=project,)
[docs] @staticmethod
def parse_common_project_path(path: str) -> Dict[str, str]:
"""Parse a project path into its component segments."""
m = re.match(r"^projects/(?P<project>.+?)$", path)
return m.groupdict() if m else {}
[docs] @staticmethod
def common_location_path(project: str, location: str,) -> str:
"""Returns a fully-qualified location string."""
return "projects/{project}/locations/{location}".format(
project=project, location=location,
)
[docs] @staticmethod
def parse_common_location_path(path: str) -> Dict[str, str]:
"""Parse a location path into its component segments."""
m = re.match(r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)$", path)
return m.groupdict() if m else {}
def __init__(
self,
*,
credentials: Optional[ga_credentials.Credentials] = None,
transport: Union[str, ClusterManagerTransport, None] = None,
client_options: Optional[client_options_lib.ClientOptions] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the cluster manager client.
Args:
credentials (Optional[google.auth.credentials.Credentials]): The
authorization credentials to attach to requests. These
credentials identify the application to the service; if none
are specified, the client will attempt to ascertain the
credentials from the environment.
transport (Union[str, ClusterManagerTransport]): The
transport to use. If set to None, a transport is chosen
automatically.
client_options (google.api_core.client_options.ClientOptions): Custom options for the
client. It won't take effect if a ``transport`` instance is provided.
(1) The ``api_endpoint`` property can be used to override the
default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT
environment variable can also be used to override the endpoint:
"always" (always use the default mTLS endpoint), "never" (always
use the default regular endpoint) and "auto" (auto switch to the
default mTLS endpoint if client certificate is present, this is
the default value). However, the ``api_endpoint`` property takes
precedence if provided.
(2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable
is "true", then the ``client_cert_source`` property can be used
to provide client certificate for mutual TLS transport. If
not provided, the default SSL client certificate will be used if
present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not
set, no client certificate will be used.
client_info (google.api_core.gapic_v1.client_info.ClientInfo):
The client info used to send a user-agent string along with
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
Raises:
google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport
creation failed for any reason.
"""
if isinstance(client_options, dict):
client_options = client_options_lib.from_dict(client_options)
if client_options is None:
client_options = client_options_lib.ClientOptions()
# Create SSL credentials for mutual TLS if needed.
use_client_cert = bool(
util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))
)
client_cert_source_func = None
is_mtls = False
if use_client_cert:
if client_options.client_cert_source:
is_mtls = True
client_cert_source_func = client_options.client_cert_source
else:
is_mtls = mtls.has_default_client_cert_source()
if is_mtls:
client_cert_source_func = mtls.default_client_cert_source()
else:
client_cert_source_func = None
# Figure out which api endpoint to use.
if client_options.api_endpoint is not None:
api_endpoint = client_options.api_endpoint
else:
use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
if use_mtls_env == "never":
api_endpoint = self.DEFAULT_ENDPOINT
elif use_mtls_env == "always":
api_endpoint = self.DEFAULT_MTLS_ENDPOINT
elif use_mtls_env == "auto":
if is_mtls:
api_endpoint = self.DEFAULT_MTLS_ENDPOINT
else:
api_endpoint = self.DEFAULT_ENDPOINT
else:
raise MutualTLSChannelError(
"Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted "
"values: never, auto, always"
)
# Save or instantiate the transport.
# Ordinarily, we provide the transport, but allowing a custom transport
# instance provides an extensibility point for unusual situations.
if isinstance(transport, ClusterManagerTransport):
# transport is a ClusterManagerTransport instance.
if credentials or client_options.credentials_file:
raise ValueError(
"When providing a transport instance, "
"provide its credentials directly."
)
if client_options.scopes:
raise ValueError(
"When providing a transport instance, provide its scopes "
"directly."
)
self._transport = transport
else:
Transport = type(self).get_transport_class(transport)
self._transport = Transport(
credentials=credentials,
credentials_file=client_options.credentials_file,
host=api_endpoint,
scopes=client_options.scopes,
client_cert_source_for_mtls=client_cert_source_func,
quota_project_id=client_options.quota_project_id,
client_info=client_info,
always_use_jwt_access=True,
)
[docs] def list_clusters(
self,
request: Union[cluster_service.ListClustersRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.ListClustersResponse:
r"""Lists all clusters owned by a project in either the
specified zone or all zones.
Args:
request (Union[google.cloud.container_v1beta1.types.ListClustersRequest, dict]):
The request object. ListClustersRequest lists clusters.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the
parent field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.container_v1beta1.types.ListClustersResponse:
ListClustersResponse is the result of
ListClustersRequest.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.ListClustersRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.ListClustersRequest):
request = cluster_service.ListClustersRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_clusters]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def get_cluster(
self,
request: Union[cluster_service.GetClusterRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Cluster:
r"""Gets the details for a specific cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.GetClusterRequest, dict]):
The request object. GetClusterRequest gets the settings
of a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to retrieve. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.container_v1beta1.types.Cluster:
A Google Kubernetes Engine cluster.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.GetClusterRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.GetClusterRequest):
request = cluster_service.GetClusterRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_cluster]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def create_cluster(
self,
request: Union[cluster_service.CreateClusterRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster: cluster_service.Cluster = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Creates a cluster, consisting of the specified number and type
of Google Compute Engine instances.
By default, the cluster is created in the project's `default
network <https://cloud.google.com/compute/docs/networks-and-firewalls#networks>`__.
One firewall is added for the cluster. After cluster creation,
the Kubelet creates routes for each node to allow the containers
on that node to communicate with all other instances in the
cluster.
Finally, an entry is added to the project's global metadata
indicating which CIDR range the cluster is using.
Args:
request (Union[google.cloud.container_v1beta1.types.CreateClusterRequest, dict]):
The request object. CreateClusterRequest creates a
cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the
parent field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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 (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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.CreateClusterRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.CreateClusterRequest):
request = cluster_service.CreateClusterRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster is not None:
request.cluster = cluster
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.create_cluster]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def update_cluster(
self,
request: Union[cluster_service.UpdateClusterRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
update: cluster_service.ClusterUpdate = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Updates the settings for a specific cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.UpdateClusterRequest, dict]):
The request object. UpdateClusterRequest updates the
settings of a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to upgrade. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update (google.cloud.container_v1beta1.types.ClusterUpdate):
Required. A description of the
update.
This corresponds to the ``update`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, update])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.UpdateClusterRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.UpdateClusterRequest):
request = cluster_service.UpdateClusterRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if update is not None:
request.update = update
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.update_cluster]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def update_node_pool(
self,
request: Union[cluster_service.UpdateNodePoolRequest, dict] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Updates the version and/or image type of a specific
node pool.
Args:
request (Union[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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.UpdateNodePoolRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.UpdateNodePoolRequest):
request = cluster_service.UpdateNodePoolRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.update_node_pool]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_node_pool_autoscaling(
self,
request: Union[cluster_service.SetNodePoolAutoscalingRequest, dict] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets the autoscaling settings of a specific node
pool.
Args:
request (Union[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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetNodePoolAutoscalingRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetNodePoolAutoscalingRequest):
request = cluster_service.SetNodePoolAutoscalingRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.set_node_pool_autoscaling
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_logging_service(
self,
request: Union[cluster_service.SetLoggingServiceRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
logging_service: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets the logging service for a specific cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.SetLoggingServiceRequest, dict]):
The request object. SetLoggingServiceRequest sets the
logging service of a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to upgrade. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
logging_service (str):
Required. The logging service the cluster should use to
write logs. Currently available options:
- ``logging.googleapis.com/kubernetes`` - The Cloud
Logging service with a Kubernetes-native resource
model
- ``logging.googleapis.com`` - The legacy Cloud Logging
service (no longer available as of GKE 1.15).
- ``none`` - no logs will be exported from the cluster.
If left as an empty
string,\ ``logging.googleapis.com/kubernetes`` will be
used for GKE 1.14+ or ``logging.googleapis.com`` for
earlier versions.
This corresponds to the ``logging_service`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, logging_service])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetLoggingServiceRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetLoggingServiceRequest):
request = cluster_service.SetLoggingServiceRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if logging_service is not None:
request.logging_service = logging_service
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_logging_service]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_monitoring_service(
self,
request: Union[cluster_service.SetMonitoringServiceRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
monitoring_service: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets the monitoring service for a specific cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.SetMonitoringServiceRequest, dict]):
The request object. SetMonitoringServiceRequest sets the
monitoring service of a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to upgrade. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
monitoring_service (str):
Required. The monitoring service the cluster should use
to write metrics. Currently available options:
- "monitoring.googleapis.com/kubernetes" - The Cloud
Monitoring service with a Kubernetes-native resource
model
- ``monitoring.googleapis.com`` - The legacy Cloud
Monitoring service (no longer available as of GKE
1.15).
- ``none`` - No metrics will be exported from the
cluster.
If left as an empty
string,\ ``monitoring.googleapis.com/kubernetes`` will
be used for GKE 1.14+ or ``monitoring.googleapis.com``
for earlier versions.
This corresponds to the ``monitoring_service`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, monitoring_service])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetMonitoringServiceRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetMonitoringServiceRequest):
request = cluster_service.SetMonitoringServiceRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if monitoring_service is not None:
request.monitoring_service = monitoring_service
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_monitoring_service]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_addons_config(
self,
request: Union[cluster_service.SetAddonsConfigRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
addons_config: cluster_service.AddonsConfig = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets the addons for a specific cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.SetAddonsConfigRequest, dict]):
The request object. SetAddonsRequest sets the addons
associated with the cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to upgrade. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
addons_config (google.cloud.container_v1beta1.types.AddonsConfig):
Required. The desired configurations
for the various addons available to run
in the cluster.
This corresponds to the ``addons_config`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, addons_config])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetAddonsConfigRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetAddonsConfigRequest):
request = cluster_service.SetAddonsConfigRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if addons_config is not None:
request.addons_config = addons_config
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_addons_config]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_locations(
self,
request: Union[cluster_service.SetLocationsRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
locations: Sequence[str] = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets the locations for a specific cluster. Deprecated. Use
`projects.locations.clusters.update <https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update>`__
instead.
Args:
request (Union[google.cloud.container_v1beta1.types.SetLocationsRequest, dict]):
The request object. SetLocationsRequest sets the
locations of the cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to upgrade. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
locations (Sequence[str]):
Required. The desired list of Google Compute Engine
`zones <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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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.
"""
warnings.warn(
"ClusterManagerClient.set_locations is deprecated", DeprecationWarning
)
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, locations])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetLocationsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetLocationsRequest):
request = cluster_service.SetLocationsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if locations is not None:
request.locations = locations
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_locations]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def update_master(
self,
request: Union[cluster_service.UpdateMasterRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
master_version: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Updates the master for a specific cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.UpdateMasterRequest, dict]):
The request object. UpdateMasterRequest updates the
master of the cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to upgrade. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
master_version (str):
Required. The Kubernetes version to
change the master to.
Users may specify either explicit
versions offered by Kubernetes Engine or
version aliases, which have the
following behavior:
- "latest": picks the highest valid
Kubernetes version - "1.X": picks the
highest valid patch+gke.N patch in the
1.X version - "1.X.Y": picks the highest
valid gke.N patch in the 1.X.Y version -
"1.X.Y-gke.N": picks an explicit
Kubernetes version - "-": picks the
default Kubernetes version
This corresponds to the ``master_version`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, master_version])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.UpdateMasterRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.UpdateMasterRequest):
request = cluster_service.UpdateMasterRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if master_version is not None:
request.master_version = master_version
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.update_master]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_master_auth(
self,
request: Union[cluster_service.SetMasterAuthRequest, dict] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets master auth materials. Currently supports
changing the admin password or a specific cluster,
either via password generation or explicitly setting the
password.
Args:
request (Union[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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetMasterAuthRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetMasterAuthRequest):
request = cluster_service.SetMasterAuthRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_master_auth]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def delete_cluster(
self,
request: Union[cluster_service.DeleteClusterRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""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.
Args:
request (Union[google.cloud.container_v1beta1.types.DeleteClusterRequest, dict]):
The request object. DeleteClusterRequest deletes a
cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to delete. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.DeleteClusterRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.DeleteClusterRequest):
request = cluster_service.DeleteClusterRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.delete_cluster]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def list_operations(
self,
request: Union[cluster_service.ListOperationsRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.ListOperationsResponse:
r"""Lists all operations in a project in the specified
zone or all zones.
Args:
request (Union[google.cloud.container_v1beta1.types.ListOperationsRequest, dict]):
The request object. ListOperationsRequest lists
operations.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the
parent field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.container_v1beta1.types.ListOperationsResponse:
ListOperationsResponse is the result
of ListOperationsRequest.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.ListOperationsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.ListOperationsRequest):
request = cluster_service.ListOperationsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_operations]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def get_operation(
self,
request: Union[cluster_service.GetOperationRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
operation_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Gets the specified operation.
Args:
request (Union[google.cloud.container_v1beta1.types.GetOperationRequest, dict]):
The request object. GetOperationRequest gets a single
operation.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The server-assigned ``name`` of
the operation. This field has been deprecated and
replaced by the name field.
This corresponds to the ``operation_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, operation_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.GetOperationRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.GetOperationRequest):
request = cluster_service.GetOperationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if operation_id is not None:
request.operation_id = operation_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_operation]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def cancel_operation(
self,
request: Union[cluster_service.CancelOperationRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
operation_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Cancels the specified operation.
Args:
request (Union[google.cloud.container_v1beta1.types.CancelOperationRequest, dict]):
The request object. CancelOperationRequest cancels a
single operation.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The server-assigned ``name`` of
the operation. This field has been deprecated and
replaced by the name field.
This corresponds to the ``operation_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, operation_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.CancelOperationRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.CancelOperationRequest):
request = cluster_service.CancelOperationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if operation_id is not None:
request.operation_id = operation_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.cancel_operation]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
rpc(
request, retry=retry, timeout=timeout, metadata=metadata,
)
[docs] def get_server_config(
self,
request: Union[cluster_service.GetServerConfigRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.ServerConfig:
r"""Returns configuration info about the Google
Kubernetes Engine service.
Args:
request (Union[google.cloud.container_v1beta1.types.GetServerConfigRequest, dict]):
The request object. Gets the current Kubernetes Engine
service configuration.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.container_v1beta1.types.ServerConfig:
Kubernetes Engine service
configuration.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.GetServerConfigRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.GetServerConfigRequest):
request = cluster_service.GetServerConfigRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_server_config]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def list_node_pools(
self,
request: Union[cluster_service.ListNodePoolsRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.ListNodePoolsResponse:
r"""Lists the node pools for a cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.ListNodePoolsRequest, dict]):
The request object. ListNodePoolsRequest lists the node
pool(s) for a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://developers.google.com/console/help/new/#projectnumber>`__.
This field has been deprecated and replaced by the
parent field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster. This field has been deprecated
and replaced by the parent field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.container_v1beta1.types.ListNodePoolsResponse:
ListNodePoolsResponse is the result
of ListNodePoolsRequest.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.ListNodePoolsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.ListNodePoolsRequest):
request = cluster_service.ListNodePoolsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_node_pools]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def get_json_web_keys(
self,
request: Union[cluster_service.GetJSONWebKeysRequest, dict] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.GetJSONWebKeysResponse:
r"""Gets the public component of the cluster signing keys
in JSON Web Key format.
This API is not yet intended for general use, and is not
available for all clusters.
Args:
request (Union[google.cloud.container_v1beta1.types.GetJSONWebKeysRequest, dict]):
The request object. GetJSONWebKeysRequest gets the
public component of the keys used by the cluster to sign
token requests. This will be the jwks_uri for the
discover document returned by getOpenIDConfig. See the
OpenID Connect Discovery 1.0 specification for details.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.container_v1beta1.types.GetJSONWebKeysResponse:
GetJSONWebKeysResponse is a valid
JSON Web Key Set as specififed in rfc
7517
"""
# Create or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.GetJSONWebKeysRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.GetJSONWebKeysRequest):
request = cluster_service.GetJSONWebKeysRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_json_web_keys]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def get_node_pool(
self,
request: Union[cluster_service.GetNodePoolRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
node_pool_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.NodePool:
r"""Retrieves the requested node pool.
Args:
request (Union[google.cloud.container_v1beta1.types.GetNodePoolRequest, dict]):
The request object. GetNodePoolRequest retrieves a node
pool for a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://developers.google.com/console/help/new/#projectnumber>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster. This field has been deprecated
and replaced by the name field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
node_pool_id (str):
Required. Deprecated. The name of the
node pool. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``node_pool_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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.
These upgrade settings control the level
of parallelism and the level of
disruption caused by an upgrade.
maxUnavailable controls the number of
nodes that can be simultaneously
unavailable.
maxSurge controls the number of
additional nodes that can be added to
the node pool temporarily for the time
of the upgrade to increase the number of
available nodes.
(maxUnavailable + maxSurge) determines
the level of parallelism (how many nodes
are being upgraded at the same time).
Note: upgrades inevitably introduce some
disruption since workloads need to be
moved from old nodes to new, upgraded
ones. Even if maxUnavailable=0, this
holds true. (Disruption stays within the
limits of PodDisruptionBudget, if it is
configured.)
Consider a hypothetical node pool with 5
nodes having maxSurge=2,
maxUnavailable=1. This means the upgrade
process upgrades 3 nodes simultaneously.
It creates 2 additional (upgraded)
nodes, then it brings down 3 old (not
yet upgraded) nodes at the same time.
This ensures that there are always at
least 4 nodes available.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, node_pool_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.GetNodePoolRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.GetNodePoolRequest):
request = cluster_service.GetNodePoolRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if node_pool_id is not None:
request.node_pool_id = node_pool_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_node_pool]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def create_node_pool(
self,
request: Union[cluster_service.CreateNodePoolRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
node_pool: cluster_service.NodePool = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Creates a node pool for a cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.CreateNodePoolRequest, dict]):
The request object. CreateNodePoolRequest creates a node
pool for a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://developers.google.com/console/help/new/#projectnumber>`__.
This field has been deprecated and replaced by the
parent field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster. This field has been deprecated
and replaced by the parent field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
node_pool (google.cloud.container_v1beta1.types.NodePool):
Required. The node pool to create.
This corresponds to the ``node_pool`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, node_pool])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.CreateNodePoolRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.CreateNodePoolRequest):
request = cluster_service.CreateNodePoolRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if node_pool is not None:
request.node_pool = node_pool
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.create_node_pool]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def delete_node_pool(
self,
request: Union[cluster_service.DeleteNodePoolRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
node_pool_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Deletes a node pool from a cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.DeleteNodePoolRequest, dict]):
The request object. DeleteNodePoolRequest deletes a node
pool for a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://developers.google.com/console/help/new/#projectnumber>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster. This field has been deprecated
and replaced by the name field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
node_pool_id (str):
Required. Deprecated. The name of the
node pool to delete. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``node_pool_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, node_pool_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.DeleteNodePoolRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.DeleteNodePoolRequest):
request = cluster_service.DeleteNodePoolRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if node_pool_id is not None:
request.node_pool_id = node_pool_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.delete_node_pool]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def rollback_node_pool_upgrade(
self,
request: Union[cluster_service.RollbackNodePoolUpgradeRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
node_pool_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Rolls back a previously Aborted or Failed NodePool
upgrade. This makes no changes if the last upgrade
successfully completed.
Args:
request (Union[google.cloud.container_v1beta1.types.RollbackNodePoolUpgradeRequest, dict]):
The request object. RollbackNodePoolUpgradeRequest
rollbacks the previously Aborted or Failed NodePool
upgrade. This will be an no-op if the last upgrade
successfully completed.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to rollback. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
node_pool_id (str):
Required. Deprecated. The name of the
node pool to rollback. This field has
been deprecated and replaced by the name
field.
This corresponds to the ``node_pool_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, node_pool_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.RollbackNodePoolUpgradeRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.RollbackNodePoolUpgradeRequest):
request = cluster_service.RollbackNodePoolUpgradeRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if node_pool_id is not None:
request.node_pool_id = node_pool_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.rollback_node_pool_upgrade
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_node_pool_management(
self,
request: Union[cluster_service.SetNodePoolManagementRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
node_pool_id: str = None,
management: cluster_service.NodeManagement = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets the NodeManagement options for a node pool.
Args:
request (Union[google.cloud.container_v1beta1.types.SetNodePoolManagementRequest, dict]):
The request object. SetNodePoolManagementRequest sets
the node management properties of a node pool.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to update. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
node_pool_id (str):
Required. Deprecated. The name of the
node pool to update. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``node_pool_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
management (google.cloud.container_v1beta1.types.NodeManagement):
Required. NodeManagement
configuration for the node pool.
This corresponds to the ``management`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any(
[project_id, zone, cluster_id, node_pool_id, management]
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetNodePoolManagementRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetNodePoolManagementRequest):
request = cluster_service.SetNodePoolManagementRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if node_pool_id is not None:
request.node_pool_id = node_pool_id
if management is not None:
request.management = management
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_node_pool_management]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_labels(
self,
request: Union[cluster_service.SetLabelsRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
resource_labels: Sequence[
cluster_service.SetLabelsRequest.ResourceLabelsEntry
] = None,
label_fingerprint: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets labels on a cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.SetLabelsRequest, dict]):
The request object. SetLabelsRequest sets the Google
Cloud Platform labels on a Google Container Engine
cluster, which will in turn set them for Google Compute
Engine resources used by that cluster
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://developers.google.com/console/help/new/#projectnumber>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster. This field has been deprecated
and replaced by the name field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
resource_labels (Sequence[google.cloud.container_v1beta1.types.SetLabelsRequest.ResourceLabelsEntry]):
Required. The labels to set for that
cluster.
This corresponds to the ``resource_labels`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
label_fingerprint (str):
Required. The fingerprint of the previous set of labels
for this resource, used to detect conflicts. The
fingerprint is initially generated by Kubernetes Engine
and changes after every request to modify or update
labels. You must always provide an up-to-date
fingerprint hash when updating or changing labels. Make
a ``get()`` request to the resource to get the latest
fingerprint.
This corresponds to the ``label_fingerprint`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any(
[project_id, zone, cluster_id, resource_labels, label_fingerprint]
)
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetLabelsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetLabelsRequest):
request = cluster_service.SetLabelsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if resource_labels is not None:
request.resource_labels = resource_labels
if label_fingerprint is not None:
request.label_fingerprint = label_fingerprint
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_labels]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_legacy_abac(
self,
request: Union[cluster_service.SetLegacyAbacRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
enabled: bool = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Enables or disables the ABAC authorization mechanism
on a cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.SetLegacyAbacRequest, dict]):
The request object. SetLegacyAbacRequest enables or
disables the ABAC authorization mechanism for a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://support.google.com/cloud/answer/6158840>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster to update. This field has been
deprecated and replaced by the name
field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
enabled (bool):
Required. Whether ABAC authorization
will be enabled in the cluster.
This corresponds to the ``enabled`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, enabled])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetLegacyAbacRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetLegacyAbacRequest):
request = cluster_service.SetLegacyAbacRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if enabled is not None:
request.enabled = enabled
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_legacy_abac]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def start_ip_rotation(
self,
request: Union[cluster_service.StartIPRotationRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Starts master IP rotation.
Args:
request (Union[google.cloud.container_v1beta1.types.StartIPRotationRequest, dict]):
The request object. StartIPRotationRequest creates a new
IP for the cluster and then performs a node upgrade on
each node pool to point to the new IP.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://developers.google.com/console/help/new/#projectnumber>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster. This field has been deprecated
and replaced by the name field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.StartIPRotationRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.StartIPRotationRequest):
request = cluster_service.StartIPRotationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.start_ip_rotation]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def complete_ip_rotation(
self,
request: Union[cluster_service.CompleteIPRotationRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Completes master IP rotation.
Args:
request (Union[google.cloud.container_v1beta1.types.CompleteIPRotationRequest, dict]):
The request object. CompleteIPRotationRequest moves the
cluster master back into single-IP mode.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://developers.google.com/console/help/new/#projectnumber>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster. This field has been deprecated
and replaced by the name field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.CompleteIPRotationRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.CompleteIPRotationRequest):
request = cluster_service.CompleteIPRotationRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.complete_ip_rotation]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_node_pool_size(
self,
request: Union[cluster_service.SetNodePoolSizeRequest, dict] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""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].
Args:
request (Union[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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetNodePoolSizeRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetNodePoolSizeRequest):
request = cluster_service.SetNodePoolSizeRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_node_pool_size]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_network_policy(
self,
request: Union[cluster_service.SetNetworkPolicyRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
network_policy: cluster_service.NetworkPolicy = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Enables or disables Network Policy for a cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.SetNetworkPolicyRequest, dict]):
The request object. SetNetworkPolicyRequest
enables/disables network policy for a cluster.
project_id (str):
Required. Deprecated. The Google Developers Console
`project ID or project
number <https://developers.google.com/console/help/new/#projectnumber>`__.
This field has been deprecated and replaced by the name
field.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
zone (str):
Required. Deprecated. The name of the Google Compute
Engine
`zone <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):
Required. Deprecated. The name of the
cluster. This field has been deprecated
and replaced by the name field.
This corresponds to the ``cluster_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
network_policy (google.cloud.container_v1beta1.types.NetworkPolicy):
Required. Configuration options for
the NetworkPolicy feature.
This corresponds to the ``network_policy`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, network_policy])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetNetworkPolicyRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetNetworkPolicyRequest):
request = cluster_service.SetNetworkPolicyRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if network_policy is not None:
request.network_policy = network_policy
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_network_policy]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def set_maintenance_policy(
self,
request: Union[cluster_service.SetMaintenancePolicyRequest, dict] = None,
*,
project_id: str = None,
zone: str = None,
cluster_id: str = None,
maintenance_policy: cluster_service.MaintenancePolicy = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.Operation:
r"""Sets the maintenance policy for a cluster.
Args:
request (Union[google.cloud.container_v1beta1.types.SetMaintenancePolicyRequest, dict]):
The request object. SetMaintenancePolicyRequest sets the
maintenance policy for a cluster.
project_id (str):
Required. The Google Developers Console `project ID or
project
number <https://support.google.com/cloud/answer/6158840>`__.
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 (google.cloud.container_v1beta1.types.MaintenancePolicy):
Required. The maintenance policy to
be set for the cluster. An empty field
clears the existing maintenance policy.
This corresponds to the ``maintenance_policy`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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 or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, zone, cluster_id, maintenance_policy])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.SetMaintenancePolicyRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.SetMaintenancePolicyRequest):
request = cluster_service.SetMaintenancePolicyRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if zone is not None:
request.zone = zone
if cluster_id is not None:
request.cluster_id = cluster_id
if maintenance_policy is not None:
request.maintenance_policy = maintenance_policy
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.set_maintenance_policy]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
[docs] def list_usable_subnetworks(
self,
request: Union[cluster_service.ListUsableSubnetworksRequest, dict] = None,
*,
parent: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListUsableSubnetworksPager:
r"""Lists subnetworks that can be used for creating
clusters in a project.
Args:
request (Union[google.cloud.container_v1beta1.types.ListUsableSubnetworksRequest, dict]):
The request object. ListUsableSubnetworksRequest
requests the list of usable subnetworks. available to a
user for creating clusters.
parent (str):
Required. The parent project where subnetworks are
usable. Specified in the format ``projects/*``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
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.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([parent])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.ListUsableSubnetworksRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.ListUsableSubnetworksRequest):
request = cluster_service.ListUsableSubnetworksRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_usable_subnetworks]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListUsableSubnetworksPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response
[docs] def list_locations(
self,
request: Union[cluster_service.ListLocationsRequest, dict] = None,
*,
parent: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.ListLocationsResponse:
r"""Fetches locations that offer Google Kubernetes
Engine.
Args:
request (Union[google.cloud.container_v1beta1.types.ListLocationsRequest, dict]):
The request object. ListLocationsRequest is used to
request the locations that offer GKE.
parent (str):
Required. Contains the name of the resource requested.
Specified in the format ``projects/*``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.container_v1beta1.types.ListLocationsResponse:
ListLocationsResponse returns the
list of all GKE locations and their
recommendation state.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([parent])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a cluster_service.ListLocationsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cluster_service.ListLocationsRequest):
request = cluster_service.ListLocationsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_locations]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
def __enter__(self):
return self
[docs] def __exit__(self, type, value, traceback):
"""Releases underlying transport's resources.
.. warning::
ONLY use as a context manager if the transport is NOT shared
with other clients! Exiting the with block will CLOSE the transport
and may cause errors in other clients!
"""
self.transport.close()
try:
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=pkg_resources.get_distribution("google-cloud-container",).version,
)
except pkg_resources.DistributionNotFound:
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo()
__all__ = ("ClusterManagerClient",)