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.

GkeHub

class google.cloud.gkehub_v1.services.gke_hub.GkeHubAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport, typing.Callable[[...], google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

  • [Membership][google.cloud.gkehub.v1.Membership]

  • [Feature][google.cloud.gkehub.v1.Feature]

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions.

Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

Instantiates the gke hub async client.

Parameters

  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Optional[Union[str,GkeHubTransport,Callable[..., GkeHubTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the GkeHubTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that 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.

Raises

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

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

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

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

async create_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.CreateFeatureRequest, dict]] = None, *, parent: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.feature.Feature] = None, feature_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Adds a new Feature.

# 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 gkehub_v1

async def sample_create_feature():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.CreateFeatureRequest(
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.CreateFeatureRequest, dict]]) – The request object. Request message for the GkeHub.CreateFeature method.

  • parent (str) –

    Required. The parent (project and location) where the Feature will be created. Specified in the format projects/*/locations/*.

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

  • resource (google.cloud.gkehub_v1.types.Feature) – The Feature resource to create. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

  • feature_id (str) – The ID of the feature to create. This corresponds to the feature_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gkehub_v1.types.Feature Feature represents the settings and status of any Hub Feature.

Return type

google.api_core.operation_async.AsyncOperation

async create_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.CreateMembershipRequest, dict]] = None, *, parent: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.membership.Membership] = None, membership_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Creates a new Membership.

This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.

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

async def sample_create_membership():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.CreateMembershipRequest(
        parent="parent_value",
        membership_id="membership_id_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.CreateMembershipRequest, dict]]) – The request object. Request message for the GkeHub.CreateMembership method.

  • parent (str) –

    Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.

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

  • resource (google.cloud.gkehub_v1.types.Membership) – Required. The membership to create. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

  • membership_id (str) –

    Required. Client chosen ID for the membership. membership_id must be a valid RFC 1123 compliant DNS label:

    1. At most 63 characters in length

    2. It must consist of lower case alphanumeric characters or -

    3. It must start and end with an alphanumeric character

    Which can be expressed as the regex: [a-z0-9]([-a-z0-9]*[a-z0-9])?, with a maximum length of 63 characters.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gkehub_v1.types.Membership Membership contains information about a member cluster.

Return type

google.api_core.operation_async.AsyncOperation

async delete_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.DeleteFeatureRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Removes a Feature.

# 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 gkehub_v1

async def sample_delete_feature():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.DeleteFeatureRequest(
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.DeleteFeatureRequest, dict]]) – The request object. Request message for GkeHub.DeleteFeature method.

  • name (str) –

    Required. The Feature resource name in the format projects/*/locations/*/features/*.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.DeleteMembershipRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Removes a Membership.

This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.

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

async def sample_delete_membership():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.DeleteMembershipRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.DeleteMembershipRequest, dict]]) – The request object. Request message for GkeHub.DeleteMembership method.

  • name (str) –

    Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

static feature_path(project: str, location: str, feature: str) → str

Returns a fully-qualified feature string.

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

file.

Parameters

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

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GkeHubAsyncClient

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

info.

Parameters

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

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GkeHubAsyncClient

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

file.

Parameters

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

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GkeHubAsyncClient

async generate_connect_manifest(request: Optional[Union[google.cloud.gkehub_v1.types.service.GenerateConnectManifestRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.types.service.GenerateConnectManifestResponse[source]

Generates the manifest for deployment of the GKE connect agent.

This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.

# 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 gkehub_v1

async def sample_generate_connect_manifest():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.GenerateConnectManifestRequest(
        name="name_value",
    )

    # Make the request
    response = await client.generate_connect_manifest(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.GenerateConnectManifestRequest, dict]]) – The request object. Request message for GkeHub.GenerateConnectManifest method. .

  • retry (google.api_core.retry_async.AsyncRetry) – 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

GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

Return type

google.cloud.gkehub_v1.types.GenerateConnectManifestResponse

async get_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.GetFeatureRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.types.feature.Feature[source]

Gets details of a single Feature.

# 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 gkehub_v1

async def sample_get_feature():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.GetFeatureRequest(
    )

    # Make the request
    response = await client.get_feature(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.GetFeatureRequest, dict]]) – The request object. Request message for GkeHub.GetFeature method.

  • name (str) –

    Required. The Feature resource name in the format projects/*/locations/*/features/*

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Feature represents the settings and status of any Hub Feature.

Return type

google.cloud.gkehub_v1.types.Feature

async get_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.GetMembershipRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.types.membership.Membership[source]

Gets the details of a Membership.

# 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 gkehub_v1

async def sample_get_membership():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.GetMembershipRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_membership(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.GetMembershipRequest, dict]]) – The request object. Request message for GkeHub.GetMembership method.

  • name (str) –

    Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Membership contains information about a member cluster.

Return type

google.cloud.gkehub_v1.types.Membership

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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.

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport]

Returns an appropriate transport class.

Parameters

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

Returns

The transport class to use.

async list_features(request: Optional[Union[google.cloud.gkehub_v1.types.service.ListFeaturesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.services.gke_hub.pagers.ListFeaturesAsyncPager[source]

Lists Features in a given project and 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 gkehub_v1

async def sample_list_features():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.ListFeaturesRequest(
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.ListFeaturesRequest, dict]]) – The request object. Request message for GkeHub.ListFeatures method.

  • parent (str) –

    Required. The parent (project and location) where the Features will be listed. Specified in the format projects/*/locations/*.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for the GkeHub.ListFeatures method.

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

Return type

google.cloud.gkehub_v1.services.gke_hub.pagers.ListFeaturesAsyncPager

async list_memberships(request: Optional[Union[google.cloud.gkehub_v1.types.service.ListMembershipsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipsAsyncPager[source]

Lists Memberships in a given project and 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 gkehub_v1

async def sample_list_memberships():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.ListMembershipsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.ListMembershipsRequest, dict]]) – The request object. Request message for GkeHub.ListMemberships method.

  • parent (str) –

    Required. The parent (project and location) where the Memberships will be listed. Specified in the format projects/*/locations/*. projects/*/locations/- list memberships in all the regions.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for the GkeHub.ListMemberships method.

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

