GKE Hub v1 API - Class GkeHubClientImpl (2.4.0)

Version latest

• 2.4.0 (latest)
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.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

Inherited Members

GkeHubClient.DefaultEndpoint

GkeHubClient.DefaultScopes

GkeHubClient.ServiceMetadata

GkeHubClient.CreateAsync(CancellationToken)

GkeHubClient.Create()

GkeHubClient.ShutdownDefaultChannelsAsync()

GkeHubClient.ListMemberships(string, string, int?, CallSettings)

GkeHubClient.ListMembershipsAsync(string, string, int?, CallSettings)

GkeHubClient.ListMemberships(LocationName, string, int?, CallSettings)

GkeHubClient.ListMembershipsAsync(LocationName, string, int?, CallSettings)

GkeHubClient.ListFeatures(string, string, int?, CallSettings)

GkeHubClient.ListFeaturesAsync(string, string, int?, CallSettings)

GkeHubClient.ListFeatures(LocationName, string, int?, CallSettings)

GkeHubClient.ListFeaturesAsync(LocationName, string, int?, CallSettings)

GkeHubClient.GetMembershipAsync(GetMembershipRequest, CancellationToken)

GkeHubClient.GetMembership(string, CallSettings)

GkeHubClient.GetMembershipAsync(string, CallSettings)

GkeHubClient.GetMembershipAsync(string, CancellationToken)

GkeHubClient.GetMembership(MembershipName, CallSettings)

GkeHubClient.GetMembershipAsync(MembershipName, CallSettings)

GkeHubClient.GetMembershipAsync(MembershipName, CancellationToken)

GkeHubClient.GetFeatureAsync(GetFeatureRequest, CancellationToken)

GkeHubClient.GetFeature(string, CallSettings)

GkeHubClient.GetFeatureAsync(string, CallSettings)

GkeHubClient.GetFeatureAsync(string, CancellationToken)

GkeHubClient.GetFeature(FeatureName, CallSettings)

GkeHubClient.GetFeatureAsync(FeatureName, CallSettings)

GkeHubClient.GetFeatureAsync(FeatureName, CancellationToken)

GkeHubClient.CreateMembershipAsync(CreateMembershipRequest, CancellationToken)

GkeHubClient.PollOnceCreateMembership(string, CallSettings)

GkeHubClient.PollOnceCreateMembershipAsync(string, CallSettings)

GkeHubClient.CreateMembership(string, Membership, string, CallSettings)

GkeHubClient.CreateMembershipAsync(string, Membership, string, CallSettings)

GkeHubClient.CreateMembershipAsync(string, Membership, string, CancellationToken)

GkeHubClient.CreateMembership(LocationName, Membership, string, CallSettings)

GkeHubClient.CreateMembershipAsync(LocationName, Membership, string, CallSettings)

GkeHubClient.CreateMembershipAsync(LocationName, Membership, string, CancellationToken)

GkeHubClient.CreateFeatureAsync(CreateFeatureRequest, CancellationToken)

GkeHubClient.PollOnceCreateFeature(string, CallSettings)

GkeHubClient.PollOnceCreateFeatureAsync(string, CallSettings)

GkeHubClient.CreateFeature(string, Feature, string, CallSettings)

GkeHubClient.CreateFeatureAsync(string, Feature, string, CallSettings)

GkeHubClient.CreateFeatureAsync(string, Feature, string, CancellationToken)

GkeHubClient.CreateFeature(LocationName, Feature, string, CallSettings)

GkeHubClient.CreateFeatureAsync(LocationName, Feature, string, CallSettings)

GkeHubClient.CreateFeatureAsync(LocationName, Feature, string, CancellationToken)

GkeHubClient.DeleteMembershipAsync(DeleteMembershipRequest, CancellationToken)

GkeHubClient.PollOnceDeleteMembership(string, CallSettings)

GkeHubClient.PollOnceDeleteMembershipAsync(string, CallSettings)

GkeHubClient.DeleteMembership(string, CallSettings)

GkeHubClient.DeleteMembershipAsync(string, CallSettings)

GkeHubClient.DeleteMembershipAsync(string, CancellationToken)

GkeHubClient.DeleteMembership(MembershipName, CallSettings)

GkeHubClient.DeleteMembershipAsync(MembershipName, CallSettings)

GkeHubClient.DeleteMembershipAsync(MembershipName, CancellationToken)

GkeHubClient.DeleteFeatureAsync(DeleteFeatureRequest, CancellationToken)

GkeHubClient.PollOnceDeleteFeature(string, CallSettings)

GkeHubClient.PollOnceDeleteFeatureAsync(string, CallSettings)

GkeHubClient.DeleteFeature(string, CallSettings)

GkeHubClient.DeleteFeatureAsync(string, CallSettings)

GkeHubClient.DeleteFeatureAsync(string, CancellationToken)

GkeHubClient.DeleteFeature(FeatureName, CallSettings)

GkeHubClient.DeleteFeatureAsync(FeatureName, CallSettings)

GkeHubClient.DeleteFeatureAsync(FeatureName, CancellationToken)

GkeHubClient.UpdateMembershipAsync(UpdateMembershipRequest, CancellationToken)

GkeHubClient.PollOnceUpdateMembership(string, CallSettings)

