GkeHubClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport]] = None, 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 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
GkeHubClient
GkeHubClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport]] = None, 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 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 |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
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[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: 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]] = ())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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.CreateFeatureRequest, dict]
The request object. Request message for the |
parent |
str
Required. The parent (project and location) where the Feature will be created. Specified in the format |
resource |
google.cloud.gkehub_v1.types.Feature
The Feature resource to create. This corresponds to the |
feature_id |
str
The ID of the feature to create. 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.Operation | 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[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: 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.
# 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.CreateMembershipRequest, dict]
The request object. Request message for the |
parent |
str
Required. The parent (project and location) where the Memberships will be created. Specified in the format |
resource |
google.cloud.gkehub_v1.types.Membership
Required. The membership to create. This corresponds to the |
membership_id |
str
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.Operation | 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[Union[google.cloud.gkehub_v1.types.service.DeleteFeatureRequest, 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 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.DeleteFeatureRequest, dict]
The request object. Request message for |
name |
str
Required. The Feature 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.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_membership
delete_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.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.
# 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.DeleteMembershipRequest, dict]
The request object. Request message for |
name |
str
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.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
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 |
GkeHubClient | 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 |
GkeHubClient | 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 |
GkeHubClient | The constructed client. |
generate_connect_manifest
generate_connect_manifest(request: Optional[Union[google.cloud.gkehub_v1.types.service.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.
# 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.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_v1.types.GenerateConnectManifestResponse | GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent. |
get_feature
get_feature(request: Optional[Union[google.cloud.gkehub_v1.types.service.GetFeatureRequest, 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 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.GetFeatureRequest, dict]
The request object. Request message for |
name |
str
Required. The Feature 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_v1.types.Feature | Feature represents the settings and status of any Hub Feature. |
get_membership
get_membership(request: Optional[Union[google.cloud.gkehub_v1.types.service.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.
# 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.GetMembershipRequest, dict]
The request object. Request message for |
name |
str
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_v1.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. |
list_features
list_features(request: Optional[Union[google.cloud.gkehub_v1.types.service.ListFeaturesRequest, 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 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.ListFeaturesRequest, dict]
The request object. Request message for |
parent |
str
Required. The parent (project and location) where the Features 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_v1.services.gke_hub.pagers.ListFeaturesPager | 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[Union[google.cloud.gkehub_v1.types.service.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.
# 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.ListMembershipsRequest, dict]
The request object. Request message for |
parent |
str
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_v1.services.gke_hub.pagers.ListMembershipsPager | 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[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: 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 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.UpdateFeatureRequest, dict]
The request object. Request message for |
name |
str
Required. The Feature resource name in the format |
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 |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Mask of fields to update. 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.Operation | 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[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: 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.
# 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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.gkehub_v1.types.UpdateMembershipRequest, dict]
The request object. Request message for |
name |
str
Required. The Membership resource name in the format |
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 |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. Mask of fields to update. 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.Operation | An object representing a long-running operation. The result type for the operation will be Membership Membership contains information about a member cluster. |