Return type

google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipsAsyncPager

static membership_path(project: str, location: str, membership: str) → str

Returns a fully-qualified membership string.

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

Parse a billing_account path into its component segments.

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

Parse a folder path into its component segments.

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

Parse a location path into its component segments.

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

Parse a organization path into its component segments.

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

Parse a project path into its component segments.

static parse_feature_path(path: str) → Dict[str, str]

Parses a feature path into its component segments.

static parse_membership_path(path: str) → Dict[str, str]

Parses a membership path into its component segments.

property transport: google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

GkeHubTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async update_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.UpdateFeatureRequest, dict]] = None, *, name: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.feature.Feature] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Updates an existing Feature.

# 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 gkehub_v1

async def sample_update_feature():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.UpdateFeatureRequest(
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.UpdateFeatureRequest, dict]]) – The request object. Request message for GkeHub.UpdateFeature method.

  • name (str) –

    Required. The Feature resource name in the format projects/*/locations/*/features/*.

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

  • resource (google.cloud.gkehub_v1.types.Feature) –

    Only fields specified in update_mask are updated. If you specify a field in the update_mask but don’t specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It’s not possible to update a key’s value to the empty string. If you specify the update_mask to be a special path “*”, fully replaces all user-modifiable fields to match resource.

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

  • update_mask (google.protobuf.field_mask_pb2.FieldMask) – Mask of fields to update. 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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gkehub_v1.types.Feature Feature represents the settings and status of any Hub Feature.

Return type

google.api_core.operation_async.AsyncOperation

async update_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.UpdateMembershipRequest, dict]] = None, *, name: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.membership.Membership] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Updates an existing Membership.

# 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 gkehub_v1

async def sample_update_membership():
    # Create a client
    client = gkehub_v1.GkeHubAsyncClient()

    # Initialize request argument(s)
    request = gkehub_v1.UpdateMembershipRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gkehub_v1.types.UpdateMembershipRequest, dict]]) – The request object. Request message for GkeHub.UpdateMembership method.

  • name (str) –

    Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

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

  • resource (google.cloud.gkehub_v1.types.Membership) –

    Required. Only fields specified in update_mask are updated. If you specify a field in the update_mask but don’t specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It’s not possible to update a key’s value to the empty string. If you specify the update_mask to be a special path “*”, fully replaces all user-modifiable fields to match resource.

    This corresponds to the resource 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. 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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gkehub_v1.types.Membership Membership contains information about a member cluster.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.gkehub_v1.services.gke_hub.GkeHubClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport, typing.Callable[[...], google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport]]] = 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>)[source]

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

  • [Membership][google.cloud.gkehub.v1.Membership]

  • [Feature][google.cloud.gkehub.v1.Feature]

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions.

Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

Instantiates the gke hub client.

Parameters

  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Optional[Union[str,GkeHubTransport,Callable[..., GkeHubTransport]]]) – 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 GkeHubTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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

Raises

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

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

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

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

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

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

create_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.CreateFeatureRequest, dict]] = None, *, parent: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.feature.Feature] = None, feature_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Adds a new Feature.

# 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 gkehub_v1

def sample_create_feature():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.CreateFeatureRequest(
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.CreateFeatureRequest, dict]) – The request object. Request message for the GkeHub.CreateFeature method.

  • parent (str) –

    Required. The parent (project and location) where the Feature will be created. Specified in the format projects/*/locations/*.

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

  • resource (google.cloud.gkehub_v1.types.Feature) – The Feature resource to create. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

  • feature_id (str) – The ID of the feature to create. This corresponds to the feature_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gkehub_v1.types.Feature Feature represents the settings and status of any Hub Feature.

Return type

google.api_core.operation.Operation

create_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.CreateMembershipRequest, dict]] = None, *, parent: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.membership.Membership] = None, membership_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Creates a new Membership.

This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.

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

def sample_create_membership():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.CreateMembershipRequest(
        parent="parent_value",
        membership_id="membership_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.CreateMembershipRequest, dict]) – The request object. Request message for the GkeHub.CreateMembership method.

  • parent (str) –

    Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.

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

  • resource (google.cloud.gkehub_v1.types.Membership) – Required. The membership to create. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

  • membership_id (str) –

    Required. Client chosen ID for the membership. membership_id must be a valid RFC 1123 compliant DNS label:

    1. At most 63 characters in length

    2. It must consist of lower case alphanumeric characters or -

    3. It must start and end with an alphanumeric character

    Which can be expressed as the regex: [a-z0-9]([-a-z0-9]*[a-z0-9])?, with a maximum length of 63 characters.

    This corresponds to the membership_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gkehub_v1.types.Membership Membership contains information about a member cluster.

Return type

google.api_core.operation.Operation

delete_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.DeleteFeatureRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Removes a Feature.

# 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 gkehub_v1

def sample_delete_feature():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.DeleteFeatureRequest(
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.DeleteFeatureRequest, dict]) – The request object. Request message for GkeHub.DeleteFeature method.

  • name (str) –

    Required. The Feature resource name in the format projects/*/locations/*/features/*.

    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

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);

}

Return type

google.api_core.operation.Operation

delete_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.DeleteMembershipRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Removes a Membership.

This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.

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

def sample_delete_membership():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.DeleteMembershipRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.DeleteMembershipRequest, dict]) – The request object. Request message for GkeHub.DeleteMembership method.

  • name (str) –

    Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

    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

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);

}

Return type

google.api_core.operation.Operation

static feature_path(project: str, location: str, feature: str) → str[source]

Returns a fully-qualified feature string.

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

file.

Parameters

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

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GkeHubClient

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

info.

Parameters

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

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GkeHubClient

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

file.

Parameters

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

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GkeHubClient

generate_connect_manifest(request: Optional[Union[google.cloud.gkehub_v1.types.service.GenerateConnectManifestRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.types.service.GenerateConnectManifestResponse[source]

Generates the manifest for deployment of the GKE connect agent.

This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.

# 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 gkehub_v1

def sample_generate_connect_manifest():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.GenerateConnectManifestRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Returns

GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

Return type

google.cloud.gkehub_v1.types.GenerateConnectManifestResponse

get_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.GetFeatureRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.types.feature.Feature[source]

Gets details of a single Feature.

# 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 gkehub_v1

def sample_get_feature():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.GetFeatureRequest(
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.GetFeatureRequest, dict]) – The request object. Request message for GkeHub.GetFeature method.

  • name (str) –

    Required. The Feature resource name in the format projects/*/locations/*/features/*

    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

Feature represents the settings and status of any Hub Feature.

Return type

google.cloud.gkehub_v1.types.Feature

get_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.GetMembershipRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.types.membership.Membership[source]

Gets the details of a Membership.

# 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 gkehub_v1

def sample_get_membership():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.GetMembershipRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.GetMembershipRequest, dict]) – The request object. Request message for GkeHub.GetMembership method.

  • name (str) –

    Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

    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

Membership contains information about a member cluster.

Return type

google.cloud.gkehub_v1.types.Membership

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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.

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

list_features(request: Optional[Union[google.cloud.gkehub_v1.types.service.ListFeaturesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.services.gke_hub.pagers.ListFeaturesPager[source]

Lists Features in a given project and 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 gkehub_v1

def sample_list_features():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.ListFeaturesRequest(
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.ListFeaturesRequest, dict]) – The request object. Request message for GkeHub.ListFeatures method.

  • parent (str) –

    Required. The parent (project and location) where the Features will be listed. Specified in the format projects/*/locations/*.

    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

Response message for the GkeHub.ListFeatures method.

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

Return type

google.cloud.gkehub_v1.services.gke_hub.pagers.ListFeaturesPager

list_memberships(request: Optional[Union[google.cloud.gkehub_v1.types.service.ListMembershipsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipsPager[source]

Lists Memberships in a given project and 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 gkehub_v1

def sample_list_memberships():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.ListMembershipsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.ListMembershipsRequest, dict]) – The request object. Request message for GkeHub.ListMemberships method.

  • parent (str) –

    Required. The parent (project and location) where the Memberships will be listed. Specified in the format projects/*/locations/*. projects/*/locations/- list memberships in all the regions.

    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

