GKE Hub v1beta1 API - Class GkeHubMembershipService.GkeHubMembershipServiceClient (2.0.0-beta07)

public class GkeHubMembershipService.GkeHubMembershipServiceClient : ClientBase<GkeHubMembershipService.GkeHubMembershipServiceClient>

Reference documentation and code samples for the GKE Hub v1beta1 API class GkeHubMembershipService.GkeHubMembershipServiceClient.

Client for GkeHubMembershipService

Inheritance

object > ClientBase > ClientBaseGkeHubMembershipServiceGkeHubMembershipServiceClient > GkeHubMembershipService.GkeHubMembershipServiceClient

Namespace

Google.Cloud.GkeHub.V1Beta1

Assembly

Google.Cloud.GkeHub.V1Beta1.dll

Constructors

GkeHubMembershipServiceClient()

protected GkeHubMembershipServiceClient()

Protected parameterless constructor to allow creation of test doubles.

GkeHubMembershipServiceClient(CallInvoker)

public GkeHubMembershipServiceClient(CallInvoker callInvoker)

Creates a new client for GkeHubMembershipService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

GkeHubMembershipServiceClient(ChannelBase)

public GkeHubMembershipServiceClient(ChannelBase channel)

Creates a new client for GkeHubMembershipService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

GkeHubMembershipServiceClient(ClientBaseConfiguration)

protected GkeHubMembershipServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateMembership(CreateMembershipRequest, CallOptions)

