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

[BindServiceMethod(typeof(GkeHubMembershipService), "BindService")]
public abstract class GkeHubMembershipService.GkeHubMembershipServiceBase

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

Base class for server-side implementations of GkeHubMembershipService

Inheritance

object > GkeHubMembershipService.GkeHubMembershipServiceBase

Namespace

Google.Cloud.GkeHub.V1Beta1

Assembly

Google.Cloud.GkeHub.V1Beta1.dll

Methods

CreateMembership(CreateMembershipRequest, ServerCallContext)

public virtual Task<Operation> CreateMembership(CreateMembershipRequest request, ServerCallContext context)

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 received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteMembership(DeleteMembershipRequest, ServerCallContext)

public virtual Task<Operation> DeleteMembership(DeleteMembershipRequest request, ServerCallContext context)

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 received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

GenerateConnectManifest(GenerateConnectManifestRequest, ServerCallContext)

public virtual Task<GenerateConnectManifestResponse> GenerateConnectManifest(GenerateConnectManifestRequest request, ServerCallContext context)

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 received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskGenerateConnectManifestResponse

The response to send back to the client (wrapped by a task).

GenerateExclusivityManifest(GenerateExclusivityManifestRequest, ServerCallContext)

public virtual Task<GenerateExclusivityManifestResponse> GenerateExclusivityManifest(GenerateExclusivityManifestRequest request, ServerCallContext context)

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 received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskGenerateExclusivityManifestResponse

The response to send back to the client (wrapped by a task).

GetMembership(GetMembershipRequest, ServerCallContext)

public virtual Task<Membership> GetMembership(GetMembershipRequest request, ServerCallContext context)

Gets the details of a Membership.

Parameters
Name Description
request GetMembershipRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskMembership

The response to send back to the client (wrapped by a task).

ListMemberships(ListMembershipsRequest, ServerCallContext)

public virtual Task<ListMembershipsResponse> ListMemberships(ListMembershipsRequest request, ServerCallContext context)

Lists Memberships in a given project and location.

Parameters
Name Description
request ListMembershipsRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListMembershipsResponse

The response to send back to the client (wrapped by a task).

UpdateMembership(UpdateMembershipRequest, ServerCallContext)

public virtual Task<Operation> UpdateMembership(UpdateMembershipRequest request, ServerCallContext context)

Updates an existing Membership.

Parameters
Name Description
request UpdateMembershipRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

ValidateExclusivity(ValidateExclusivityRequest, ServerCallContext)

public virtual Task<ValidateExclusivityResponse> ValidateExclusivity(ValidateExclusivityRequest request, ServerCallContext context)

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 received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskValidateExclusivityResponse

The response to send back to the client (wrapped by a task).