GKE Hub v1 API - Class GkeHub.GkeHubBase (2.8.0)

[BindServiceMethod(typeof(GkeHub), "BindService")]
public abstract class GkeHub.GkeHubBase

Reference documentation and code samples for the GKE Hub v1 API class GkeHub.GkeHubBase.

Base class for server-side implementations of GkeHub

Inheritance

object > GkeHub.GkeHubBase

Namespace

Google.Cloud.GkeHub.V1

Assembly

Google.Cloud.GkeHub.V1.dll

Methods

CreateFeature(CreateFeatureRequest, ServerCallContext)

public virtual Task<Operation> CreateFeature(CreateFeatureRequest request, ServerCallContext context)

Adds a new Feature.

Parameters
Name Description
request CreateFeatureRequest

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).

CreateFleet(CreateFleetRequest, ServerCallContext)

public virtual Task<Operation> CreateFleet(CreateFleetRequest request, ServerCallContext context)

Creates a fleet.

Parameters
Name Description
request CreateFleetRequest

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).

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).

CreateMembershipBinding(CreateMembershipBindingRequest, ServerCallContext)

public virtual Task<Operation> CreateMembershipBinding(CreateMembershipBindingRequest request, ServerCallContext context)

Creates a MembershipBinding.

Parameters
Name Description
request CreateMembershipBindingRequest

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).

CreateMembershipRBACRoleBinding(CreateMembershipRBACRoleBindingRequest, ServerCallContext)

public virtual Task<Operation> CreateMembershipRBACRoleBinding(CreateMembershipRBACRoleBindingRequest request, ServerCallContext context)

Creates a Membership RBACRoleBinding.

Parameters
Name Description
request CreateMembershipRBACRoleBindingRequest

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).

CreateScope(CreateScopeRequest, ServerCallContext)

public virtual Task<Operation> CreateScope(CreateScopeRequest request, ServerCallContext context)

Creates a Scope.

Parameters
Name Description
request CreateScopeRequest

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).

CreateScopeNamespace(CreateScopeNamespaceRequest, ServerCallContext)

public virtual Task<Operation> CreateScopeNamespace(CreateScopeNamespaceRequest request, ServerCallContext context)

Creates a fleet namespace.

Parameters
Name Description
request CreateScopeNamespaceRequest

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).

CreateScopeRBACRoleBinding(CreateScopeRBACRoleBindingRequest, ServerCallContext)

public virtual Task<Operation> CreateScopeRBACRoleBinding(CreateScopeRBACRoleBindingRequest request, ServerCallContext context)

Creates a Scope RBACRoleBinding.

Parameters
Name Description
request CreateScopeRBACRoleBindingRequest

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).

DeleteFeature(DeleteFeatureRequest, ServerCallContext)

public virtual Task<Operation> DeleteFeature(DeleteFeatureRequest request, ServerCallContext context)

Removes a Feature.

Parameters
Name Description
request DeleteFeatureRequest

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).

DeleteFleet(DeleteFleetRequest, ServerCallContext)

public virtual Task<Operation> DeleteFleet(DeleteFleetRequest request, ServerCallContext context)

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

Parameters
Name Description
request DeleteFleetRequest

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).

DeleteMembershipBinding(DeleteMembershipBindingRequest, ServerCallContext)

public virtual Task<Operation> DeleteMembershipBinding(DeleteMembershipBindingRequest request, ServerCallContext context)

Deletes a MembershipBinding.

Parameters
Name Description
request DeleteMembershipBindingRequest

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).

DeleteMembershipRBACRoleBinding(DeleteMembershipRBACRoleBindingRequest, ServerCallContext)

public virtual Task<Operation> DeleteMembershipRBACRoleBinding(DeleteMembershipRBACRoleBindingRequest request, ServerCallContext context)

Deletes a Membership RBACRoleBinding.

Parameters
Name Description
request DeleteMembershipRBACRoleBindingRequest

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).

DeleteScope(DeleteScopeRequest, ServerCallContext)

public virtual Task<Operation> DeleteScope(DeleteScopeRequest request, ServerCallContext context)

Deletes a Scope.

Parameters
Name Description
request DeleteScopeRequest

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).

DeleteScopeNamespace(DeleteScopeNamespaceRequest, ServerCallContext)