public virtual Operation CreateMembership(CreateMembershipRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateMembership(CreateMembershipRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateMembership(CreateMembershipRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateMembershipAsync(CreateMembershipRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateMembershipAsync(CreateMembershipRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateMembershipAsync(CreateMembershipRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateMembershipAsync(CreateMembershipRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteMembership(DeleteMembershipRequest, CallOptions)

public virtual Operation DeleteMembership(DeleteMembershipRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteMembership(DeleteMembershipRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteMembership(DeleteMembershipRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteMembershipAsync(DeleteMembershipRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteMembershipAsync(DeleteMembershipRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteMembershipAsync(DeleteMembershipRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteMembershipAsync(DeleteMembershipRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GenerateConnectManifest(GenerateConnectManifestRequest, CallOptions)

public virtual GenerateConnectManifestResponse GenerateConnectManifest(GenerateConnectManifestRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
GenerateConnectManifestResponse

The response received from the server.

GenerateConnectManifest(GenerateConnectManifestRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateConnectManifestResponse GenerateConnectManifest(GenerateConnectManifestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
GenerateConnectManifestResponse

The response received from the server.

GenerateConnectManifestAsync(GenerateConnectManifestRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateConnectManifestResponse> GenerateConnectManifestAsync(GenerateConnectManifestRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallGenerateConnectManifestResponse

The call object.

GenerateConnectManifestAsync(GenerateConnectManifestRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateConnectManifestResponse> GenerateConnectManifestAsync(GenerateConnectManifestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallGenerateConnectManifestResponse

The call object.

GenerateExclusivityManifest(GenerateExclusivityManifestRequest, CallOptions)

public virtual GenerateExclusivityManifestResponse GenerateExclusivityManifest(GenerateExclusivityManifestRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
GenerateExclusivityManifestResponse

The response received from the server.

GenerateExclusivityManifest(GenerateExclusivityManifestRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateExclusivityManifestResponse GenerateExclusivityManifest(GenerateExclusivityManifestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
GenerateExclusivityManifestResponse

The response received from the server.

GenerateExclusivityManifestAsync(GenerateExclusivityManifestRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateExclusivityManifestResponse> GenerateExclusivityManifestAsync(GenerateExclusivityManifestRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallGenerateExclusivityManifestResponse

The call object.

GenerateExclusivityManifestAsync(GenerateExclusivityManifestRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateExclusivityManifestResponse> GenerateExclusivityManifestAsync(GenerateExclusivityManifestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallGenerateExclusivityManifestResponse

The call object.

GetMembership(GetMembershipRequest, CallOptions)

public virtual Membership GetMembership(GetMembershipRequest request, CallOptions options)

Gets the details of a Membership.

Parameters
Name Description
request GetMembershipRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Membership

The response received from the server.

GetMembership(GetMembershipRequest, Metadata, DateTime?, CancellationToken)

public virtual Membership GetMembership(GetMembershipRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a Membership.

Parameters
Name Description
request GetMembershipRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Membership

The response received from the server.

GetMembershipAsync(GetMembershipRequest, CallOptions)

public virtual AsyncUnaryCall<Membership> GetMembershipAsync(GetMembershipRequest request, CallOptions options)

Gets the details of a Membership.

Parameters
Name Description
request GetMembershipRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallMembership

The call object.

GetMembershipAsync(GetMembershipRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Membership> GetMembershipAsync(GetMembershipRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a Membership.

Parameters
Name Description
request GetMembershipRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallMembership

The call object.

ListMemberships(ListMembershipsRequest, CallOptions)

public virtual ListMembershipsResponse ListMemberships(ListMembershipsRequest request, CallOptions options)

Lists Memberships in a given project and location.

Parameters
Name Description
request ListMembershipsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListMembershipsResponse

The response received from the server.

ListMemberships(ListMembershipsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListMembershipsResponse ListMemberships(ListMembershipsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Memberships in a given project and location.

Parameters
Name Description
request ListMembershipsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListMembershipsResponse

The response received from the server.

ListMembershipsAsync(ListMembershipsRequest, CallOptions)

public virtual AsyncUnaryCall<ListMembershipsResponse> ListMembershipsAsync(ListMembershipsRequest request, CallOptions options)

Lists Memberships in a given project and location.

Parameters
Name Description
request ListMembershipsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListMembershipsResponse

The call object.

ListMembershipsAsync(ListMembershipsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListMembershipsResponse> ListMembershipsAsync(ListMembershipsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Memberships in a given project and location.

Parameters
Name Description
request ListMembershipsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListMembershipsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override GkeHubMembershipService.GkeHubMembershipServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
GkeHubMembershipServiceGkeHubMembershipServiceClient
Overrides

UpdateMembership(UpdateMembershipRequest, CallOptions)

public virtual Operation UpdateMembership(UpdateMembershipRequest request, CallOptions options)

Updates an existing Membership.

Parameters
Name Description
request UpdateMembershipRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateMembership(UpdateMembershipRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateMembership(UpdateMembershipRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing Membership.

Parameters
Name Description
request UpdateMembershipRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateMembershipAsync(UpdateMembershipRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateMembershipAsync(UpdateMembershipRequest request, CallOptions options)

Updates an existing Membership.

Parameters
Name Description
request UpdateMembershipRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateMembershipAsync(UpdateMembershipRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateMembershipAsync(UpdateMembershipRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing Membership.

Parameters
Name Description
request UpdateMembershipRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ValidateExclusivity(ValidateExclusivityRequest, CallOptions)

public virtual ValidateExclusivityResponse ValidateExclusivity(ValidateExclusivityRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ValidateExclusivityResponse

The response received from the server.

ValidateExclusivity(ValidateExclusivityRequest, Metadata, DateTime?, CancellationToken)

public virtual ValidateExclusivityResponse ValidateExclusivity(ValidateExclusivityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ValidateExclusivityResponse

The response received from the server.

ValidateExclusivityAsync(ValidateExclusivityRequest, CallOptions)

public virtual AsyncUnaryCall<ValidateExclusivityResponse> ValidateExclusivityAsync(ValidateExclusivityRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallValidateExclusivityResponse

The call object.

ValidateExclusivityAsync(ValidateExclusivityRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ValidateExclusivityResponse> ValidateExclusivityAsync(ValidateExclusivityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallValidateExclusivityResponse

The call object.