Class GkeHubGrpc.GkeHubBlockingV2Stub (1.88.0)

public static final class GkeHubGrpc.GkeHubBlockingV2Stub extends AbstractBlockingStub<GkeHubGrpc.GkeHubBlockingV2Stub>

A stub to allow clients to do synchronous rpc calls to service GkeHub.

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > GkeHubGrpc.GkeHubBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

protected GkeHubGrpc.GkeHubBlockingV2Stub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
GkeHubGrpc.GkeHubBlockingV2Stub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createFeature(CreateFeatureRequest request)

public Operation createFeature(CreateFeatureRequest request)

Adds a new Feature.

Parameter
Name Description
request CreateFeatureRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createFleet(CreateFleetRequest request)

public Operation createFleet(CreateFleetRequest request)

Creates a fleet.

Parameter
Name Description
request CreateFleetRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createMembership(CreateMembershipRequest request)

public Operation createMembership(CreateMembershipRequest request)

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.

Parameter
Name Description
request CreateMembershipRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createMembershipBinding(CreateMembershipBindingRequest request)

public Operation createMembershipBinding(CreateMembershipBindingRequest request)

Creates a MembershipBinding.

Parameter
Name Description
request CreateMembershipBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createMembershipRBACRoleBinding(CreateMembershipRBACRoleBindingRequest request)

public Operation createMembershipRBACRoleBinding(CreateMembershipRBACRoleBindingRequest request)

Creates a Membership RBACRoleBinding.

Parameter
Name Description
request CreateMembershipRBACRoleBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createScope(CreateScopeRequest request)

public Operation createScope(CreateScopeRequest request)

Creates a Scope.

Parameter
Name Description
request CreateScopeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createScopeNamespace(CreateScopeNamespaceRequest request)

public Operation createScopeNamespace(CreateScopeNamespaceRequest request)

Creates a fleet namespace.

Parameter
Name Description
request CreateScopeNamespaceRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createScopeRBACRoleBinding(CreateScopeRBACRoleBindingRequest request)

public Operation createScopeRBACRoleBinding(CreateScopeRBACRoleBindingRequest request)

Creates a Scope RBACRoleBinding.

Parameter
Name Description
request CreateScopeRBACRoleBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteFeature(DeleteFeatureRequest request)

public Operation deleteFeature(DeleteFeatureRequest request)

Removes a Feature.

Parameter
Name Description
request DeleteFeatureRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteFleet(DeleteFleetRequest request)

public Operation deleteFleet(DeleteFleetRequest request)

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

Parameter
Name Description
request DeleteFleetRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteMembership(DeleteMembershipRequest request)

public Operation deleteMembership(DeleteMembershipRequest request)

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.

Parameter
Name Description
request DeleteMembershipRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteMembershipBinding(DeleteMembershipBindingRequest request)

public Operation deleteMembershipBinding(DeleteMembershipBindingRequest request)

Deletes a MembershipBinding.

Parameter
Name Description
request DeleteMembershipBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteMembershipRBACRoleBinding(DeleteMembershipRBACRoleBindingRequest request)

public Operation deleteMembershipRBACRoleBinding(DeleteMembershipRBACRoleBindingRequest request)

Deletes a Membership RBACRoleBinding.

Parameter
Name Description
request DeleteMembershipRBACRoleBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteScope(DeleteScopeRequest request)

public Operation deleteScope(DeleteScopeRequest request)

Deletes a Scope.

Parameter
Name Description
request DeleteScopeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteScopeNamespace(DeleteScopeNamespaceRequest request)

public Operation deleteScopeNamespace(DeleteScopeNamespaceRequest request)

Deletes a fleet namespace.

Parameter
Name Description
request DeleteScopeNamespaceRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteScopeRBACRoleBinding(DeleteScopeRBACRoleBindingRequest request)

public Operation deleteScopeRBACRoleBinding(DeleteScopeRBACRoleBindingRequest request)

Deletes a Scope RBACRoleBinding.

Parameter
Name Description
request DeleteScopeRBACRoleBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

generateConnectManifest(GenerateConnectManifestRequest request)

public GenerateConnectManifestResponse generateConnectManifest(GenerateConnectManifestRequest request)

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.

Parameter
Name Description
request GenerateConnectManifestRequest
Returns
Type Description
GenerateConnectManifestResponse
Exceptions
Type Description
io.grpc.StatusException

