Interface GkeHubGrpc.AsyncService (1.85.0)

public static interface GkeHubGrpc.AsyncService

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.

Methods

createFeature(CreateFeatureRequest request, StreamObserver<Operation> responseObserver)

public default void createFeature(CreateFeatureRequest request, StreamObserver<Operation> responseObserver)

Adds a new Feature.

Parameters
Name Description
request CreateFeatureRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createFleet(CreateFleetRequest request, StreamObserver<Operation> responseObserver)

public default void createFleet(CreateFleetRequest request, StreamObserver<Operation> responseObserver)

Creates a fleet.

Parameters
Name Description
request CreateFleetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

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
Name Description
request CreateMembershipRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createMembershipBinding(CreateMembershipBindingRequest request, StreamObserver<Operation> responseObserver)

public default void createMembershipBinding(CreateMembershipBindingRequest request, StreamObserver<Operation> responseObserver)

Creates a MembershipBinding.

Parameters
Name Description
request CreateMembershipBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createMembershipRBACRoleBinding(CreateMembershipRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

public default void createMembershipRBACRoleBinding(CreateMembershipRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

Creates a Membership RBACRoleBinding.

Parameters
Name Description
request CreateMembershipRBACRoleBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createScope(CreateScopeRequest request, StreamObserver<Operation> responseObserver)

public default void createScope(CreateScopeRequest request, StreamObserver<Operation> responseObserver)

Creates a Scope.

Parameters
Name Description
request CreateScopeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createScopeNamespace(CreateScopeNamespaceRequest request, StreamObserver<Operation> responseObserver)

public default void createScopeNamespace(CreateScopeNamespaceRequest request, StreamObserver<Operation> responseObserver)

Creates a fleet namespace.

Parameters
Name Description
request CreateScopeNamespaceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createScopeRBACRoleBinding(CreateScopeRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

public default void createScopeRBACRoleBinding(CreateScopeRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

Creates a Scope RBACRoleBinding.

Parameters
Name Description
request CreateScopeRBACRoleBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteFeature(DeleteFeatureRequest request, StreamObserver<Operation> responseObserver)

public default void deleteFeature(DeleteFeatureRequest request, StreamObserver<Operation> responseObserver)

Removes a Feature.

Parameters
Name Description
request DeleteFeatureRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteFleet(DeleteFleetRequest request, StreamObserver<Operation> responseObserver)

public default void deleteFleet(DeleteFleetRequest request, StreamObserver<Operation> responseObserver)

Removes a Fleet. There must be no memberships remaining in the Fleet.

Parameters
Name Description
request DeleteFleetRequest
responseObserver io.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
Name Description
request DeleteMembershipRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteMembershipBinding(DeleteMembershipBindingRequest request, StreamObserver<Operation> responseObserver)

public default void deleteMembershipBinding(DeleteMembershipBindingRequest request, StreamObserver<Operation> responseObserver)

Deletes a MembershipBinding.

Parameters
Name Description
request DeleteMembershipBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteMembershipRBACRoleBinding(DeleteMembershipRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

public default void deleteMembershipRBACRoleBinding(DeleteMembershipRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

Deletes a Membership RBACRoleBinding.

Parameters
Name Description
request DeleteMembershipRBACRoleBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteScope(DeleteScopeRequest request, StreamObserver<Operation> responseObserver)

public default void deleteScope(DeleteScopeRequest request, StreamObserver<Operation> responseObserver)

Deletes a Scope.

Parameters
Name Description
request DeleteScopeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteScopeNamespace(DeleteScopeNamespaceRequest request, StreamObserver<Operation> responseObserver)

public default void deleteScopeNamespace(DeleteScopeNamespaceRequest request, StreamObserver<Operation> responseObserver)

Deletes a fleet namespace.

Parameters
Name Description
request DeleteScopeNamespaceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteScopeRBACRoleBinding(DeleteScopeRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

public default void deleteScopeRBACRoleBinding(DeleteScopeRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

Deletes a Scope RBACRoleBinding.

Parameters
Name Description
request DeleteScopeRBACRoleBindingRequest
responseObserver io.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
Name Description
request GenerateConnectManifestRequest
responseObserver io.grpc.stub.StreamObserver<GenerateConnectManifestResponse>

generateMembershipRBACRoleBindingYAML(GenerateMembershipRBACRoleBindingYAMLRequest request, StreamObserver<GenerateMembershipRBACRoleBindingYAMLResponse> responseObserver)

public default void generateMembershipRBACRoleBindingYAML(GenerateMembershipRBACRoleBindingYAMLRequest request, StreamObserver<GenerateMembershipRBACRoleBindingYAMLResponse> responseObserver)

Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.

Parameters
Name Description
request GenerateMembershipRBACRoleBindingYAMLRequest
responseObserver io.grpc.stub.StreamObserver<GenerateMembershipRBACRoleBindingYAMLResponse>

getFeature(GetFeatureRequest request, StreamObserver<Feature> responseObserver)

public default void getFeature(GetFeatureRequest request, StreamObserver<Feature> responseObserver)

Gets details of a single Feature.

Parameters
Name Description
request GetFeatureRequest
responseObserver io.grpc.stub.StreamObserver<Feature>

getFleet(GetFleetRequest request, StreamObserver<Fleet> responseObserver)

public default void getFleet(GetFleetRequest request, StreamObserver<Fleet> responseObserver)

Returns the details of a fleet.

Parameters
Name Description
request GetFleetRequest
responseObserver io.grpc.stub.StreamObserver<Fleet>

getMembership(GetMembershipRequest request, StreamObserver<Membership> responseObserver)

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

Gets the details of a Membership.

Parameters
Name Description
request GetMembershipRequest
responseObserver io.grpc.stub.StreamObserver<Membership>

getMembershipBinding(GetMembershipBindingRequest request, StreamObserver<MembershipBinding> responseObserver)

public default void getMembershipBinding(GetMembershipBindingRequest request, StreamObserver<MembershipBinding> responseObserver)

Returns the details of a MembershipBinding.

Parameters
Name Description
request GetMembershipBindingRequest
responseObserver io.grpc.stub.StreamObserver<MembershipBinding>

getMembershipRBACRoleBinding(GetMembershipRBACRoleBindingRequest request, StreamObserver<RBACRoleBinding> responseObserver)

public default void getMembershipRBACRoleBinding(GetMembershipRBACRoleBindingRequest request, StreamObserver<RBACRoleBinding> responseObserver)

Returns the details of a Membership RBACRoleBinding.

Parameters
Name Description
request GetMembershipRBACRoleBindingRequest
responseObserver io.grpc.stub.StreamObserver<RBACRoleBinding>

getScope(GetScopeRequest request, StreamObserver<Scope> responseObserver)

public default void getScope(GetScopeRequest request, StreamObserver<Scope> responseObserver)

Returns the details of a Scope.

Parameters
Name Description
request GetScopeRequest
responseObserver io.grpc.stub.StreamObserver<Scope>

getScopeNamespace(GetScopeNamespaceRequest request, StreamObserver<Namespace> responseObserver)

public default void getScopeNamespace(GetScopeNamespaceRequest request, StreamObserver<Namespace> responseObserver)

Returns the details of a fleet namespace.

Parameters
Name Description
request GetScopeNamespaceRequest
responseObserver io.grpc.stub.StreamObserver<Namespace>

getScopeRBACRoleBinding(GetScopeRBACRoleBindingRequest request, StreamObserver<RBACRoleBinding> responseObserver)

public default void getScopeRBACRoleBinding(GetScopeRBACRoleBindingRequest request, StreamObserver<RBACRoleBinding> responseObserver)

Returns the details of a Scope RBACRoleBinding.

Parameters
Name Description
request GetScopeRBACRoleBindingRequest
responseObserver io.grpc.stub.StreamObserver<RBACRoleBinding>

listBoundMemberships(ListBoundMembershipsRequest request, StreamObserver<ListBoundMembershipsResponse> responseObserver)

public default void listBoundMemberships(ListBoundMembershipsRequest request, StreamObserver<ListBoundMembershipsResponse> responseObserver)

Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.

Parameters
Name Description
request ListBoundMembershipsRequest
responseObserver io.grpc.stub.StreamObserver<ListBoundMembershipsResponse>

listFeatures(ListFeaturesRequest request, StreamObserver<ListFeaturesResponse> responseObserver)

public default void listFeatures(ListFeaturesRequest request, StreamObserver<ListFeaturesResponse> responseObserver)

Lists Features in a given project and location.

Parameters
Name Description
request ListFeaturesRequest
responseObserver io.grpc.stub.StreamObserver<ListFeaturesResponse>

listFleets(ListFleetsRequest request, StreamObserver<ListFleetsResponse> responseObserver)

public default void listFleets(ListFleetsRequest request, StreamObserver<ListFleetsResponse> responseObserver)

Returns all fleets within an organization or a project that the caller has access to.

Parameters
Name Description
request ListFleetsRequest
responseObserver io.grpc.stub.StreamObserver<ListFleetsResponse>

listMembershipBindings(ListMembershipBindingsRequest request, StreamObserver<ListMembershipBindingsResponse> responseObserver)

public default void listMembershipBindings(ListMembershipBindingsRequest request, StreamObserver<ListMembershipBindingsResponse> responseObserver)

Lists MembershipBindings.

Parameters
Name Description
request ListMembershipBindingsRequest
responseObserver io.grpc.stub.StreamObserver<ListMembershipBindingsResponse>

listMembershipRBACRoleBindings(ListMembershipRBACRoleBindingsRequest request, StreamObserver<ListMembershipRBACRoleBindingsResponse> responseObserver)

public default void listMembershipRBACRoleBindings(ListMembershipRBACRoleBindingsRequest request, StreamObserver<ListMembershipRBACRoleBindingsResponse> responseObserver)

Lists all Membership RBACRoleBindings.

Parameters
Name Description
request ListMembershipRBACRoleBindingsRequest
responseObserver io.grpc.stub.StreamObserver<ListMembershipRBACRoleBindingsResponse>

listMemberships(ListMembershipsRequest request, StreamObserver<ListMembershipsResponse> responseObserver)

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

Lists Memberships in a given project and location.

Parameters
Name Description
request ListMembershipsRequest
responseObserver io.grpc.stub.StreamObserver<ListMembershipsResponse>

listPermittedScopes(ListPermittedScopesRequest request, StreamObserver<ListPermittedScopesResponse> responseObserver)

public default void listPermittedScopes(ListPermittedScopesRequest request, StreamObserver<ListPermittedScopesResponse> responseObserver)

Lists permitted Scopes.

Parameters
Name Description
request ListPermittedScopesRequest
responseObserver io.grpc.stub.StreamObserver<ListPermittedScopesResponse>

listScopeNamespaces(ListScopeNamespacesRequest request, StreamObserver<ListScopeNamespacesResponse> responseObserver)

public default void listScopeNamespaces(ListScopeNamespacesRequest request, StreamObserver<ListScopeNamespacesResponse> responseObserver)

Lists fleet namespaces.

Parameters
Name Description
request ListScopeNamespacesRequest
responseObserver io.grpc.stub.StreamObserver<ListScopeNamespacesResponse>

listScopeRBACRoleBindings(ListScopeRBACRoleBindingsRequest request, StreamObserver<ListScopeRBACRoleBindingsResponse> responseObserver)

public default void listScopeRBACRoleBindings(ListScopeRBACRoleBindingsRequest request, StreamObserver<ListScopeRBACRoleBindingsResponse> responseObserver)

Lists all Scope RBACRoleBindings.

Parameters
Name Description
request ListScopeRBACRoleBindingsRequest
responseObserver io.grpc.stub.StreamObserver<ListScopeRBACRoleBindingsResponse>

listScopes(ListScopesRequest request, StreamObserver<ListScopesResponse> responseObserver)

public default void listScopes(ListScopesRequest request, StreamObserver<ListScopesResponse> responseObserver)

Lists Scopes.

Parameters
Name Description
request ListScopesRequest
responseObserver io.grpc.stub.StreamObserver<ListScopesResponse>

updateFeature(UpdateFeatureRequest request, StreamObserver<Operation> responseObserver)

public default void updateFeature(UpdateFeatureRequest request, StreamObserver<Operation> responseObserver)

Updates an existing Feature.

Parameters
Name Description
request UpdateFeatureRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateFleet(UpdateFleetRequest request, StreamObserver<Operation> responseObserver)

public default void updateFleet(UpdateFleetRequest request, StreamObserver<Operation> responseObserver)

Updates a fleet.

Parameters
Name Description
request UpdateFleetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateMembership(UpdateMembershipRequest request, StreamObserver<Operation> responseObserver)

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

Updates an existing Membership.

Parameters
Name Description
request UpdateMembershipRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateMembershipBinding(UpdateMembershipBindingRequest request, StreamObserver<Operation> responseObserver)

public default void updateMembershipBinding(UpdateMembershipBindingRequest request, StreamObserver<Operation> responseObserver)

Updates a MembershipBinding.

Parameters
Name Description
request UpdateMembershipBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateMembershipRBACRoleBinding(UpdateMembershipRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

public default void updateMembershipRBACRoleBinding(UpdateMembershipRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

Updates a Membership RBACRoleBinding.

Parameters
Name Description
request UpdateMembershipRBACRoleBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateScope(UpdateScopeRequest request, StreamObserver<Operation> responseObserver)

public default void updateScope(UpdateScopeRequest request, StreamObserver<Operation> responseObserver)

Updates a scopes.

Parameters
Name Description
request UpdateScopeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateScopeNamespace(UpdateScopeNamespaceRequest request, StreamObserver<Operation> responseObserver)

public default void updateScopeNamespace(UpdateScopeNamespaceRequest request, StreamObserver<Operation> responseObserver)

Updates a fleet namespace.

Parameters
Name Description
request UpdateScopeNamespaceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateScopeRBACRoleBinding(UpdateScopeRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

public default void updateScopeRBACRoleBinding(UpdateScopeRBACRoleBindingRequest request, StreamObserver<Operation> responseObserver)

Updates a Scope RBACRoleBinding.

Parameters
Name Description
request UpdateScopeRBACRoleBindingRequest
responseObserver io.grpc.stub.StreamObserver<Operation>