public virtual Task<Operation> DeleteScopeNamespace(DeleteScopeNamespaceRequest request, ServerCallContext context)

Deletes a fleet namespace.

Parameters
Name Description
request DeleteScopeNamespaceRequest

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).

DeleteScopeRBACRoleBinding(DeleteScopeRBACRoleBindingRequest, ServerCallContext)

public virtual Task<Operation> DeleteScopeRBACRoleBinding(DeleteScopeRBACRoleBindingRequest request, ServerCallContext context)

Deletes a Scope RBACRoleBinding.

Parameters
Name Description
request DeleteScopeRBACRoleBindingRequest

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).

GenerateMembershipRBACRoleBindingYAML(GenerateMembershipRBACRoleBindingYAMLRequest, ServerCallContext)

public virtual Task<GenerateMembershipRBACRoleBindingYAMLResponse> GenerateMembershipRBACRoleBindingYAML(GenerateMembershipRBACRoleBindingYAMLRequest request, ServerCallContext context)

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

Parameters
Name Description
request GenerateMembershipRBACRoleBindingYAMLRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskGenerateMembershipRBACRoleBindingYAMLResponse

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

GetFeature(GetFeatureRequest, ServerCallContext)

public virtual Task<Feature> GetFeature(GetFeatureRequest request, ServerCallContext context)

Gets details of a single Feature.

Parameters
Name Description
request GetFeatureRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFeature

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

GetFleet(GetFleetRequest, ServerCallContext)

public virtual Task<Fleet> GetFleet(GetFleetRequest request, ServerCallContext context)

Returns the details of a fleet.

Parameters
Name Description
request GetFleetRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFleet

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).

GetMembershipBinding(GetMembershipBindingRequest, ServerCallContext)

public virtual Task<MembershipBinding> GetMembershipBinding(GetMembershipBindingRequest request, ServerCallContext context)

Returns the details of a MembershipBinding.

Parameters
Name Description
request GetMembershipBindingRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskMembershipBinding

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

GetMembershipRBACRoleBinding(GetMembershipRBACRoleBindingRequest, ServerCallContext)

public virtual Task<RBACRoleBinding> GetMembershipRBACRoleBinding(GetMembershipRBACRoleBindingRequest request, ServerCallContext context)

Returns the details of a Membership RBACRoleBinding.

Parameters
Name Description
request GetMembershipRBACRoleBindingRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRBACRoleBinding

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

GetScope(GetScopeRequest, ServerCallContext)

public virtual Task<Scope> GetScope(GetScopeRequest request, ServerCallContext context)

Returns the details of a Scope.

Parameters
Name Description
request GetScopeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskScope

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

GetScopeNamespace(GetScopeNamespaceRequest, ServerCallContext)

public virtual Task<Namespace> GetScopeNamespace(GetScopeNamespaceRequest request, ServerCallContext context)

Returns the details of a fleet namespace.

Parameters
Name Description
request GetScopeNamespaceRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskNamespace

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

GetScopeRBACRoleBinding(GetScopeRBACRoleBindingRequest, ServerCallContext)

public virtual Task<RBACRoleBinding> GetScopeRBACRoleBinding(GetScopeRBACRoleBindingRequest request, ServerCallContext context)

Returns the details of a Scope RBACRoleBinding.

Parameters
Name Description
request GetScopeRBACRoleBindingRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRBACRoleBinding

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

ListBoundMemberships(ListBoundMembershipsRequest, ServerCallContext)

