GKE Hub v1 API - Class GkeHubClientImpl (2.5.0) 

public sealed class GkeHubClientImpl : GkeHubClient

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

GkeHub client wrapper implementation, for convenient use.

Inheritance

object > GkeHubClient > GkeHubClientImpl

Namespace

Google.Cloud.GkeHub.V1

Assembly

Google.Cloud.GkeHub.V1.dll

Remarks

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][google.cloud.gkehub.v1.Membership]
  • [Feature][google.cloud.gkehub.v1.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.

Constructors

GkeHubClientImpl(GkeHubClient, GkeHubSettings, ILogger)

public GkeHubClientImpl(GkeHub.GkeHubClient grpcClient, GkeHubSettings settings, ILogger logger)

Constructs a client wrapper for the GkeHub service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient GkeHubGkeHubClient

The underlying gRPC client.
settings GkeHubSettings

The base GkeHubSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateFeatureOperationsClient

public override OperationsClient CreateFeatureOperationsClient { get; }

The long-running operations client for CreateFeature.

Property Value
Type Description
OperationsClient
Overrides

CreateMembershipOperationsClient

public override OperationsClient CreateMembershipOperationsClient { get; }

The long-running operations client for CreateMembership.

Property Value
Type Description
OperationsClient
Overrides

DeleteFeatureOperationsClient

public override OperationsClient DeleteFeatureOperationsClient { get; }

The long-running operations client for DeleteFeature.

Property Value
Type Description
OperationsClient
Overrides

DeleteMembershipOperationsClient

public override OperationsClient DeleteMembershipOperationsClient { get; }

The long-running operations client for DeleteMembership.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override GkeHub.GkeHubClient GrpcClient { get; }

The underlying gRPC GkeHub client

Property Value
Type Description
GkeHubGkeHubClient
Overrides

UpdateFeatureOperationsClient

public override OperationsClient UpdateFeatureOperationsClient { get; }

The long-running operations client for UpdateFeature.

Property Value
Type Description
OperationsClient
Overrides

UpdateMembershipOperationsClient

public override OperationsClient UpdateMembershipOperationsClient { get; }

The long-running operations client for UpdateMembership.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateFeature(CreateFeatureRequest, CallSettings)

public override Operation<Feature, OperationMetadata> CreateFeature(CreateFeatureRequest request, CallSettings callSettings = null)

Adds a new Feature.

Parameters
Name Description
request CreateFeatureRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFeatureOperationMetadata

The RPC response.
Overrides

CreateFeatureAsync(CreateFeatureRequest, CallSettings)

public override Task<Operation<Feature, OperationMetadata>> CreateFeatureAsync(CreateFeatureRequest request, CallSettings callSettings = null)

Adds a new Feature.

Parameters
Name Description
request CreateFeatureRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFeatureOperationMetadata

A Task containing the RPC response.
Overrides

CreateMembership(CreateMembershipRequest, CallSettings)

public override Operation<Membership, OperationMetadata> CreateMembership(CreateMembershipRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationMembershipOperationMetadata

The RPC response.
Overrides

CreateMembershipAsync(CreateMembershipRequest, CallSettings)

public override Task<Operation<Membership, OperationMetadata>> CreateMembershipAsync(CreateMembershipRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationMembershipOperationMetadata

A Task containing the RPC response.
Overrides

DeleteFeature(DeleteFeatureRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteFeature(DeleteFeatureRequest request, CallSettings callSettings = null)

Removes a Feature.

Parameters
Name Description
request DeleteFeatureRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteFeatureAsync(DeleteFeatureRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteFeatureAsync(DeleteFeatureRequest request, CallSettings callSettings = null)

Removes a Feature.

Parameters
Name Description
request DeleteFeatureRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteMembership(DeleteMembershipRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteMembership(DeleteMembershipRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteMembershipAsync(DeleteMembershipRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteMembershipAsync(DeleteMembershipRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GenerateConnectManifest(GenerateConnectManifestRequest, CallSettings)

public override GenerateConnectManifestResponse GenerateConnectManifest(GenerateConnectManifestRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateConnectManifestResponse

The RPC response.
Overrides

GenerateConnectManifestAsync(GenerateConnectManifestRequest, CallSettings)

public override Task<GenerateConnectManifestResponse> GenerateConnectManifestAsync(GenerateConnectManifestRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateConnectManifestResponse

A Task containing the RPC response.
Overrides

GetFeature(GetFeatureRequest, CallSettings)

public override Feature GetFeature(GetFeatureRequest request, CallSettings callSettings = null)

Gets details of a single Feature.

Parameters
Name Description
request GetFeatureRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Feature

The RPC response.
Overrides

GetFeatureAsync(GetFeatureRequest, CallSettings)

public override Task<Feature> GetFeatureAsync(GetFeatureRequest request, CallSettings callSettings = null)

Gets details of a single Feature.

Parameters
Name Description
request GetFeatureRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFeature

A Task containing the RPC response.
Overrides

GetMembership(GetMembershipRequest, CallSettings)

public override Membership GetMembership(GetMembershipRequest request, CallSettings callSettings = null)

Gets the details of a Membership.

Parameters
Name Description
request GetMembershipRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Membership

The RPC response.
Overrides

GetMembershipAsync(GetMembershipRequest, CallSettings)

public override Task<Membership> GetMembershipAsync(GetMembershipRequest request, CallSettings callSettings = null)

Gets the details of a Membership.

Parameters
Name Description
request GetMembershipRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskMembership

A Task containing the RPC response.
Overrides

ListFeatures(ListFeaturesRequest, CallSettings)

public override PagedEnumerable<ListFeaturesResponse, Feature> ListFeatures(ListFeaturesRequest request, CallSettings callSettings = null)

Lists Features in a given project and location.

Parameters
Name Description
request ListFeaturesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListFeaturesResponseFeature

A pageable sequence of Feature resources.
Overrides

ListFeaturesAsync(ListFeaturesRequest, CallSettings)

public override PagedAsyncEnumerable<ListFeaturesResponse, Feature> ListFeaturesAsync(ListFeaturesRequest request, CallSettings callSettings = null)

Lists Features in a given project and location.

Parameters
Name Description
request ListFeaturesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListFeaturesResponseFeature

A pageable asynchronous sequence of Feature resources.
Overrides

ListMemberships(ListMembershipsRequest, CallSettings)

public override PagedEnumerable<ListMembershipsResponse, Membership> ListMemberships(ListMembershipsRequest request, CallSettings callSettings = null)

Lists Memberships in a given project and location.

Parameters
Name Description
request ListMembershipsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListMembershipsResponseMembership

A pageable sequence of Membership resources.
Overrides

ListMembershipsAsync(ListMembershipsRequest, CallSettings)

public override PagedAsyncEnumerable<ListMembershipsResponse, Membership> ListMembershipsAsync(ListMembershipsRequest request, CallSettings callSettings = null)

Lists Memberships in a given project and location.

Parameters
Name Description
request ListMembershipsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListMembershipsResponseMembership

A pageable asynchronous sequence of Membership resources.
Overrides

UpdateFeature(UpdateFeatureRequest, CallSettings)

public override Operation<Feature, OperationMetadata> UpdateFeature(UpdateFeatureRequest request, CallSettings callSettings = null)

Updates an existing Feature.

Parameters
Name Description
request UpdateFeatureRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFeatureOperationMetadata

The RPC response.
Overrides

UpdateFeatureAsync(UpdateFeatureRequest, CallSettings)

public override Task<Operation<Feature, OperationMetadata>> UpdateFeatureAsync(UpdateFeatureRequest request, CallSettings callSettings = null)

Updates an existing Feature.

Parameters
Name Description
request UpdateFeatureRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFeatureOperationMetadata

A Task containing the RPC response.
Overrides

UpdateMembership(UpdateMembershipRequest, CallSettings)

public override Operation<Membership, OperationMetadata> UpdateMembership(UpdateMembershipRequest request, CallSettings callSettings = null)

Updates an existing Membership.

Parameters
Name Description
request UpdateMembershipRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationMembershipOperationMetadata

The RPC response.
Overrides

UpdateMembershipAsync(UpdateMembershipRequest, CallSettings)

public override Task<Operation<Membership, OperationMetadata>> UpdateMembershipAsync(UpdateMembershipRequest request, CallSettings callSettings = null)

Updates an existing Membership.

Parameters
Name Description
request UpdateMembershipRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationMembershipOperationMetadata

A Task containing the RPC response.
Overrides