Class GkeHubMembershipServiceAsyncClient (0.1.2)

GkeHubMembershipServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gkehub_v1beta1.services.gke_hub_membership_service.transports.base.GkeHubMembershipServiceTransport] = '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>)

GKE Hub CRUD API for the Membership resource. The Membership service is currently only available in the global location.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
GkeHubMembershipServiceTransportThe transport used by the client instance.

Methods

GkeHubMembershipServiceAsyncClient

GkeHubMembershipServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gkehub_v1beta1.services.gke_hub_membership_service.transports.base.GkeHubMembershipServiceTransport] = '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 membership service client.

Parameters
NameDescription
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, .GkeHubMembershipServiceTransport]

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
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf 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_membership

create_membership(request: Optional[google.cloud.gkehub_v1beta1.types.membership.CreateMembershipRequest] = None, *, parent: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1beta1.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]] = ())

Adds a new Membership.

Parameters
NameDescription
request CreateMembershipRequest

The request object. Request message for the GkeHubMembershipService.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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Membership Membership contains information about a member cluster.

delete_membership

delete_membership(request: Optional[google.cloud.gkehub_v1beta1.types.membership.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.

Parameters
NameDescription
request DeleteMembershipRequest

The request object. Request message for GkeHubMembershipService.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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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 {}.

from_service_account_file

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
GkeHubMembershipServiceAsyncClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
GkeHubMembershipServiceAsyncClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
GkeHubMembershipServiceAsyncClientThe constructed client.

generate_connect_manifest

generate_connect_manifest(request: Optional[google.cloud.gkehub_v1beta1.types.membership.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.

Parameters
NameDescription
request GenerateConnectManifestRequest

The request object. Request message for GkeHubMembershipService.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
TypeDescription
google.cloud.gkehub_v1beta1.types.GenerateConnectManifestResponseGenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

generate_exclusivity_manifest

generate_exclusivity_manifest(request: Optional[google.cloud.gkehub_v1beta1.types.membership.GenerateExclusivityManifestRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed. Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.

The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.

Parameters
NameDescription
request GenerateExclusivityManifestRequest

The request object. The request to generate the manifests for exclusivity artifacts.

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
TypeDescription
google.cloud.gkehub_v1beta1.types.GenerateExclusivityManifestResponseThe response of the exclusivity artifacts manifests for the client to apply.

get_membership

get_membership(request: Optional[google.cloud.gkehub_v1beta1.types.membership.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
NameDescription
request GetMembershipRequest

The request object. Request message for GkeHubMembershipService.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
TypeDescription
google.cloud.gkehub_v1beta1.types.MembershipMembership contains information about a member cluster.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_memberships

list_memberships(request: Optional[google.cloud.gkehub_v1beta1.types.membership.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
NameDescription
request ListMembershipsRequest

The request object. Request message for GkeHubMembershipService.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
TypeDescription
google.cloud.gkehub_v1beta1.services.gke_hub_membership_service.pagers.ListMembershipsAsyncPagerResponse message for the GkeHubMembershipService.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_membership_path

parse_membership_path(path: str)

Parses a membership path into its component segments.

update_membership

update_membership(request: Optional[google.cloud.gkehub_v1beta1.types.membership.UpdateMembershipRequest] = None, *, name: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1beta1.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
NameDescription
request UpdateMembershipRequest

The request object. Request message for GkeHubMembershipService.UpdateMembership method.

name str

Required. The membership resource name in the format: projects/[project_id]/locations/global/memberships/[membership_id] 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. 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. At least one field path must be specified in this mask. 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Membership Membership contains information about a member cluster.

validate_exclusivity

validate_exclusivity(request: Optional[google.cloud.gkehub_v1beta1.types.membership.ValidateExclusivityRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

Parameters
NameDescription
request ValidateExclusivityRequest

The request object. The request to validate the existing state of the membership CR in the cluster.

retry google.api_core.retry.Retry

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

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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

Returns
TypeDescription
google.cloud.gkehub_v1beta1.types.ValidateExclusivityResponseThe response of exclusivity artifacts validation result status.