Class AttachedClustersClient (0.6.11) 

AttachedClustersClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.gke_multicloud_v1.services.attached_clusters.transports.base.AttachedClustersTransport, typing.Callable[[...], google.cloud.gke_multicloud_v1.services.attached_clusters.transports.base.AttachedClustersTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The AttachedClusters API provides a single centrally managed service to register and manage Anthos attached clusters that run on customer's owned infrastructure.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
AttachedClustersTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

AttachedClustersClient

AttachedClustersClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.gke_multicloud_v1.services.attached_clusters.transports.base.AttachedClustersTransport, typing.Callable[[...], google.cloud.gke_multicloud_v1.services.attached_clusters.transports.base.AttachedClustersTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the attached clusters client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,AttachedClustersTransport,Callable[..., AttachedClustersTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the AttachedClustersTransport constructor. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

attached_cluster_path

attached_cluster_path(project: str, location: str, attached_cluster: str) -> str

Returns a fully-qualified attached_cluster string.

attached_server_config_path

attached_server_config_path(project: str, location: str) -> str

Returns a fully-qualified attached_server_config string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_attached_cluster

create_attached_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.CreateAttachedClusterRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    attached_cluster: typing.Optional[
        google.cloud.gke_multicloud_v1.types.attached_resources.AttachedCluster
    ] = None,
    attached_cluster_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new xref_AttachedCluster resource on a given Google Cloud Platform project and region.

If successful, the response contains a newly created Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_create_attached_cluster():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    attached_cluster = gke_multicloud_v1.AttachedCluster()
    attached_cluster.platform_version = "platform_version_value"
    attached_cluster.distribution = "distribution_value"
    attached_cluster.fleet.project = "project_value"

    request = gke_multicloud_v1.CreateAttachedClusterRequest(
        parent="parent_value",
        attached_cluster=attached_cluster,
        attached_cluster_id="attached_cluster_id_value",
    )

    # Make the request
    operation = client.create_attached_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.CreateAttachedClusterRequest, dict]

The request object. Request message for AttachedClusters.CreateAttachedCluster method.
parent str

Required. The parent location where this AttachedCluster resource will be created. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
attached_cluster google.cloud.gke_multicloud_v1.types.AttachedCluster

Required. The specification of the AttachedCluster to create. This corresponds to the attached_cluster field on the request instance; if request is provided, this should not be set.
attached_cluster_id str

Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AttachedCluster resource name formatted as projects/. Valid characters are /a-z][0-9]-/. Cannot be longer than 63 characters. This corresponds to the attached_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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AttachedCluster An Anthos cluster running on customer own infrastructure.

delete_attached_cluster

delete_attached_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.DeleteAttachedClusterRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a specific xref_AttachedCluster resource.

If successful, the response contains a newly created Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_delete_attached_cluster():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.DeleteAttachedClusterRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_attached_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.DeleteAttachedClusterRequest, dict]

The request object. Request message for AttachedClusters.DeleteAttachedCluster method.
name str

Required. The resource name the AttachedCluster to delete. AttachedCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud Platform resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.
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.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
AttachedClustersClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
AttachedClustersClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
AttachedClustersClient The constructed client.

generate_attached_cluster_agent_token

generate_attached_cluster_agent_token(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.GenerateAttachedClusterAgentTokenRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.gke_multicloud_v1.types.attached_service.GenerateAttachedClusterAgentTokenResponse
)

Generates an access token for a cluster agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_generate_attached_cluster_agent_token():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GenerateAttachedClusterAgentTokenRequest(
        attached_cluster="attached_cluster_value",
        subject_token="subject_token_value",
        subject_token_type="subject_token_type_value",
        version="version_value",
    )

    # Make the request
    response = client.generate_attached_cluster_agent_token(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GenerateAttachedClusterAgentTokenRequest, dict]

The request object.
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.

generate_attached_cluster_install_manifest

generate_attached_cluster_install_manifest(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.GenerateAttachedClusterInstallManifestRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    attached_cluster_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.gke_multicloud_v1.types.attached_service.GenerateAttachedClusterInstallManifestResponse
)

Generates the install manifest to be installed on the target cluster.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_generate_attached_cluster_install_manifest():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GenerateAttachedClusterInstallManifestRequest(
        parent="parent_value",
        attached_cluster_id="attached_cluster_id_value",
        platform_version="platform_version_value",
    )

    # Make the request
    response = client.generate_attached_cluster_install_manifest(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GenerateAttachedClusterInstallManifestRequest, dict]

The request object. Request message for AttachedClusters.GenerateAttachedClusterInstallManifest method.
parent str

Required. The parent location where this AttachedCluster resource will be created. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
attached_cluster_id str