Response message for the GkeHub.ListMemberships method.

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

Return type

google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipsPager

static membership_path(project: str, location: str, membership: str) → str[source]

Returns a fully-qualified membership string.

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

Parse a billing_account path into its component segments.

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

Parse a folder path into its component segments.

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

Parse a location path into its component segments.

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

Parse a organization path into its component segments.

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

Parse a project path into its component segments.

static parse_feature_path(path: str) → Dict[str, str][source]

Parses a feature path into its component segments.

static parse_membership_path(path: str) → Dict[str, str][source]

Parses a membership path into its component segments.

property transport: google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

GkeHubTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

update_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.UpdateFeatureRequest, dict]] = None, *, name: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.feature.Feature] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Updates an existing Feature.

# 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 gkehub_v1

def sample_update_feature():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.UpdateFeatureRequest(
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.UpdateFeatureRequest, dict]) – The request object. Request message for GkeHub.UpdateFeature method.

  • name (str) –

    Required. The Feature resource name in the format projects/*/locations/*/features/*.

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

  • resource (google.cloud.gkehub_v1.types.Feature) –

    Only fields specified in update_mask are updated. If you specify a field in the update_mask but don’t specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It’s not possible to update a key’s value to the empty string. If you specify the update_mask to be a special path “*”, fully replaces all user-modifiable fields to match resource.

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

  • update_mask (google.protobuf.field_mask_pb2.FieldMask) – Mask of fields to update. 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gkehub_v1.types.Feature Feature represents the settings and status of any Hub Feature.

Return type

google.api_core.operation.Operation

update_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.UpdateMembershipRequest, dict]] = None, *, name: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.membership.Membership] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Updates an existing Membership.

# 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 gkehub_v1

def sample_update_membership():
    # Create a client
    client = gkehub_v1.GkeHubClient()

    # Initialize request argument(s)
    request = gkehub_v1.UpdateMembershipRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gkehub_v1.types.UpdateMembershipRequest, dict]) – The request object. Request message for GkeHub.UpdateMembership method.

  • name (str) –

    Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

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

  • resource (google.cloud.gkehub_v1.types.Membership) –

    Required. Only fields specified in update_mask are updated. If you specify a field in the update_mask but don’t specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It’s not possible to update a key’s value to the empty string. If you specify the update_mask to be a special path “*”, fully replaces all user-modifiable fields to match resource.

    This corresponds to the resource 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. 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gkehub_v1.types.Membership Membership contains information about a member cluster.

Return type

google.api_core.operation.Operation

class google.cloud.gkehub_v1.services.gke_hub.pagers.ListFeaturesAsyncPager(method: Callable[[...], Awaitable[google.cloud.gkehub_v1.types.service.ListFeaturesResponse]], request: google.cloud.gkehub_v1.types.service.ListFeaturesRequest, response: google.cloud.gkehub_v1.types.service.ListFeaturesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_features requests.

This class thinly wraps an initial google.cloud.gkehub_v1.types.ListFeaturesResponse object, and provides an __aiter__ method to iterate through its resources field.

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

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

Instantiates the pager.

Parameters
class google.cloud.gkehub_v1.services.gke_hub.pagers.ListFeaturesPager(method: Callable[[...], google.cloud.gkehub_v1.types.service.ListFeaturesResponse], request: google.cloud.gkehub_v1.types.service.ListFeaturesRequest, response: google.cloud.gkehub_v1.types.service.ListFeaturesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_features requests.

This class thinly wraps an initial google.cloud.gkehub_v1.types.ListFeaturesResponse object, and provides an __iter__ method to iterate through its resources field.

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

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

Instantiate the pager.

Parameters
class google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipsAsyncPager(method: Callable[[...], Awaitable[google.cloud.gkehub_v1.types.service.ListMembershipsResponse]], request: google.cloud.gkehub_v1.types.service.ListMembershipsRequest, response: google.cloud.gkehub_v1.types.service.ListMembershipsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_memberships requests.

This class thinly wraps an initial google.cloud.gkehub_v1.types.ListMembershipsResponse object, and provides an __aiter__ method to iterate through its resources field.

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

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

Instantiates the pager.

Parameters
class google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipsPager(method: Callable[[...], google.cloud.gkehub_v1.types.service.ListMembershipsResponse], request: google.cloud.gkehub_v1.types.service.ListMembershipsRequest, response: google.cloud.gkehub_v1.types.service.ListMembershipsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_memberships requests.

This class thinly wraps an initial google.cloud.gkehub_v1.types.ListMembershipsResponse object, and provides an __iter__ method to iterate through its resources field.

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

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

Instantiate the pager.

Parameters