Class GkeHubAsyncClient (1.0.0)

GkeHubAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-gke-hub/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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
Feature

GKE Hub is currently only available in the global region.

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.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`GkeHubTransport`	The transport used by the client instance.

Methods

GkeHubAsyncClient

GkeHubAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-gke-hub/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the gke hub 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`	`Union[str, .GkeHubTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_feature

create_feature(request: Optional[google.cloud.gkehub_v1.types.service.CreateFeatureRequest] = None, *, parent: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.feature.Feature] = None, feature_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds a new Feature.

Parameters
Name	Description
`request`	`CreateFeatureRequest` The request object. Request message for the `GkeHub.CreateFeature` method.
`parent`	`str` 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`	`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
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Feature Feature represents the settings and status of any Hub Feature.

create_membership

create_membership(request: Optional[google.cloud.gkehub_v1.types.service.CreateMembershipRequest] = None, *, parent: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1.types.membership.Membership] = None, membership_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
`request`	`CreateMembershipRequest` 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`	`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?`, 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
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Membership Membership contains information about a member cluster.

delete_feature

delete_feature(request: Optional[google.cloud.gkehub_v1.types.service.DeleteFeatureRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Removes a Feature.

Parameters
Name	Description
`request`	`DeleteFeatureRequest` The request object. Request message for `GkeHub.DeleteFeature` method.
`name`	`str` 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

Type Description

google.api_core.operation_async.AsyncOperation 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); } The JSON representation for Empty is empty JSON object {}.

delete_membership

delete_membership(request: Optional[google.cloud.gkehub_v1.types.service.DeleteMembershipRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
`request`	`DeleteMembershipRequest` 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

Type Description

feature_path

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

Returns a fully-qualified feature string.

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
`GkeHubAsyncClient`	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
`GkeHubAsyncClient`	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
`GkeHubAsyncClient`	The constructed client.

generate_connect_manifest

generate_connect_manifest(request: Optional[google.cloud.gkehub_v1.types.service.GenerateConnectManifestRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
`request`	`GenerateConnectManifestRequest` The request object. Request message for `GkeHub.GenerateConnectManifest` 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
`google.cloud.gkehub_v1.types.GenerateConnectManifestResponse`	GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

get_feature

get_feature(request: Optional[google.cloud.gkehub_v1.types.service.GetFeatureRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Feature.

Parameters
Name	Description
`request`	`GetFeatureRequest` The request object. Request message for `GkeHub.GetFeature` method.
`name`	`str` 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
Type	Description
`google.cloud.gkehub_v1.types.Feature`	Feature represents the settings and status of any Hub Feature.

get_membership

get_membership(request: Optional[google.cloud.gkehub_v1.types.service.GetMembershipRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the details of a Membership.

Parameters
Name	Description
`request`	`GetMembershipRequest` 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
Type	Description
`google.cloud.gkehub_v1.types.Membership`	Membership contains information about a member cluster.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_features

list_features(request: Optional[google.cloud.gkehub_v1.types.service.ListFeaturesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Features in a given project and location.

Parameters
Name	Description
`request`	`ListFeaturesRequest` The request object. Request message for `GkeHub.ListFeatures` method.
`parent`	`str` 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
Type	Description
`google.cloud.gkehub_v1.services.gke_hub.pagers.ListFeaturesAsyncPager`	Response message for the GkeHub.ListFeatures method. Iterating over this object will yield results and resolve additional pages automatically.

list_memberships

list_memberships(request: Optional[google.cloud.gkehub_v1.types.service.ListMembershipsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Memberships in a given project and location.

Parameters
Name	Description
`request`	`ListMembershipsRequest` 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/`. 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.gkehub_v1.services.gke_hub.pagers.ListMembershipsAsyncPager`	Response message for the GkeHub.ListMemberships method. Iterating over this object will yield results and resolve additional pages automatically.

membership_path

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

Returns a fully-qualified membership string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_feature_path

parse_feature_path(path: str)

Parses a feature path into its component segments.

parse_membership_path

parse_membership_path(path: str)

Parses a membership path into its component segments.

update_feature

update_feature(request: Optional[google.cloud.gkehub_v1.types.service.UpdateFeatureRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing Feature.

Parameters
Name	Description
`request`	`UpdateFeatureRequest` The request object. Request message for `GkeHub.UpdateFeature` method.
`name`	`str` 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`	`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
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Feature Feature represents the settings and status of any Hub Feature.

update_membership

update_membership(request: Optional[google.cloud.gkehub_v1.types.service.UpdateMembershipRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing Membership.

Parameters
Name	Description
`request`	`UpdateMembershipRequest` 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`	`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
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Membership Membership contains information about a member cluster.