Interface GkeHubMembershipServiceGrpc.AsyncService (1.31.0)

public static interface GkeHubMembershipServiceGrpc.AsyncService

The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource. GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. 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.

Methods

createMembership(CreateMembershipRequest request, StreamObserver<Operation> responseObserver)

public default void createMembership(CreateMembershipRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestCreateMembershipRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteMembership(DeleteMembershipRequest request, StreamObserver<Operation> responseObserver)

public default void deleteMembership(DeleteMembershipRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestDeleteMembershipRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

generateConnectManifest(GenerateConnectManifestRequest request, StreamObserver<GenerateConnectManifestResponse> responseObserver)

public default void generateConnectManifest(GenerateConnectManifestRequest request, StreamObserver<GenerateConnectManifestResponse> responseObserver)

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
NameDescription
requestGenerateConnectManifestRequest
responseObserverio.grpc.stub.StreamObserver<GenerateConnectManifestResponse>

generateExclusivityManifest(GenerateExclusivityManifestRequest request, StreamObserver<GenerateExclusivityManifestResponse> responseObserver)

public default void generateExclusivityManifest(GenerateExclusivityManifestRequest request, StreamObserver<GenerateExclusivityManifestResponse> responseObserver)

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
NameDescription
requestGenerateExclusivityManifestRequest
responseObserverio.grpc.stub.StreamObserver<GenerateExclusivityManifestResponse>

getMembership(GetMembershipRequest request, StreamObserver<Membership> responseObserver)

public default void getMembership(GetMembershipRequest request, StreamObserver<Membership> responseObserver)

Gets the details of a Membership.

Parameters
NameDescription
requestGetMembershipRequest
responseObserverio.grpc.stub.StreamObserver<Membership>

listMemberships(ListMembershipsRequest request, StreamObserver<ListMembershipsResponse> responseObserver)

public default void listMemberships(ListMembershipsRequest request, StreamObserver<ListMembershipsResponse> responseObserver)

Lists Memberships in a given project and location.

Parameters
NameDescription
requestListMembershipsRequest
responseObserverio.grpc.stub.StreamObserver<ListMembershipsResponse>

updateMembership(UpdateMembershipRequest request, StreamObserver<Operation> responseObserver)

public default void updateMembership(UpdateMembershipRequest request, StreamObserver<Operation> responseObserver)

Updates an existing Membership.

Parameters
NameDescription
requestUpdateMembershipRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

validateExclusivity(ValidateExclusivityRequest request, StreamObserver<ValidateExclusivityResponse> responseObserver)

public default void validateExclusivity(ValidateExclusivityRequest request, StreamObserver<ValidateExclusivityResponse> responseObserver)

ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

Parameters
NameDescription
requestValidateExclusivityRequest
responseObserverio.grpc.stub.StreamObserver<ValidateExclusivityResponse>