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
)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 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.
Properties
api_endpoint
Return the API endpoint used by the client instance.
| Returns | |
|---|---|
| Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
GkeHubTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
| Returns | |
|---|---|
| Type | Description |
str |
The universe domain used by the client instance. |
Methods
GkeHubAsyncClient
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
)Instantiates the gke hub async 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 |
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 |
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. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
create_feature
create_feature(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.CreateFeatureRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
resource: typing.Optional[google.cloud.gkehub_v1.types.feature.Feature] = None,
feature_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationAdds 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.CreateFeatureRequest, dict]]
The request object. Request message for the |
parent |
Required. The parent (project and location) where the Feature will be created. Specified in the format |
resource |
Feature
The Feature resource to create. This corresponds to the |
feature_id |
The ID of the feature to create. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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 Fleet Feature. |
create_fleet
create_fleet(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.CreateFleetRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
fleet: typing.Optional[google.cloud.gkehub_v1.types.fleet.Fleet] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates a fleet.
# 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_fleet():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.CreateFleetRequest(
parent="parent_value",
)
# Make the request
operation = client.create_fleet(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.CreateFleetRequest, dict]]
The request object. Request message for the |
parent |
Required. The parent (project and location) where the Fleet will be created. Specified in the format |
fleet |
Fleet
Required. The fleet to create. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Fleet Fleet contains the Fleet-wide metadata and configuration. |
create_membership
create_membership(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.CreateMembershipRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
resource: typing.Optional[
google.cloud.gkehub_v1.types.membership.Membership
] = None,
membership_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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. |
create_membership_binding
create_membership_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.CreateMembershipBindingRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
membership_binding: typing.Optional[
google.cloud.gkehub_v1.types.fleet.MembershipBinding
] = None,
membership_binding_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates a MembershipBinding.
# 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_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
membership_binding = gkehub_v1.MembershipBinding()
membership_binding.scope = "scope_value"
request = gkehub_v1.CreateMembershipBindingRequest(
parent="parent_value",
membership_binding=membership_binding,
membership_binding_id="membership_binding_id_value",
)
# Make the request
operation = client.create_membership_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.CreateMembershipBindingRequest, dict]]
The request object. Request to create a MembershipBinding. |
parent |
Required. The parent (project and location) where the MembershipBinding will be created. Specified in the format |
membership_binding |
MembershipBinding
Required. The MembershipBinding to create. This corresponds to the |
membership_binding_id |
Required. The ID to use for the MembershipBinding. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be MembershipBinding MembershipBinding is a subresource of a Membership, representing what Fleet Scopes (or other, future Fleet resources) a Membership is bound to. |
create_membership_rbac_role_binding
create_membership_rbac_role_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.CreateMembershipRBACRoleBindingRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
rbacrolebinding: typing.Optional[
google.cloud.gkehub_v1.types.fleet.RBACRoleBinding
] = None,
rbacrolebinding_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates a Membership RBACRoleBinding.
# 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_rbac_role_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
rbacrolebinding = gkehub_v1.RBACRoleBinding()
rbacrolebinding.user = "user_value"
request = gkehub_v1.CreateMembershipRBACRoleBindingRequest(
parent="parent_value",
rbacrolebinding_id="rbacrolebinding_id_value",
rbacrolebinding=rbacrolebinding,
)
# Make the request
operation = client.create_membership_rbac_role_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.CreateMembershipRBACRoleBindingRequest, dict]]
The request object. Request to create a rbacrolebindings. |
parent |
Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format |
rbacrolebinding |
RBACRoleBinding
Required. The rbacrolebindings to create. This corresponds to the |
rbacrolebinding_id |
Required. Client chosen ID for the RBACRoleBinding. |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be RBACRoleBinding RBACRoleBinding represents a rbacrolebinding across the Fleet |
create_scope
create_scope(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.CreateScopeRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
scope: typing.Optional[google.cloud.gkehub_v1.types.fleet.Scope] = None,
scope_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates a Scope.
# 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_scope():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.CreateScopeRequest(
parent="parent_value",
scope_id="scope_id_value",
)
# Make the request
operation = client.create_scope(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.CreateScopeRequest, dict]]
The request object. Request to create a Scope. |
parent |
Required. The parent (project and location) where the Scope will be created. Specified in the format |
scope |
Scope
Required. The Scope to create. This corresponds to the |
scope_id |
Required. Client chosen ID for the Scope. |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Scope Scope represents a Scope in a Fleet. |
create_scope_namespace
create_scope_namespace(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.CreateScopeNamespaceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
scope_namespace: typing.Optional[
google.cloud.gkehub_v1.types.fleet.Namespace
] = None,
scope_namespace_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates a fleet namespace.
# 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_scope_namespace():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
scope_namespace = gkehub_v1.Namespace()
scope_namespace.scope = "scope_value"
request = gkehub_v1.CreateScopeNamespaceRequest(
parent="parent_value",
scope_namespace_id="scope_namespace_id_value",
scope_namespace=scope_namespace,
)
# Make the request
operation = client.create_scope_namespace(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.CreateScopeNamespaceRequest, dict]]
The request object. Request to create a fleet namespace. |
parent |
Required. The parent (project and location) where the Namespace will be created. Specified in the format |
scope_namespace |
Namespace
Required. The fleet namespace to create. This corresponds to the |
scope_namespace_id |
Required. Client chosen ID for the Namespace. |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Namespace Namespace represents a namespace across the Fleet |
create_scope_rbac_role_binding
create_scope_rbac_role_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.CreateScopeRBACRoleBindingRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
rbacrolebinding: typing.Optional[
google.cloud.gkehub_v1.types.fleet.RBACRoleBinding
] = None,
rbacrolebinding_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates a Scope RBACRoleBinding.
# 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_scope_rbac_role_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
rbacrolebinding = gkehub_v1.RBACRoleBinding()
rbacrolebinding.user = "user_value"
request = gkehub_v1.CreateScopeRBACRoleBindingRequest(
parent="parent_value",
rbacrolebinding_id="rbacrolebinding_id_value",
rbacrolebinding=rbacrolebinding,
)
# Make the request
operation = client.create_scope_rbac_role_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.CreateScopeRBACRoleBindingRequest, dict]]
The request object. Request to create a rbacrolebindings. |
parent |
Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format |
rbacrolebinding |
RBACRoleBinding
Required. The rbacrolebindings to create. This corresponds to the |
rbacrolebinding_id |
Required. Client chosen ID for the RBACRoleBinding. |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be RBACRoleBinding RBACRoleBinding represents a rbacrolebinding across the Fleet |
delete_feature
delete_feature(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.DeleteFeatureRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationRemoves 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.DeleteFeatureRequest, dict]]
The request object. Request message for |
name |
Required. The Feature resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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); } |
delete_fleet
delete_fleet(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.DeleteFleetRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationRemoves a Fleet. There must be no memberships remaining in the Fleet.
# 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_fleet():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.DeleteFleetRequest(
name="name_value",
)
# Make the request
operation = client.delete_fleet(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.DeleteFleetRequest, dict]]
The request object. Request message for |
name |
Required. The Fleet resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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); } |
delete_membership
delete_membership(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.DeleteMembershipRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationRemoves 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.DeleteMembershipRequest, dict]]
The request object. Request message for |
name |
Required. The Membership resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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); } |
delete_membership_binding
delete_membership_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.DeleteMembershipBindingRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationDeletes a MembershipBinding.
# 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_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.DeleteMembershipBindingRequest(
name="name_value",
)
# Make the request
operation = client.delete_membership_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.DeleteMembershipBindingRequest, dict]]
The request object. Request to delete a Binding. |
name |
Required. The MembershipBinding resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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); } |
delete_membership_rbac_role_binding
delete_membership_rbac_role_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.DeleteMembershipRBACRoleBindingRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationDeletes a Membership RBACRoleBinding.
# 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_rbac_role_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.DeleteMembershipRBACRoleBindingRequest(
name="name_value",
)
# Make the request
operation = client.delete_membership_rbac_role_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.DeleteMembershipRBACRoleBindingRequest, dict]]
The request object. Request to delete a Membership RBACRoleBinding. |
name |
Required. The RBACRoleBinding resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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); } |
delete_scope
delete_scope(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.DeleteScopeRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationDeletes a Scope.
# 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_scope():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.DeleteScopeRequest(
name="name_value",
)
# Make the request
operation = client.delete_scope(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.DeleteScopeRequest, dict]]
The request object. Request to delete a Scope. |
name |
Required. The Scope resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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); } |
delete_scope_namespace
delete_scope_namespace(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.DeleteScopeNamespaceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationDeletes a fleet namespace.
# 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_scope_namespace():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.DeleteScopeNamespaceRequest(
name="name_value",
)
# Make the request
operation = client.delete_scope_namespace(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.DeleteScopeNamespaceRequest, dict]]
The request object. Request to delete a fleet namespace. |
name |
Required. The Namespace resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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); } |
delete_scope_rbac_role_binding
delete_scope_rbac_role_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.DeleteScopeRBACRoleBindingRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationDeletes a Scope RBACRoleBinding.
# 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_scope_rbac_role_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.DeleteScopeRBACRoleBindingRequest(
name="name_value",
)
# Make the request
operation = client.delete_scope_rbac_role_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.DeleteScopeRBACRoleBindingRequest, dict]]
The request object. Request to delete a Scope RBACRoleBinding. |
name |
Required. The RBACRoleBinding resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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); } |
feature_path
feature_path(project: str, location: str, feature: str) -> strReturns a fully-qualified feature string.
fleet_path
fleet_path(project: str, location: str, fleet: str) -> strReturns a fully-qualified fleet 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: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.GenerateConnectManifestRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.service.GenerateConnectManifestResponseGenerates 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GenerateConnectManifestRequest, dict]]
The request object. Request message for |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.GenerateConnectManifestResponse |
GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent. |
generate_membership_rbac_role_binding_yaml
generate_membership_rbac_role_binding_yaml(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.GenerateMembershipRBACRoleBindingYAMLRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.service.GenerateMembershipRBACRoleBindingYAMLResponseGenerates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.
# 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_membership_rbac_role_binding_yaml():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
rbacrolebinding = gkehub_v1.RBACRoleBinding()
rbacrolebinding.user = "user_value"
request = gkehub_v1.GenerateMembershipRBACRoleBindingYAMLRequest(
parent="parent_value",
rbacrolebinding_id="rbacrolebinding_id_value",
rbacrolebinding=rbacrolebinding,
)
# Make the request
response = await client.generate_membership_rbac_role_binding_yaml(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GenerateMembershipRBACRoleBindingYAMLRequest, dict]]
The request object. Request to generate a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources. |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.GenerateMembershipRBACRoleBindingYAMLResponse |
Response for GenerateRBACRoleBindingYAML. |
get_feature
get_feature(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.GetFeatureRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.feature.FeatureGets 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GetFeatureRequest, dict]]
The request object. Request message for |
name |
Required. The Feature resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.Feature |
Feature represents the settings and status of any Fleet Feature. |
get_fleet
get_fleet(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.GetFleetRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.fleet.FleetReturns the details of a fleet.
# 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_fleet():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.GetFleetRequest(
name="name_value",
)
# Make the request
response = await client.get_fleet(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GetFleetRequest, dict]]
The request object. Request message for the |
name |
Required. The Fleet resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.Fleet |
Fleet contains the Fleet-wide metadata and configuration. |
get_membership
get_membership(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.GetMembershipRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.membership.MembershipGets 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GetMembershipRequest, dict]]
The request object. Request message for |
name |
Required. The Membership resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.Membership |
Membership contains information about a member cluster. |
get_membership_binding
get_membership_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.GetMembershipBindingRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.fleet.MembershipBindingReturns the details of a MembershipBinding.
# 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_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.GetMembershipBindingRequest(
name="name_value",
)
# Make the request
response = await client.get_membership_binding(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GetMembershipBindingRequest, dict]]
The request object. Request message for the |
name |
Required. The MembershipBinding resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.MembershipBinding |
MembershipBinding is a subresource of a Membership, representing what Fleet Scopes (or other, future Fleet resources) a Membership is bound to. |
get_membership_rbac_role_binding
get_membership_rbac_role_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.GetMembershipRBACRoleBindingRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.fleet.RBACRoleBindingReturns the details of a Membership RBACRoleBinding.
# 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_rbac_role_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.GetMembershipRBACRoleBindingRequest(
name="name_value",
)
# Make the request
response = await client.get_membership_rbac_role_binding(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GetMembershipRBACRoleBindingRequest, dict]]
The request object. Request message for the |
name |
Required. The RBACRoleBinding resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.RBACRoleBinding |
RBACRoleBinding represents a rbacrolebinding across the Fleet |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.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 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.
| 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_scope
get_scope(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.GetScopeRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.fleet.ScopeReturns the details of a Scope.
# 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_scope():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.GetScopeRequest(
name="name_value",
)
# Make the request
response = await client.get_scope(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GetScopeRequest, dict]]
The request object. Request message for the |
name |
Required. The Scope resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.Scope |
Scope represents a Scope in a Fleet. |
get_scope_namespace
get_scope_namespace(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.GetScopeNamespaceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.fleet.NamespaceReturns the details of a fleet namespace.
# 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_scope_namespace():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.GetScopeNamespaceRequest(
name="name_value",
)
# Make the request
response = await client.get_scope_namespace(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GetScopeNamespaceRequest, dict]]
The request object. Request message for the |
name |
Required. The Namespace resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.Namespace |
Namespace represents a namespace across the Fleet |
get_scope_rbac_role_binding
get_scope_rbac_role_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.GetScopeRBACRoleBindingRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.types.fleet.RBACRoleBindingReturns the details of a Scope RBACRoleBinding.
# 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_scope_rbac_role_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.GetScopeRBACRoleBindingRequest(
name="name_value",
)
# Make the request
response = await client.get_scope_rbac_role_binding(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.GetScopeRBACRoleBindingRequest, dict]]
The request object. Request message for the |
name |
Required. The RBACRoleBinding resource name in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.types.RBACRoleBinding |
RBACRoleBinding represents a rbacrolebinding across the Fleet |
get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.gkehub_v1.services.gke_hub.transports.base.GkeHubTransport
]Returns an appropriate transport class.
| Parameter | |
|---|---|
| Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
list_bound_memberships
list_bound_memberships(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.ListBoundMembershipsRequest, dict
]
] = None,
*,
scope_name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListBoundMembershipsAsyncPagerLists Memberships bound to a Scope. The response includes relevant Memberships from all regions.
# 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_bound_memberships():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.ListBoundMembershipsRequest(
scope_name="scope_name_value",
)
# Make the request
page_result = client.list_bound_memberships(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListBoundMembershipsRequest, dict]]
The request object. Request to list Memberships bound to a Scope. |
scope_name |
Required. Name of the Scope, in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.services.gke_hub.pagers.ListBoundMembershipsAsyncPager |
List of Memberships bound to a Scope. Iterating over this object will yield results and resolve additional pages automatically. |
list_features
list_features(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.ListFeaturesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListFeaturesAsyncPagerLists 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListFeaturesRequest, dict]]
The request object. Request message for |
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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_fleets
list_fleets(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.ListFleetsRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListFleetsAsyncPagerReturns all fleets within an organization or a project that the caller has access to.
# 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_fleets():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.ListFleetsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_fleets(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListFleetsRequest, dict]]
The request object. Request message for the |
parent |
Required. The organization or project to list for Fleets under, in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.services.gke_hub.pagers.ListFleetsAsyncPager |
Response message for the GkeHub.ListFleetsResponse method. Iterating over this object will yield results and resolve additional pages automatically. |
list_membership_bindings
list_membership_bindings(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.ListMembershipBindingsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipBindingsAsyncPagerLists MembershipBindings.
# 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_membership_bindings():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.ListMembershipBindingsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_membership_bindings(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListMembershipBindingsRequest, dict]]
The request object. Request to list MembershipBinding. |
parent |
Required. The parent Membership for which the MembershipBindings will be listed. Specified in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipBindingsAsyncPager |
List of MembershipBindings. Iterating over this object will yield results and resolve additional pages automatically. |
list_membership_rbac_role_bindings
list_membership_rbac_role_bindings(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.ListMembershipRBACRoleBindingsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipRBACRoleBindingsAsyncPager
)Lists all Membership RBACRoleBindings.
# 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_membership_rbac_role_bindings():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.ListMembershipRBACRoleBindingsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_membership_rbac_role_bindings(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListMembershipRBACRoleBindingsRequest, dict]]
The request object. Request to list Membership RBACRoleBindings. |
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipRBACRoleBindingsAsyncPager |
List of Membership RBACRoleBindings. Iterating over this object will yield results and resolve additional pages automatically. |
list_memberships
list_memberships(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.ListMembershipsRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListMembershipsAsyncPagerLists 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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. |
list_permitted_scopes
list_permitted_scopes(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.ListPermittedScopesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListPermittedScopesAsyncPagerLists permitted Scopes.
# 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_permitted_scopes():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.ListPermittedScopesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_permitted_scopes(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListPermittedScopesRequest, dict]]
The request object. Request to list permitted Scopes. |
parent |
Required. The parent (project and location) where the Scope will be listed. Specified in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.services.gke_hub.pagers.ListPermittedScopesAsyncPager |
List of permitted Scopes. Iterating over this object will yield results and resolve additional pages automatically. |
list_scope_namespaces
list_scope_namespaces(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.ListScopeNamespacesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListScopeNamespacesAsyncPagerLists fleet namespaces.
# 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_scope_namespaces():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.ListScopeNamespacesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_scope_namespaces(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListScopeNamespacesRequest, dict]]
The request object. Request to list fleet namespaces. |
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.services.gke_hub.pagers.ListScopeNamespacesAsyncPager |
List of fleet namespaces. Iterating over this object will yield results and resolve additional pages automatically. |
list_scope_rbac_role_bindings
list_scope_rbac_role_bindings(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.ListScopeRBACRoleBindingsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListScopeRBACRoleBindingsAsyncPagerLists all Scope RBACRoleBindings.
# 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_scope_rbac_role_bindings():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.ListScopeRBACRoleBindingsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_scope_rbac_role_bindings(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListScopeRBACRoleBindingsRequest, dict]]
The request object. Request to list Scope RBACRoleBindings. |
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.services.gke_hub.pagers.ListScopeRBACRoleBindingsAsyncPager |
List of Scope RBACRoleBindings. Iterating over this object will yield results and resolve additional pages automatically. |
list_scopes
list_scopes(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.ListScopesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gkehub_v1.services.gke_hub.pagers.ListScopesAsyncPagerLists Scopes.
# 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_scopes():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.ListScopesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_scopes(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.ListScopesRequest, dict]]
The request object. Request to list Scopes. |
parent |
Required. The parent (project and location) where the Scope will be listed. Specified in the format |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkehub_v1.services.gke_hub.pagers.ListScopesAsyncPager |
List of Scopes. Iterating over this object will yield results and resolve additional pages automatically. |
membership_binding_path
membership_binding_path(
project: str, location: str, membership: str, membershipbinding: str
) -> strReturns a fully-qualified membership_binding string.
membership_path
membership_path(project: str, location: str, membership: str) -> strReturns a fully-qualified membership string.
namespace_path
namespace_path(project: str, location: str, scope: str, namespace: str) -> strReturns a fully-qualified namespace string.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
parse_feature_path
parse_feature_path(path: str) -> typing.Dict[str, str]Parses a feature path into its component segments.
parse_fleet_path
parse_fleet_path(path: str) -> typing.Dict[str, str]Parses a fleet path into its component segments.
parse_membership_binding_path
parse_membership_binding_path(path: str) -> typing.Dict[str, str]Parses a membership_binding path into its component segments.
parse_membership_path
parse_membership_path(path: str) -> typing.Dict[str, str]Parses a membership path into its component segments.
parse_namespace_path
parse_namespace_path(path: str) -> typing.Dict[str, str]Parses a namespace path into its component segments.
parse_rbac_role_binding_path
parse_rbac_role_binding_path(path: str) -> typing.Dict[str, str]Parses a rbac_role_binding path into its component segments.
parse_scope_path
parse_scope_path(path: str) -> typing.Dict[str, str]Parses a scope path into its component segments.
rbac_role_binding_path
rbac_role_binding_path(
project: str, location: str, scope: str, rbacrolebinding: str
) -> strReturns a fully-qualified rbac_role_binding string.
scope_path
scope_path(project: str, location: str, scope: str) -> strReturns a fully-qualified scope string.
update_feature
update_feature(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.UpdateFeatureRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
resource: typing.Optional[google.cloud.gkehub_v1.types.feature.Feature] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.UpdateFeatureRequest, dict]]
The request object. Request message for |
name |
Required. The Feature resource name in the format |
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 |
update_mask |
Mask of fields to update. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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 Fleet Feature. |
update_fleet
update_fleet(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.UpdateFleetRequest, dict]
] = None,
*,
fleet: typing.Optional[google.cloud.gkehub_v1.types.fleet.Fleet] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates a fleet.
# 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_fleet():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.UpdateFleetRequest(
)
# Make the request
operation = client.update_fleet(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.UpdateFleetRequest, dict]]
The request object. Request message for the |
fleet |
Fleet
Required. The Fleet to update. The |
update_mask |
Required. The fields to be updated; This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Fleet Fleet contains the Fleet-wide metadata and configuration. |
update_membership
update_membership(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.UpdateMembershipRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
resource: typing.Optional[
google.cloud.gkehub_v1.types.membership.Membership
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates 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 | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.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. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| 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. |
update_membership_binding
update_membership_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.UpdateMembershipBindingRequest, dict
]
] = None,
*,
membership_binding: typing.Optional[
google.cloud.gkehub_v1.types.fleet.MembershipBinding
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates a MembershipBinding.
# 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_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
membership_binding = gkehub_v1.MembershipBinding()
membership_binding.scope = "scope_value"
request = gkehub_v1.UpdateMembershipBindingRequest(
membership_binding=membership_binding,
)
# Make the request
operation = client.update_membership_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.UpdateMembershipBindingRequest, dict]]
The request object. Request to update a MembershipBinding. |
membership_binding |
MembershipBinding
Required. The MembershipBinding object with fields updated. This corresponds to the |
update_mask |
Required. The fields to be updated. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be MembershipBinding MembershipBinding is a subresource of a Membership, representing what Fleet Scopes (or other, future Fleet resources) a Membership is bound to. |
update_membership_rbac_role_binding
update_membership_rbac_role_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.UpdateMembershipRBACRoleBindingRequest,
dict,
]
] = None,
*,
rbacrolebinding: typing.Optional[
google.cloud.gkehub_v1.types.fleet.RBACRoleBinding
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates a Membership RBACRoleBinding.
# 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_rbac_role_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
rbacrolebinding = gkehub_v1.RBACRoleBinding()
rbacrolebinding.user = "user_value"
request = gkehub_v1.UpdateMembershipRBACRoleBindingRequest(
rbacrolebinding=rbacrolebinding,
)
# Make the request
operation = client.update_membership_rbac_role_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.UpdateMembershipRBACRoleBindingRequest, dict]]
The request object. Request to update a membership rbacrolebinding. |
rbacrolebinding |
RBACRoleBinding
Required. A rbacrolebinding with fields updated. The 'name' field in this rbacrolebinding is used to identify the resource to update. This corresponds to the |
update_mask |
Required. The fields to be updated. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be RBACRoleBinding RBACRoleBinding represents a rbacrolebinding across the Fleet |
update_scope
update_scope(
request: typing.Optional[
typing.Union[google.cloud.gkehub_v1.types.service.UpdateScopeRequest, dict]
] = None,
*,
scope: typing.Optional[google.cloud.gkehub_v1.types.fleet.Scope] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates a scopes.
# 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_scope():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
request = gkehub_v1.UpdateScopeRequest(
)
# Make the request
operation = client.update_scope(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.UpdateScopeRequest, dict]]
The request object. Request to update a Scope. |
scope |
Scope
Required. A Scope with fields updated. The 'name' field in this namespace is used to identify the resource to update. This corresponds to the |
update_mask |
Required. The fields to be updated. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Scope Scope represents a Scope in a Fleet. |
update_scope_namespace
update_scope_namespace(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.UpdateScopeNamespaceRequest, dict
]
] = None,
*,
scope_namespace: typing.Optional[
google.cloud.gkehub_v1.types.fleet.Namespace
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates a fleet namespace.
# 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_scope_namespace():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
scope_namespace = gkehub_v1.Namespace()
scope_namespace.scope = "scope_value"
request = gkehub_v1.UpdateScopeNamespaceRequest(
scope_namespace=scope_namespace,
)
# Make the request
operation = client.update_scope_namespace(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.UpdateScopeNamespaceRequest, dict]]
The request object. Request to update a fleet namespace. |
scope_namespace |
Namespace
Required. A namespace with fields updated. The 'name' field in this namespace is used to identify the resource to update. Given 'updated' prefix to follow go/proto-best-practices-checkers#keyword_conflict This corresponds to the |
update_mask |
Required. The fields to be updated. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Namespace Namespace represents a namespace across the Fleet |
update_scope_rbac_role_binding
update_scope_rbac_role_binding(
request: typing.Optional[
typing.Union[
google.cloud.gkehub_v1.types.service.UpdateScopeRBACRoleBindingRequest, dict
]
] = None,
*,
rbacrolebinding: typing.Optional[
google.cloud.gkehub_v1.types.fleet.RBACRoleBinding
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates a Scope RBACRoleBinding.
# 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_scope_rbac_role_binding():
# Create a client
client = gkehub_v1.GkeHubAsyncClient()
# Initialize request argument(s)
rbacrolebinding = gkehub_v1.RBACRoleBinding()
rbacrolebinding.user = "user_value"
request = gkehub_v1.UpdateScopeRBACRoleBindingRequest(
rbacrolebinding=rbacrolebinding,
)
# Make the request
operation = client.update_scope_rbac_role_binding(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.gkehub_v1.types.UpdateScopeRBACRoleBindingRequest, dict]]
The request object. Request to update a scope rbacrolebinding. |
rbacrolebinding |
RBACRoleBinding
Required. A rbacrolebinding with fields updated. The 'name' field in this rbacrolebinding is used to identify the resource to update. This corresponds to the |
update_mask |
Required. The fields to be updated. This corresponds to the |
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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be RBACRoleBinding RBACRoleBinding represents a rbacrolebinding across the Fleet |