GkeHubClient.PollOnceUpdateMembershipAsync(string, CallSettings)

GkeHubClient.UpdateMembership(string, Membership, FieldMask, CallSettings)

GkeHubClient.UpdateMembershipAsync(string, Membership, FieldMask, CallSettings)

GkeHubClient.UpdateMembershipAsync(string, Membership, FieldMask, CancellationToken)

GkeHubClient.UpdateMembership(MembershipName, Membership, FieldMask, CallSettings)

GkeHubClient.UpdateMembershipAsync(MembershipName, Membership, FieldMask, CallSettings)

GkeHubClient.UpdateMembershipAsync(MembershipName, Membership, FieldMask, CancellationToken)

GkeHubClient.UpdateFeatureAsync(UpdateFeatureRequest, CancellationToken)

GkeHubClient.PollOnceUpdateFeature(string, CallSettings)

GkeHubClient.PollOnceUpdateFeatureAsync(string, CallSettings)

GkeHubClient.UpdateFeature(string, Feature, FieldMask, CallSettings)

GkeHubClient.UpdateFeatureAsync(string, Feature, FieldMask, CallSettings)

GkeHubClient.UpdateFeatureAsync(string, Feature, FieldMask, CancellationToken)

GkeHubClient.UpdateFeature(FeatureName, Feature, FieldMask, CallSettings)

GkeHubClient.UpdateFeatureAsync(FeatureName, Feature, FieldMask, CallSettings)

GkeHubClient.UpdateFeatureAsync(FeatureName, Feature, FieldMask, CancellationToken)

GkeHubClient.GenerateConnectManifestAsync(GenerateConnectManifestRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

GkeHubClient.CreateFeatureOperationsClient

CreateMembershipOperationsClient

public override OperationsClient CreateMembershipOperationsClient { get; }

The long-running operations client for CreateMembership.

Property Value
Type	Description
OperationsClient

Overrides

GkeHubClient.CreateMembershipOperationsClient

DeleteFeatureOperationsClient

public override OperationsClient DeleteFeatureOperationsClient { get; }

The long-running operations client for DeleteFeature.

Property Value
Type	Description
OperationsClient

Overrides

GkeHubClient.DeleteFeatureOperationsClient

DeleteMembershipOperationsClient

public override OperationsClient DeleteMembershipOperationsClient { get; }

The long-running operations client for DeleteMembership.

Property Value
Type	Description
OperationsClient

Overrides

GkeHubClient.DeleteMembershipOperationsClient

GrpcClient

public override GkeHub.GkeHubClient GrpcClient { get; }

The underlying gRPC GkeHub client

Property Value
Type	Description
GkeHubGkeHubClient

Overrides

GkeHubClient.GrpcClient

UpdateFeatureOperationsClient

public override OperationsClient UpdateFeatureOperationsClient { get; }

The long-running operations client for UpdateFeature.

Property Value
Type	Description
OperationsClient

Overrides

GkeHubClient.UpdateFeatureOperationsClient

UpdateMembershipOperationsClient

public override OperationsClient UpdateMembershipOperationsClient { get; }

The long-running operations client for UpdateMembership.

Property Value
Type	Description
OperationsClient

Overrides

GkeHubClient.UpdateMembershipOperationsClient

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

GkeHubClient.CreateFeature(CreateFeatureRequest, CallSettings)

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

GkeHubClient.CreateFeatureAsync(CreateFeatureRequest, CallSettings)

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

GkeHubClient.CreateMembership(CreateMembershipRequest, CallSettings)

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

GkeHubClient.CreateMembershipAsync(CreateMembershipRequest, CallSettings)

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

GkeHubClient.DeleteFeature(DeleteFeatureRequest, CallSettings)

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

GkeHubClient.DeleteFeatureAsync(DeleteFeatureRequest, CallSettings)

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

GkeHubClient.DeleteMembership(DeleteMembershipRequest, CallSettings)

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

GkeHubClient.DeleteMembershipAsync(DeleteMembershipRequest, CallSettings)

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

GkeHubClient.GenerateConnectManifest(GenerateConnectManifestRequest, CallSettings)

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

GkeHubClient.GenerateConnectManifestAsync(GenerateConnectManifestRequest, CallSettings)

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

GkeHubClient.GetFeature(GetFeatureRequest, CallSettings)

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

GkeHubClient.GetFeatureAsync(GetFeatureRequest, CallSettings)

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

GkeHubClient.GetMembership(GetMembershipRequest, CallSettings)

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

GkeHubClient.GetMembershipAsync(GetMembershipRequest, CallSettings)

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

GkeHubClient.ListFeatures(ListFeaturesRequest, CallSettings)

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

GkeHubClient.ListFeaturesAsync(ListFeaturesRequest, CallSettings)

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

GkeHubClient.ListMemberships(ListMembershipsRequest, CallSettings)

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

GkeHubClient.ListMembershipsAsync(ListMembershipsRequest, CallSettings)

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

GkeHubClient.UpdateFeature(UpdateFeatureRequest, CallSettings)

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

GkeHubClient.UpdateFeatureAsync(UpdateFeatureRequest, CallSettings)

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

GkeHubClient.UpdateMembership(UpdateMembershipRequest, CallSettings)

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

GkeHubClient.UpdateMembershipAsync(UpdateMembershipRequest, CallSettings)