public virtual Task<ListBoundMembershipsResponse> ListBoundMemberships(ListBoundMembershipsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListBoundMembershipsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListBoundMembershipsResponse

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

ListFeatures(ListFeaturesRequest, ServerCallContext)

public virtual Task<ListFeaturesResponse> ListFeatures(ListFeaturesRequest request, ServerCallContext context)

Lists Features in a given project and location.

Parameters
Name Description
request ListFeaturesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListFeaturesResponse

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

ListFleets(ListFleetsRequest, ServerCallContext)

public virtual Task<ListFleetsResponse> ListFleets(ListFleetsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListFleetsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListFleetsResponse

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

ListMembershipBindings(ListMembershipBindingsRequest, ServerCallContext)

public virtual Task<ListMembershipBindingsResponse> ListMembershipBindings(ListMembershipBindingsRequest request, ServerCallContext context)

Lists MembershipBindings.

Parameters
Name Description
request ListMembershipBindingsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListMembershipBindingsResponse

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

ListMembershipRBACRoleBindings(ListMembershipRBACRoleBindingsRequest, ServerCallContext)

public virtual Task<ListMembershipRBACRoleBindingsResponse> ListMembershipRBACRoleBindings(ListMembershipRBACRoleBindingsRequest request, ServerCallContext context)

Lists all Membership RBACRoleBindings.

Parameters
Name Description
request ListMembershipRBACRoleBindingsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListMembershipRBACRoleBindingsResponse

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).

ListPermittedScopes(ListPermittedScopesRequest, ServerCallContext)

public virtual Task<ListPermittedScopesResponse> ListPermittedScopes(ListPermittedScopesRequest request, ServerCallContext context)

Lists permitted Scopes.

Parameters
Name Description
request ListPermittedScopesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListPermittedScopesResponse

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

ListScopeNamespaces(ListScopeNamespacesRequest, ServerCallContext)

public virtual Task<ListScopeNamespacesResponse> ListScopeNamespaces(ListScopeNamespacesRequest request, ServerCallContext context)

Lists fleet namespaces.

Parameters
Name Description
request ListScopeNamespacesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListScopeNamespacesResponse

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

ListScopeRBACRoleBindings(ListScopeRBACRoleBindingsRequest, ServerCallContext)

public virtual Task<ListScopeRBACRoleBindingsResponse> ListScopeRBACRoleBindings(ListScopeRBACRoleBindingsRequest request, ServerCallContext context)

Lists all Scope RBACRoleBindings.

Parameters
Name Description
request ListScopeRBACRoleBindingsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListScopeRBACRoleBindingsResponse

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

ListScopes(ListScopesRequest, ServerCallContext)

public virtual Task<ListScopesResponse> ListScopes(ListScopesRequest request, ServerCallContext context)

Lists Scopes.

Parameters
Name Description
request ListScopesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListScopesResponse

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

UpdateFeature(UpdateFeatureRequest, ServerCallContext)

public virtual Task<Operation> UpdateFeature(UpdateFeatureRequest request, ServerCallContext context)

Updates an existing Feature.

Parameters
Name Description
request UpdateFeatureRequest

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).

UpdateFleet(UpdateFleetRequest, ServerCallContext)

public virtual Task<Operation> UpdateFleet(UpdateFleetRequest request, ServerCallContext context)

Updates a fleet.

Parameters
Name Description
request UpdateFleetRequest

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).

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).

UpdateMembershipBinding(UpdateMembershipBindingRequest, ServerCallContext)

public virtual Task<Operation> UpdateMembershipBinding(UpdateMembershipBindingRequest request, ServerCallContext context)

Updates a MembershipBinding.

Parameters
Name Description
request UpdateMembershipBindingRequest

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).

UpdateMembershipRBACRoleBinding(UpdateMembershipRBACRoleBindingRequest, ServerCallContext)

public virtual Task<Operation> UpdateMembershipRBACRoleBinding(UpdateMembershipRBACRoleBindingRequest request, ServerCallContext context)

Updates a Membership RBACRoleBinding.

Parameters
Name Description
request UpdateMembershipRBACRoleBindingRequest

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).

UpdateScope(UpdateScopeRequest, ServerCallContext)

public virtual Task<Operation> UpdateScope(UpdateScopeRequest request, ServerCallContext context)

Updates a scopes.

Parameters
Name Description
request UpdateScopeRequest

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).

UpdateScopeNamespace(UpdateScopeNamespaceRequest, ServerCallContext)

public virtual Task<Operation> UpdateScopeNamespace(UpdateScopeNamespaceRequest request, ServerCallContext context)

Updates a fleet namespace.

Parameters
Name Description
request UpdateScopeNamespaceRequest

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).

UpdateScopeRBACRoleBinding(UpdateScopeRBACRoleBindingRequest, ServerCallContext)

public virtual Task<Operation> UpdateScopeRBACRoleBinding(UpdateScopeRBACRoleBindingRequest request, ServerCallContext context)

Updates a Scope RBACRoleBinding.

Parameters
Name Description
request UpdateScopeRBACRoleBindingRequest

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).