public sealed class AttachedClustersClientImpl : AttachedClustersClient
Reference documentation and code samples for the Anthos Multi-Cloud v1 API class AttachedClustersClientImpl.
AttachedClusters client wrapper implementation, for convenient use.
Namespace
Google.Cloud.GkeMultiCloud.V1Assembly
Google.Cloud.GkeMultiCloud.V1.dll
Remarks
The AttachedClusters API provides a single centrally managed service to register and manage Anthos attached clusters that run on customer's owned infrastructure.
Constructors
AttachedClustersClientImpl(AttachedClustersClient, AttachedClustersSettings, ILogger)
public AttachedClustersClientImpl(AttachedClusters.AttachedClustersClient grpcClient, AttachedClustersSettings settings, ILogger logger)
Constructs a client wrapper for the AttachedClusters service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient |
AttachedClustersAttachedClustersClient The underlying gRPC client. |
settings |
AttachedClustersSettings The base AttachedClustersSettings used within this client. |
logger |
ILogger Optional ILogger to use within this client. |
Properties
CreateAttachedClusterOperationsClient
public override OperationsClient CreateAttachedClusterOperationsClient { get; }
The long-running operations client for CreateAttachedCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteAttachedClusterOperationsClient
public override OperationsClient DeleteAttachedClusterOperationsClient { get; }
The long-running operations client for DeleteAttachedCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override AttachedClusters.AttachedClustersClient GrpcClient { get; }
The underlying gRPC AttachedClusters client
Property Value | |
---|---|
Type | Description |
AttachedClustersAttachedClustersClient |
ImportAttachedClusterOperationsClient
public override OperationsClient ImportAttachedClusterOperationsClient { get; }
The long-running operations client for ImportAttachedCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateAttachedClusterOperationsClient
public override OperationsClient UpdateAttachedClusterOperationsClient { get; }
The long-running operations client for UpdateAttachedCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
CreateAttachedCluster(CreateAttachedClusterRequest, CallSettings)
public override Operation<AttachedCluster, OperationMetadata> CreateAttachedCluster(CreateAttachedClusterRequest request, CallSettings callSettings = null)
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
CreateAttachedClusterRequest 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 |
OperationAttachedClusterOperationMetadata |
The RPC response. |
CreateAttachedClusterAsync(CreateAttachedClusterRequest, CallSettings)
public override Task<Operation<AttachedCluster, OperationMetadata>> CreateAttachedClusterAsync(CreateAttachedClusterRequest request, CallSettings callSettings = null)
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
CreateAttachedClusterRequest 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 |
TaskOperationAttachedClusterOperationMetadata |
A Task containing the RPC response. |
DeleteAttachedCluster(DeleteAttachedClusterRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteAttachedCluster(DeleteAttachedClusterRequest request, CallSettings callSettings = null)
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
DeleteAttachedClusterRequest 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. |
DeleteAttachedClusterAsync(DeleteAttachedClusterRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteAttachedClusterAsync(DeleteAttachedClusterRequest request, CallSettings callSettings = null)
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
DeleteAttachedClusterRequest 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. |
GenerateAttachedClusterAgentToken(GenerateAttachedClusterAgentTokenRequest, CallSettings)
public override GenerateAttachedClusterAgentTokenResponse GenerateAttachedClusterAgentToken(GenerateAttachedClusterAgentTokenRequest request, CallSettings callSettings = null)
Generates an access token for a cluster agent.
Parameters | |
---|---|
Name | Description |
request |
GenerateAttachedClusterAgentTokenRequest 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 |
GenerateAttachedClusterAgentTokenResponse |
The RPC response. |
GenerateAttachedClusterAgentTokenAsync(GenerateAttachedClusterAgentTokenRequest, CallSettings)
public override Task<GenerateAttachedClusterAgentTokenResponse> GenerateAttachedClusterAgentTokenAsync(GenerateAttachedClusterAgentTokenRequest request, CallSettings callSettings = null)
Generates an access token for a cluster agent.
Parameters | |
---|---|
Name | Description |
request |
GenerateAttachedClusterAgentTokenRequest 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 |
TaskGenerateAttachedClusterAgentTokenResponse |
A Task containing the RPC response. |
GenerateAttachedClusterInstallManifest(GenerateAttachedClusterInstallManifestRequest, CallSettings)
public override GenerateAttachedClusterInstallManifestResponse GenerateAttachedClusterInstallManifest(GenerateAttachedClusterInstallManifestRequest request, CallSettings callSettings = null)
Generates the install manifest to be installed on the target cluster.
Parameters | |
---|---|
Name | Description |
request |
GenerateAttachedClusterInstallManifestRequest 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 |
GenerateAttachedClusterInstallManifestResponse |
The RPC response. |
GenerateAttachedClusterInstallManifestAsync(GenerateAttachedClusterInstallManifestRequest, CallSettings)
public override Task<GenerateAttachedClusterInstallManifestResponse> GenerateAttachedClusterInstallManifestAsync(GenerateAttachedClusterInstallManifestRequest request, CallSettings callSettings = null)
Generates the install manifest to be installed on the target cluster.
Parameters | |
---|---|
Name | Description |
request |
GenerateAttachedClusterInstallManifestRequest 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 |
TaskGenerateAttachedClusterInstallManifestResponse |
A Task containing the RPC response. |
GetAttachedCluster(GetAttachedClusterRequest, CallSettings)
public override AttachedCluster GetAttachedCluster(GetAttachedClusterRequest request, CallSettings callSettings = null)
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.
Parameters | |
---|---|
Name | Description |
request |
GetAttachedClusterRequest 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 |
AttachedCluster |
The RPC response. |
GetAttachedClusterAsync(GetAttachedClusterRequest, CallSettings)
public override Task<AttachedCluster> GetAttachedClusterAsync(GetAttachedClusterRequest request, CallSettings callSettings = null)
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.
Parameters | |
---|---|
Name | Description |
request |
GetAttachedClusterRequest 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 |
TaskAttachedCluster |
A Task containing the RPC response. |
GetAttachedServerConfig(GetAttachedServerConfigRequest, CallSettings)
public override AttachedServerConfig GetAttachedServerConfig(GetAttachedServerConfigRequest request, CallSettings callSettings = null)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.
Parameters | |
---|---|
Name | Description |
request |
GetAttachedServerConfigRequest 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 |
AttachedServerConfig |
The RPC response. |
GetAttachedServerConfigAsync(GetAttachedServerConfigRequest, CallSettings)
public override Task<AttachedServerConfig> GetAttachedServerConfigAsync(GetAttachedServerConfigRequest request, CallSettings callSettings = null)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.
Parameters | |
---|---|
Name | Description |
request |
GetAttachedServerConfigRequest 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 |
TaskAttachedServerConfig |
A Task containing the RPC response. |
ImportAttachedCluster(ImportAttachedClusterRequest, CallSettings)
public override Operation<AttachedCluster, OperationMetadata> ImportAttachedCluster(ImportAttachedClusterRequest request, CallSettings callSettings = null)
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.
Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
ImportAttachedClusterRequest 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 |
OperationAttachedClusterOperationMetadata |
The RPC response. |
ImportAttachedClusterAsync(ImportAttachedClusterRequest, CallSettings)
public override Task<Operation<AttachedCluster, OperationMetadata>> ImportAttachedClusterAsync(ImportAttachedClusterRequest request, CallSettings callSettings = null)
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.
Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
ImportAttachedClusterRequest 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 |
TaskOperationAttachedClusterOperationMetadata |
A Task containing the RPC response. |
ListAttachedClusters(ListAttachedClustersRequest, CallSettings)
public override PagedEnumerable<ListAttachedClustersResponse, AttachedCluster> ListAttachedClusters(ListAttachedClustersRequest request, CallSettings callSettings = null)
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
request |
ListAttachedClustersRequest 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 |
PagedEnumerableListAttachedClustersResponseAttachedCluster |
A pageable sequence of AttachedCluster resources. |
ListAttachedClustersAsync(ListAttachedClustersRequest, CallSettings)
public override PagedAsyncEnumerable<ListAttachedClustersResponse, AttachedCluster> ListAttachedClustersAsync(ListAttachedClustersRequest request, CallSettings callSettings = null)
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
request |
ListAttachedClustersRequest 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 |
PagedAsyncEnumerableListAttachedClustersResponseAttachedCluster |
A pageable asynchronous sequence of AttachedCluster resources. |
UpdateAttachedCluster(UpdateAttachedClusterRequest, CallSettings)
public override Operation<AttachedCluster, OperationMetadata> UpdateAttachedCluster(UpdateAttachedClusterRequest request, CallSettings callSettings = null)
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].
Parameters | |
---|---|
Name | Description |
request |
UpdateAttachedClusterRequest 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 |
OperationAttachedClusterOperationMetadata |
The RPC response. |
UpdateAttachedClusterAsync(UpdateAttachedClusterRequest, CallSettings)
public override Task<Operation<AttachedCluster, OperationMetadata>> UpdateAttachedClusterAsync(UpdateAttachedClusterRequest request, CallSettings callSettings = null)
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].
Parameters | |
---|---|
Name | Description |
request |
UpdateAttachedClusterRequest 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 |
TaskOperationAttachedClusterOperationMetadata |
A Task containing the RPC response. |