Required. A client provided ID of the resource. Must be unique within the parent resource. The provided ID will be part of the AttachedCluster resource name formatted as projects/. Valid characters are /a-z][0-9]-/. Cannot be longer than 63 characters. When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id. Membership names are formatted as projects/. This corresponds to the attached_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
Type Description
google.cloud.gke_multicloud_v1.types.GenerateAttachedClusterInstallManifestResponse Response message for AttachedClusters.GenerateAttachedClusterInstallManifest method.

get_attached_cluster

get_attached_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.GetAttachedClusterRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.gke_multicloud_v1.types.attached_resources.AttachedCluster

Describes a specific xref_AttachedCluster resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_get_attached_cluster():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAttachedClusterRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_attached_cluster(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GetAttachedClusterRequest, dict]

The request object. Request message for AttachedClusters.GetAttachedCluster method.
name str

Required. The name of the AttachedCluster resource to describe. AttachedCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud Platform resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.gke_multicloud_v1.types.AttachedCluster An Anthos cluster running on customer own infrastructure.

get_attached_server_config

get_attached_server_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.GetAttachedServerConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.gke_multicloud_v1.types.attached_resources.AttachedServerConfig

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_get_attached_server_config():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAttachedServerConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_attached_server_config(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GetAttachedServerConfigRequest, dict]

The request object. GetAttachedServerConfigRequest gets the server config for attached clusters.
name str

Required. The name of the AttachedServerConfig resource to describe. AttachedServerConfig names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.gke_multicloud_v1.types.AttachedServerConfig AttachedServerConfig provides information about supported Kubernetes versions

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operations_pb2.Operation An Operation object.

import_attached_cluster

import_attached_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.ImportAttachedClusterRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    fleet_membership: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Imports creates a new xref_AttachedCluster resource by importing an existing Fleet Membership resource.

Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.

If successful, the response contains a newly created Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_import_attached_cluster():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.ImportAttachedClusterRequest(
        parent="parent_value",
        fleet_membership="fleet_membership_value",
        platform_version="platform_version_value",
        distribution="distribution_value",
    )

    # Make the request
    operation = client.import_attached_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.ImportAttachedClusterRequest, dict]

The request object. Request message for AttachedClusters.ImportAttachedCluster method.
parent str

Required. The parent location where this AttachedCluster resource will be created. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
fleet_membership str

Required. The name of the fleet membership resource to import. This corresponds to the fleet_membership 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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AttachedCluster An Anthos cluster running on customer own infrastructure.

list_attached_clusters

list_attached_clusters(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.ListAttachedClustersRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.gke_multicloud_v1.services.attached_clusters.pagers.ListAttachedClustersPager
)

Lists all xref_AttachedCluster resources on a given Google Cloud project and region.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_list_attached_clusters():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.ListAttachedClustersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_attached_clusters(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.ListAttachedClustersRequest, dict]

The request object. Request message for AttachedClusters.ListAttachedClusters method.
parent str

Required. The parent location which owns this collection of AttachedCluster resources. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud Platform resource names. 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
Type Description
google.cloud.gke_multicloud_v1.services.attached_clusters.pagers.ListAttachedClustersPager Response message for AttachedClusters.ListAttachedClusters method. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

parse_attached_cluster_path

parse_attached_cluster_path(path: str) -> typing.Dict[str, str]

Parses a attached_cluster path into its component segments.

parse_attached_server_config_path

parse_attached_server_config_path(path: str) -> typing.Dict[str, str]

Parses a attached_server_config path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

update_attached_cluster

update_attached_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.attached_service.UpdateAttachedClusterRequest,
            dict,
        ]
    ] = None,
    *,
    attached_cluster: typing.Optional[
        google.cloud.gke_multicloud_v1.types.attached_resources.AttachedCluster
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates an xref_AttachedCluster.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_update_attached_cluster():
    # Create a client
    client = gke_multicloud_v1.AttachedClustersClient()

    # Initialize request argument(s)
    attached_cluster = gke_multicloud_v1.AttachedCluster()
    attached_cluster.platform_version = "platform_version_value"
    attached_cluster.distribution = "distribution_value"
    attached_cluster.fleet.project = "project_value"

    request = gke_multicloud_v1.UpdateAttachedClusterRequest(
        attached_cluster=attached_cluster,
    )

    # Make the request
    operation = client.update_attached_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.UpdateAttachedClusterRequest, dict]

The request object. Request message for AttachedClusters.UpdateAttachedCluster method.
attached_cluster google.cloud.gke_multicloud_v1.types.AttachedCluster

Required. The AttachedCluster resource to update. This corresponds to the attached_cluster field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AttachedCluster: - annotations. - authorization.admin_groups. - authorization.admin_users. - binary_authorization.evaluation_mode. - description. - logging_config.component_config.enable_components. - monitoring_config.managed_prometheus_config.enabled. - platform_version. - proxy_config.kubernetes_secret.name. - proxy_config.kubernetes_secret.namespace. This corresponds to the update_mask 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
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AttachedCluster An Anthos cluster running on customer own infrastructure.