public sealed class GkeHubMembershipServiceClientImpl : GkeHubMembershipServiceClient
GkeHubMembershipService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.GkeHub.V1Beta1Assembly
Google.Cloud.GkeHub.V1Beta1.dll
Remarks
The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the [Membership][google.cloud.gkehub.v1beta1.Membership] resource.
GKE Hub is currently only available in the global region.
Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.
Constructors
GkeHubMembershipServiceClientImpl(GkeHubMembershipService.GkeHubMembershipServiceClient, GkeHubMembershipServiceSettings)
public GkeHubMembershipServiceClientImpl(GkeHubMembershipService.GkeHubMembershipServiceClient grpcClient, GkeHubMembershipServiceSettings settings)
Constructs a client wrapper for the GkeHubMembershipService service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | GkeHubMembershipService.GkeHubMembershipServiceClient The underlying gRPC client. |
settings | GkeHubMembershipServiceSettings The base GkeHubMembershipServiceSettings used within this client. |
Properties
CreateMembershipOperationsClient
public override OperationsClient CreateMembershipOperationsClient { get; }
The long-running operations client for CreateMembership
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteMembershipOperationsClient
public override OperationsClient DeleteMembershipOperationsClient { get; }
The long-running operations client for DeleteMembership
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override GkeHubMembershipService.GkeHubMembershipServiceClient GrpcClient { get; }
The underlying gRPC GkeHubMembershipService client
Property Value | |
---|---|
Type | Description |
GkeHubMembershipService.GkeHubMembershipServiceClient |
UpdateMembershipOperationsClient
public override OperationsClient UpdateMembershipOperationsClient { get; }
The long-running operations client for UpdateMembership
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
CreateMembership(CreateMembershipRequest, CallSettings)
public override Operation<Membership, OperationMetadata> CreateMembership(CreateMembershipRequest request, CallSettings callSettings = null)
Creates a new Membership.
This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
Parameters | |
---|---|
Name | Description |
request | CreateMembershipRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Membership, OperationMetadata> | The RPC response. |
CreateMembershipAsync(CreateMembershipRequest, CallSettings)
public override Task<Operation<Membership, OperationMetadata>> CreateMembershipAsync(CreateMembershipRequest request, CallSettings callSettings = null)
Creates a new Membership.
This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
Parameters | |
---|---|
Name | Description |
request | CreateMembershipRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Membership, OperationMetadata>> | A Task containing the RPC response. |
DeleteMembership(DeleteMembershipRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteMembership(DeleteMembershipRequest request, CallSettings callSettings = null)
Removes a Membership.
This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
Parameters | |
---|---|
Name | Description |
request | DeleteMembershipRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteMembershipAsync(DeleteMembershipRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteMembershipAsync(DeleteMembershipRequest request, CallSettings callSettings = null)
Removes a Membership.
This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
Parameters | |
---|---|
Name | Description |
request | DeleteMembershipRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
GenerateConnectManifest(GenerateConnectManifestRequest, CallSettings)
public override GenerateConnectManifestResponse GenerateConnectManifest(GenerateConnectManifestRequest request, CallSettings callSettings = null)
Generates the manifest for deployment of the GKE connect agent.
This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.
Parameters | |
---|---|
Name | Description |
request | GenerateConnectManifestRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
GenerateConnectManifestResponse | The RPC response. |
GenerateConnectManifestAsync(GenerateConnectManifestRequest, CallSettings)
public override Task<GenerateConnectManifestResponse> GenerateConnectManifestAsync(GenerateConnectManifestRequest request, CallSettings callSettings = null)
Generates the manifest for deployment of the GKE connect agent.
This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.
Parameters | |
---|---|
Name | Description |
request | GenerateConnectManifestRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<GenerateConnectManifestResponse> | A Task containing the RPC response. |
GenerateExclusivityManifest(GenerateExclusivityManifestRequest, CallSettings)
public override GenerateExclusivityManifestResponse GenerateExclusivityManifest(GenerateExclusivityManifestRequest request, CallSettings callSettings = null)
GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.
Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.
The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.
Parameters | |
---|---|
Name | Description |
request | GenerateExclusivityManifestRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
GenerateExclusivityManifestResponse | The RPC response. |
GenerateExclusivityManifestAsync(GenerateExclusivityManifestRequest, CallSettings)
public override Task<GenerateExclusivityManifestResponse> GenerateExclusivityManifestAsync(GenerateExclusivityManifestRequest request, CallSettings callSettings = null)
GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.
Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.
The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.
Parameters | |
---|---|
Name | Description |
request | GenerateExclusivityManifestRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<GenerateExclusivityManifestResponse> | A Task containing the RPC response. |
GetMembership(GetMembershipRequest, CallSettings)
public override Membership GetMembership(GetMembershipRequest request, CallSettings callSettings = null)
Gets the details of a Membership.
Parameters | |
---|---|
Name | Description |
request | GetMembershipRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Membership | The RPC response. |
GetMembershipAsync(GetMembershipRequest, CallSettings)
public override Task<Membership> GetMembershipAsync(GetMembershipRequest request, CallSettings callSettings = null)
Gets the details of a Membership.
Parameters | |
---|---|
Name | Description |
request | GetMembershipRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Membership> | A Task containing the RPC response. |
ListMemberships(ListMembershipsRequest, CallSettings)
public override PagedEnumerable<ListMembershipsResponse, Membership> ListMemberships(ListMembershipsRequest request, CallSettings callSettings = null)
Lists Memberships in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListMembershipsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListMembershipsResponse, Membership> | A pageable sequence of Membership resources. |
ListMembershipsAsync(ListMembershipsRequest, CallSettings)
public override PagedAsyncEnumerable<ListMembershipsResponse, Membership> ListMembershipsAsync(ListMembershipsRequest request, CallSettings callSettings = null)
Lists Memberships in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListMembershipsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListMembershipsResponse, Membership> | A pageable asynchronous sequence of Membership resources. |
UpdateMembership(UpdateMembershipRequest, CallSettings)
public override Operation<Membership, OperationMetadata> UpdateMembership(UpdateMembershipRequest request, CallSettings callSettings = null)
Updates an existing Membership.
Parameters | |
---|---|
Name | Description |
request | UpdateMembershipRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Membership, OperationMetadata> | The RPC response. |
UpdateMembershipAsync(UpdateMembershipRequest, CallSettings)
public override Task<Operation<Membership, OperationMetadata>> UpdateMembershipAsync(UpdateMembershipRequest request, CallSettings callSettings = null)
Updates an existing Membership.
Parameters | |
---|---|
Name | Description |
request | UpdateMembershipRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Membership, OperationMetadata>> | A Task containing the RPC response. |
ValidateExclusivity(ValidateExclusivityRequest, CallSettings)
public override ValidateExclusivityResponse ValidateExclusivity(ValidateExclusivityRequest request, CallSettings callSettings = null)
ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.
Parameters | |
---|---|
Name | Description |
request | ValidateExclusivityRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ValidateExclusivityResponse | The RPC response. |
ValidateExclusivityAsync(ValidateExclusivityRequest, CallSettings)
public override Task<ValidateExclusivityResponse> ValidateExclusivityAsync(ValidateExclusivityRequest request, CallSettings callSettings = null)
ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.
Parameters | |
---|---|
Name | Description |
request | ValidateExclusivityRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ValidateExclusivityResponse> | A Task containing the RPC response. |