GkeHubMembershipServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.gkehub_v1beta1.services.gke_hub_membership_service.transports.base.GkeHubMembershipServiceTransport] = 'grpc_asyncio', client_options: 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>)The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.
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 |
GkeHubMembershipServiceTransport | The transport used by the client instance. |
Methods
GkeHubMembershipServiceAsyncClient
GkeHubMembershipServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.gkehub_v1beta1.services.gke_hub_membership_service.transports.base.GkeHubMembershipServiceTransport] = 'grpc_asyncio', client_options: 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>)Instantiates the gke hub membership service 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,
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 |
| 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_membership
create_membership(request: Optional[Union[google.cloud.gkehub_v1beta1.types.membership.CreateMembershipRequest, dict]] = None, *, parent: Optional[str] = None, resource: Optional[google.cloud.gkehub_v1beta1.types.membership.Membership] = None, membership_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import gkehub_v1beta1
async def sample_create_membership():
# Create a client
client = gkehub_v1beta1.GkeHubMembershipServiceAsyncClient()
# Initialize request argument(s)
request = gkehub_v1beta1.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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1beta1.types.CreateMembershipRequest, dict]
The request object. Request message for the |
parent |
Required. The parent (project and location) where the Memberships will be created. Specified in the format |
resource |
Membership
Required. The membership to create. This corresponds to the |
membership_id |
Required. Client chosen ID for the membership. |
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_membership
delete_membership(request: Optional[Union[google.cloud.gkehub_v1beta1.types.membership.DeleteMembershipRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import gkehub_v1beta1
async def sample_delete_membership():
# Create a client
client = gkehub_v1beta1.GkeHubMembershipServiceAsyncClient()
# Initialize request argument(s)
request = gkehub_v1beta1.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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1beta1.types.DeleteMembershipRequest, dict]
The request object. Request message for |
name |
Required. The Membership resource name in the format |
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 {}. |
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 |
GkeHubMembershipServiceAsyncClient | 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 |
GkeHubMembershipServiceAsyncClient | 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 |
GkeHubMembershipServiceAsyncClient | The constructed client. |
generate_connect_manifest
generate_connect_manifest(request: Optional[Union[google.cloud.gkehub_v1beta1.types.membership.GenerateConnectManifestRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import gkehub_v1beta1
async def sample_generate_connect_manifest():
# Create a client
client = gkehub_v1beta1.GkeHubMembershipServiceAsyncClient()
# Initialize request argument(s)
request = gkehub_v1beta1.GenerateConnectManifestRequest(
name="name_value",
)
# Make the request
response = await client.generate_connect_manifest(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1beta1.types.GenerateConnectManifestRequest, dict]
The request object. Request message for |
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_v1beta1.types.GenerateConnectManifestResponse | GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent. |
generate_exclusivity_manifest
generate_exclusivity_manifest(request: Optional[Union[google.cloud.gkehub_v1beta1.types.membership.GenerateExclusivityManifestRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import gkehub_v1beta1
async def sample_generate_exclusivity_manifest():
# Create a client
client = gkehub_v1beta1.GkeHubMembershipServiceAsyncClient()
# Initialize request argument(s)
request = gkehub_v1beta1.GenerateExclusivityManifestRequest(
name="name_value",
)
# Make the request
response = await client.generate_exclusivity_manifest(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1beta1.types.GenerateExclusivityManifestRequest, dict]
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 | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1beta1.types.GenerateExclusivityManifestResponse | The response of the exclusivity artifacts manifests for the client to apply. |
get_membership
get_membership(request: Optional[Union[google.cloud.gkehub_v1beta1.types.membership.GetMembershipRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the details of a Membership.
from google.cloud import gkehub_v1beta1
async def sample_get_membership():
# Create a client
client = gkehub_v1beta1.GkeHubMembershipServiceAsyncClient()
# Initialize request argument(s)
request = gkehub_v1beta1.GetMembershipRequest(
name="name_value",
)
# Make the request
response = await client.get_membership(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1beta1.types.GetMembershipRequest, dict]
The request object. Request message for |
name |
Required. The Membership resource name in the format |
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_v1beta1.types.Membership | Membership contains information about a member cluster. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)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 variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()Returns an appropriate transport class.
list_memberships
list_memberships(request: Optional[Union[google.cloud.gkehub_v1beta1.types.membership.ListMembershipsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists Memberships in a given project and location.
from google.cloud import gkehub_v1beta1
async def sample_list_memberships():
# Create a client
client = gkehub_v1beta1.GkeHubMembershipServiceAsyncClient()
# Initialize request argument(s)
request = gkehub_v1beta1.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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1beta1.types.ListMembershipsRequest, dict]
The request object. Request message for |
parent |
Required. The parent (project and location) where the Memberships will be listed. Specified in the format |
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_v1beta1.services.gke_hub_membership_service.pagers.ListMembershipsAsyncPager | Response 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[Union[google.cloud.gkehub_v1beta1.types.membership.UpdateMembershipRequest, dict]] = 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates an existing Membership.
from google.cloud import gkehub_v1beta1
async def sample_update_membership():
# Create a client
client = gkehub_v1beta1.GkeHubMembershipServiceAsyncClient()
# Initialize request argument(s)
request = gkehub_v1beta1.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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1beta1.types.UpdateMembershipRequest, dict]
The request object. Request message for |
name |
Required. The membership resource name in the format: |
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 |
update_mask |
Required. Mask of fields to update. At least one field path must be specified in this mask. This corresponds to the |
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. |
validate_exclusivity
validate_exclusivity(request: Optional[Union[google.cloud.gkehub_v1beta1.types.membership.ValidateExclusivityRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import gkehub_v1beta1
async def sample_validate_exclusivity():
# Create a client
client = gkehub_v1beta1.GkeHubMembershipServiceAsyncClient()
# Initialize request argument(s)
request = gkehub_v1beta1.ValidateExclusivityRequest(
parent="parent_value",
intended_membership="intended_membership_value",
)
# Make the request
response = await client.validate_exclusivity(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1beta1.types.ValidateExclusivityRequest, dict]
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 | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1beta1.types.ValidateExclusivityResponse | The response of exclusivity artifacts validation result status. |