generateMembershipRBACRoleBindingYAML(GenerateMembershipRBACRoleBindingYAMLRequest request)

public GenerateMembershipRBACRoleBindingYAMLResponse generateMembershipRBACRoleBindingYAML(GenerateMembershipRBACRoleBindingYAMLRequest request)

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

Parameter
Name Description
request GenerateMembershipRBACRoleBindingYAMLRequest
Returns
Type Description
GenerateMembershipRBACRoleBindingYAMLResponse
Exceptions
Type Description
io.grpc.StatusException

getFeature(GetFeatureRequest request)

public Feature getFeature(GetFeatureRequest request)

Gets details of a single Feature.

Parameter
Name Description
request GetFeatureRequest
Returns
Type Description
Feature
Exceptions
Type Description
io.grpc.StatusException

getFleet(GetFleetRequest request)

public Fleet getFleet(GetFleetRequest request)

Returns the details of a fleet.

Parameter
Name Description
request GetFleetRequest
Returns
Type Description
Fleet
Exceptions
Type Description
io.grpc.StatusException

getMembership(GetMembershipRequest request)

public Membership getMembership(GetMembershipRequest request)

Gets the details of a Membership.

Parameter
Name Description
request GetMembershipRequest
Returns
Type Description
Membership
Exceptions
Type Description
io.grpc.StatusException

getMembershipBinding(GetMembershipBindingRequest request)

public MembershipBinding getMembershipBinding(GetMembershipBindingRequest request)

Returns the details of a MembershipBinding.

Parameter
Name Description
request GetMembershipBindingRequest
Returns
Type Description
MembershipBinding
Exceptions
Type Description
io.grpc.StatusException

getMembershipRBACRoleBinding(GetMembershipRBACRoleBindingRequest request)

public RBACRoleBinding getMembershipRBACRoleBinding(GetMembershipRBACRoleBindingRequest request)

Returns the details of a Membership RBACRoleBinding.

Parameter
Name Description
request GetMembershipRBACRoleBindingRequest
Returns
Type Description
RBACRoleBinding
Exceptions
Type Description
io.grpc.StatusException

getScope(GetScopeRequest request)

public Scope getScope(GetScopeRequest request)

Returns the details of a Scope.

Parameter
Name Description
request GetScopeRequest
Returns
Type Description
Scope
Exceptions
Type Description
io.grpc.StatusException

getScopeNamespace(GetScopeNamespaceRequest request)

public Namespace getScopeNamespace(GetScopeNamespaceRequest request)

Returns the details of a fleet namespace.

Parameter
Name Description
request GetScopeNamespaceRequest
Returns
Type Description
Namespace
Exceptions
Type Description
io.grpc.StatusException

getScopeRBACRoleBinding(GetScopeRBACRoleBindingRequest request)

public RBACRoleBinding getScopeRBACRoleBinding(GetScopeRBACRoleBindingRequest request)

Returns the details of a Scope RBACRoleBinding.

Parameter
Name Description
request GetScopeRBACRoleBindingRequest
Returns
Type Description
RBACRoleBinding
Exceptions
Type Description
io.grpc.StatusException

listBoundMemberships(ListBoundMembershipsRequest request)

public ListBoundMembershipsResponse listBoundMemberships(ListBoundMembershipsRequest request)

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

Parameter
Name Description
request ListBoundMembershipsRequest
Returns
Type Description
ListBoundMembershipsResponse
Exceptions
Type Description
io.grpc.StatusException

listFeatures(ListFeaturesRequest request)

public ListFeaturesResponse listFeatures(ListFeaturesRequest request)

Lists Features in a given project and location.

Parameter
Name Description
request ListFeaturesRequest
Returns
Type Description
ListFeaturesResponse
Exceptions
Type Description
io.grpc.StatusException

listFleets(ListFleetsRequest request)

public ListFleetsResponse listFleets(ListFleetsRequest request)

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

Parameter
Name Description
request ListFleetsRequest
Returns
Type Description
ListFleetsResponse
Exceptions
Type Description
io.grpc.StatusException

listMembershipBindings(ListMembershipBindingsRequest request)

public ListMembershipBindingsResponse listMembershipBindings(ListMembershipBindingsRequest request)

Lists MembershipBindings.

Parameter
Name Description
request ListMembershipBindingsRequest
Returns
Type Description
ListMembershipBindingsResponse
Exceptions
Type Description
io.grpc.StatusException

listMembershipRBACRoleBindings(ListMembershipRBACRoleBindingsRequest request)

public ListMembershipRBACRoleBindingsResponse listMembershipRBACRoleBindings(ListMembershipRBACRoleBindingsRequest request)

Lists all Membership RBACRoleBindings.

Parameter
Name Description
request ListMembershipRBACRoleBindingsRequest
Returns
Type Description
ListMembershipRBACRoleBindingsResponse
Exceptions
Type Description
io.grpc.StatusException

listMemberships(ListMembershipsRequest request)

public ListMembershipsResponse listMemberships(ListMembershipsRequest request)

Lists Memberships in a given project and location.

Parameter
Name Description
request ListMembershipsRequest
Returns
Type Description
ListMembershipsResponse
Exceptions
Type Description
io.grpc.StatusException

listPermittedScopes(ListPermittedScopesRequest request)

public ListPermittedScopesResponse listPermittedScopes(ListPermittedScopesRequest request)

Lists permitted Scopes.

Parameter
Name Description
request ListPermittedScopesRequest
Returns
Type Description
ListPermittedScopesResponse
Exceptions
Type Description
io.grpc.StatusException

listScopeNamespaces(ListScopeNamespacesRequest request)

public ListScopeNamespacesResponse listScopeNamespaces(ListScopeNamespacesRequest request)

Lists fleet namespaces.

Parameter
Name Description
request ListScopeNamespacesRequest
Returns
Type Description
ListScopeNamespacesResponse
Exceptions
Type Description
io.grpc.StatusException

listScopeRBACRoleBindings(ListScopeRBACRoleBindingsRequest request)

public ListScopeRBACRoleBindingsResponse listScopeRBACRoleBindings(ListScopeRBACRoleBindingsRequest request)

Lists all Scope RBACRoleBindings.

Parameter
Name Description
request ListScopeRBACRoleBindingsRequest
Returns
Type Description
ListScopeRBACRoleBindingsResponse
Exceptions
Type Description
io.grpc.StatusException

listScopes(ListScopesRequest request)

public ListScopesResponse listScopes(ListScopesRequest request)

Lists Scopes.

Parameter
Name Description
request ListScopesRequest
Returns
Type Description
ListScopesResponse
Exceptions
Type Description
io.grpc.StatusException

updateFeature(UpdateFeatureRequest request)

public Operation updateFeature(UpdateFeatureRequest request)

Updates an existing Feature.

Parameter
Name Description
request UpdateFeatureRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateFleet(UpdateFleetRequest request)

public Operation updateFleet(UpdateFleetRequest request)

Updates a fleet.

Parameter
Name Description
request UpdateFleetRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateMembership(UpdateMembershipRequest request)

public Operation updateMembership(UpdateMembershipRequest request)

Updates an existing Membership.

Parameter
Name Description
request UpdateMembershipRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateMembershipBinding(UpdateMembershipBindingRequest request)

public Operation updateMembershipBinding(UpdateMembershipBindingRequest request)

Updates a MembershipBinding.

Parameter
Name Description
request UpdateMembershipBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateMembershipRBACRoleBinding(UpdateMembershipRBACRoleBindingRequest request)

public Operation updateMembershipRBACRoleBinding(UpdateMembershipRBACRoleBindingRequest request)

Updates a Membership RBACRoleBinding.

Parameter
Name Description
request UpdateMembershipRBACRoleBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateScope(UpdateScopeRequest request)

public Operation updateScope(UpdateScopeRequest request)

Updates a scopes.

Parameter
Name Description
request UpdateScopeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateScopeNamespace(UpdateScopeNamespaceRequest request)

public Operation updateScopeNamespace(UpdateScopeNamespaceRequest request)

Updates a fleet namespace.

Parameter
Name Description
request UpdateScopeNamespaceRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateScopeRBACRoleBinding(UpdateScopeRBACRoleBindingRequest request)

public Operation updateScopeRBACRoleBinding(UpdateScopeRBACRoleBindingRequest request)

Updates a Scope RBACRoleBinding.

Parameter
Name Description
request UpdateScopeRBACRoleBindingRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException