Anthos Multi-Cloud v1 API - Class AttachedClustersClient (2.4.0)

public abstract class AttachedClustersClient

Reference documentation and code samples for the Anthos Multi-Cloud v1 API class AttachedClustersClient.

AttachedClusters client wrapper, for convenient use.

Inheritance

object > AttachedClustersClient

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

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.

Properties

CreateAttachedClusterOperationsClient

public virtual OperationsClient CreateAttachedClusterOperationsClient { get; }

The long-running operations client for CreateAttachedCluster.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the AttachedClusters service, which is a host of "gkemulticloud.googleapis.com" and a port of 443.

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AttachedClusters scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

The default AttachedClusters scopes are:

DeleteAttachedClusterOperationsClient

public virtual OperationsClient DeleteAttachedClusterOperationsClient { get; }

The long-running operations client for DeleteAttachedCluster.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual AttachedClusters.AttachedClustersClient GrpcClient { get; }

The underlying gRPC AttachedClusters client

Property Value
TypeDescription
AttachedClustersAttachedClustersClient

ImportAttachedClusterOperationsClient

public virtual OperationsClient ImportAttachedClusterOperationsClient { get; }

The long-running operations client for ImportAttachedCluster.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

UpdateAttachedClusterOperationsClient

public virtual OperationsClient UpdateAttachedClusterOperationsClient { get; }

The long-running operations client for UpdateAttachedCluster.

Property Value
TypeDescription
OperationsClient

Methods

Create()

public static AttachedClustersClient Create()

Synchronously creates a AttachedClustersClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AttachedClustersClientBuilder.

Returns
TypeDescription
AttachedClustersClient

The created AttachedClustersClient.

CreateAsync(CancellationToken)

public static Task<AttachedClustersClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a AttachedClustersClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AttachedClustersClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskAttachedClustersClient

The task representing the created AttachedClustersClient.

CreateAttachedCluster(LocationName, AttachedCluster, string, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> CreateAttachedCluster(LocationName parent, AttachedCluster attachedCluster, string attachedClusterId, 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
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterAttachedCluster

Required. The specification of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.

attachedClusterIdstring

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AttachedCluster attachedCluster = new AttachedCluster();
string attachedClusterId = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = attachedClustersClient.CreateAttachedCluster(parent, attachedCluster, attachedClusterId);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceCreateAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

CreateAttachedCluster(CreateAttachedClusterRequest, CallSettings)

public virtual 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
NameDescription
requestCreateAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
CreateAttachedClusterRequest request = new CreateAttachedClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AttachedCluster = new AttachedCluster(),
    AttachedClusterId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = attachedClustersClient.CreateAttachedCluster(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceCreateAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

CreateAttachedCluster(string, AttachedCluster, string, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> CreateAttachedCluster(string parent, AttachedCluster attachedCluster, string attachedClusterId, 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
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterAttachedCluster

Required. The specification of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.

attachedClusterIdstring

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AttachedCluster attachedCluster = new AttachedCluster();
string attachedClusterId = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = attachedClustersClient.CreateAttachedCluster(parent, attachedCluster, attachedClusterId);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceCreateAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

CreateAttachedClusterAsync(LocationName, AttachedCluster, string, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> CreateAttachedClusterAsync(LocationName parent, AttachedCluster attachedCluster, string attachedClusterId, 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
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterAttachedCluster

Required. The specification of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.

attachedClusterIdstring

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AttachedCluster attachedCluster = new AttachedCluster();
string attachedClusterId = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.CreateAttachedClusterAsync(parent, attachedCluster, attachedClusterId);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceCreateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

CreateAttachedClusterAsync(LocationName, AttachedCluster, string, CancellationToken)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> CreateAttachedClusterAsync(LocationName parent, AttachedCluster attachedCluster, string attachedClusterId, CancellationToken cancellationToken)

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
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterAttachedCluster

Required. The specification of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.

attachedClusterIdstring

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AttachedCluster attachedCluster = new AttachedCluster();
string attachedClusterId = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.CreateAttachedClusterAsync(parent, attachedCluster, attachedClusterId);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceCreateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

CreateAttachedClusterAsync(CreateAttachedClusterRequest, CallSettings)

public virtual 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
NameDescription
requestCreateAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
CreateAttachedClusterRequest request = new CreateAttachedClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AttachedCluster = new AttachedCluster(),
    AttachedClusterId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.CreateAttachedClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceCreateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

CreateAttachedClusterAsync(CreateAttachedClusterRequest, CancellationToken)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> CreateAttachedClusterAsync(CreateAttachedClusterRequest request, CancellationToken cancellationToken)

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
NameDescription
requestCreateAttachedClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
CreateAttachedClusterRequest request = new CreateAttachedClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AttachedCluster = new AttachedCluster(),
    AttachedClusterId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.CreateAttachedClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceCreateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

CreateAttachedClusterAsync(string, AttachedCluster, string, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> CreateAttachedClusterAsync(string parent, AttachedCluster attachedCluster, string attachedClusterId, 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
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterAttachedCluster

Required. The specification of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.

attachedClusterIdstring

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AttachedCluster attachedCluster = new AttachedCluster();
string attachedClusterId = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.CreateAttachedClusterAsync(parent, attachedCluster, attachedClusterId);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceCreateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

CreateAttachedClusterAsync(string, AttachedCluster, string, CancellationToken)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> CreateAttachedClusterAsync(string parent, AttachedCluster attachedCluster, string attachedClusterId, CancellationToken cancellationToken)

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
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterAttachedCluster

Required. The specification of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.

attachedClusterIdstring

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AttachedCluster attachedCluster = new AttachedCluster();
string attachedClusterId = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.CreateAttachedClusterAsync(parent, attachedCluster, attachedClusterId);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceCreateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

DeleteAttachedCluster(AttachedClusterName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAttachedCluster(AttachedClusterName name, 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
NameDescription
nameAttachedClusterName

Required. The resource name the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to delete.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
AttachedClusterName name = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = attachedClustersClient.DeleteAttachedCluster(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceDeleteAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAttachedCluster(DeleteAttachedClusterRequest, CallSettings)

public virtual 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
NameDescription
requestDeleteAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
DeleteAttachedClusterRequest request = new DeleteAttachedClusterRequest
{
    AttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
    IgnoreErrors = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = attachedClustersClient.DeleteAttachedCluster(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceDeleteAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAttachedCluster(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAttachedCluster(string name, 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
NameDescription
namestring

Required. The resource name the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to delete.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedClusters/[ATTACHED_CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = attachedClustersClient.DeleteAttachedCluster(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceDeleteAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAttachedClusterAsync(AttachedClusterName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAttachedClusterAsync(AttachedClusterName name, 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
NameDescription
nameAttachedClusterName

Required. The resource name the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to delete.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
AttachedClusterName name = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = await attachedClustersClient.DeleteAttachedClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceDeleteAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAttachedClusterAsync(AttachedClusterName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAttachedClusterAsync(AttachedClusterName name, CancellationToken cancellationToken)

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
NameDescription
nameAttachedClusterName

Required. The resource name the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to delete.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
AttachedClusterName name = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = await attachedClustersClient.DeleteAttachedClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceDeleteAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAttachedClusterAsync(DeleteAttachedClusterRequest, CallSettings)

public virtual 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
NameDescription
requestDeleteAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
DeleteAttachedClusterRequest request = new DeleteAttachedClusterRequest
{
    AttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
    IgnoreErrors = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await attachedClustersClient.DeleteAttachedClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceDeleteAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAttachedClusterAsync(DeleteAttachedClusterRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAttachedClusterAsync(DeleteAttachedClusterRequest request, CancellationToken cancellationToken)

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
NameDescription
requestDeleteAttachedClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
DeleteAttachedClusterRequest request = new DeleteAttachedClusterRequest
{
    AttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
    IgnoreErrors = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await attachedClustersClient.DeleteAttachedClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceDeleteAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAttachedClusterAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAttachedClusterAsync(string name, 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
NameDescription
namestring

Required. The resource name the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to delete.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedClusters/[ATTACHED_CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = await attachedClustersClient.DeleteAttachedClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceDeleteAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteAttachedClusterAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAttachedClusterAsync(string name, CancellationToken cancellationToken)

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
NameDescription
namestring

Required. The resource name the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to delete.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedClusters/[ATTACHED_CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = await attachedClustersClient.DeleteAttachedClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceDeleteAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GenerateAttachedClusterAgentToken(GenerateAttachedClusterAgentTokenRequest, CallSettings)

public virtual GenerateAttachedClusterAgentTokenResponse GenerateAttachedClusterAgentToken(GenerateAttachedClusterAgentTokenRequest request, CallSettings callSettings = null)

Generates an access token for a cluster agent.

Parameters
NameDescription
requestGenerateAttachedClusterAgentTokenRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GenerateAttachedClusterAgentTokenResponse

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
GenerateAttachedClusterAgentTokenRequest request = new GenerateAttachedClusterAgentTokenRequest
{
    AttachedClusterAsAttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
    SubjectToken = "",
    SubjectTokenType = "",
    Version = "",
    GrantType = "",
    Audience = "",
    Scope = "",
    RequestedTokenType = "",
    Options = "",
};
// Make the request
GenerateAttachedClusterAgentTokenResponse response = attachedClustersClient.GenerateAttachedClusterAgentToken(request);

GenerateAttachedClusterAgentTokenAsync(GenerateAttachedClusterAgentTokenRequest, CallSettings)

public virtual Task<GenerateAttachedClusterAgentTokenResponse> GenerateAttachedClusterAgentTokenAsync(GenerateAttachedClusterAgentTokenRequest request, CallSettings callSettings = null)

Generates an access token for a cluster agent.

Parameters
NameDescription
requestGenerateAttachedClusterAgentTokenRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskGenerateAttachedClusterAgentTokenResponse

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
GenerateAttachedClusterAgentTokenRequest request = new GenerateAttachedClusterAgentTokenRequest
{
    AttachedClusterAsAttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
    SubjectToken = "",
    SubjectTokenType = "",
    Version = "",
    GrantType = "",
    Audience = "",
    Scope = "",
    RequestedTokenType = "",
    Options = "",
};
// Make the request
GenerateAttachedClusterAgentTokenResponse response = await attachedClustersClient.GenerateAttachedClusterAgentTokenAsync(request);

GenerateAttachedClusterAgentTokenAsync(GenerateAttachedClusterAgentTokenRequest, CancellationToken)

public virtual Task<GenerateAttachedClusterAgentTokenResponse> GenerateAttachedClusterAgentTokenAsync(GenerateAttachedClusterAgentTokenRequest request, CancellationToken cancellationToken)

Generates an access token for a cluster agent.

Parameters
NameDescription
requestGenerateAttachedClusterAgentTokenRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskGenerateAttachedClusterAgentTokenResponse

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
GenerateAttachedClusterAgentTokenRequest request = new GenerateAttachedClusterAgentTokenRequest
{
    AttachedClusterAsAttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
    SubjectToken = "",
    SubjectTokenType = "",
    Version = "",
    GrantType = "",
    Audience = "",
    Scope = "",
    RequestedTokenType = "",
    Options = "",
};
// Make the request
GenerateAttachedClusterAgentTokenResponse response = await attachedClustersClient.GenerateAttachedClusterAgentTokenAsync(request);

GenerateAttachedClusterInstallManifest(LocationName, string, CallSettings)

public virtual GenerateAttachedClusterInstallManifestResponse GenerateAttachedClusterInstallManifest(LocationName parent, string attachedClusterId, CallSettings callSettings = null)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterIdstring

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.

Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GenerateAttachedClusterInstallManifestResponse

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string attachedClusterId = "";
// Make the request
GenerateAttachedClusterInstallManifestResponse response = attachedClustersClient.GenerateAttachedClusterInstallManifest(parent, attachedClusterId);

GenerateAttachedClusterInstallManifest(GenerateAttachedClusterInstallManifestRequest, CallSettings)

public virtual GenerateAttachedClusterInstallManifestResponse GenerateAttachedClusterInstallManifest(GenerateAttachedClusterInstallManifestRequest request, CallSettings callSettings = null)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
requestGenerateAttachedClusterInstallManifestRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GenerateAttachedClusterInstallManifestResponse

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
GenerateAttachedClusterInstallManifestRequest request = new GenerateAttachedClusterInstallManifestRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AttachedClusterId = "",
    PlatformVersion = "",
    ProxyConfig = new AttachedProxyConfig(),
};
// Make the request
GenerateAttachedClusterInstallManifestResponse response = attachedClustersClient.GenerateAttachedClusterInstallManifest(request);

GenerateAttachedClusterInstallManifest(string, string, CallSettings)

public virtual GenerateAttachedClusterInstallManifestResponse GenerateAttachedClusterInstallManifest(string parent, string attachedClusterId, CallSettings callSettings = null)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterIdstring

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.

Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GenerateAttachedClusterInstallManifestResponse

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string attachedClusterId = "";
// Make the request
GenerateAttachedClusterInstallManifestResponse response = attachedClustersClient.GenerateAttachedClusterInstallManifest(parent, attachedClusterId);

GenerateAttachedClusterInstallManifestAsync(LocationName, string, CallSettings)

public virtual Task<GenerateAttachedClusterInstallManifestResponse> GenerateAttachedClusterInstallManifestAsync(LocationName parent, string attachedClusterId, CallSettings callSettings = null)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterIdstring

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.

Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskGenerateAttachedClusterInstallManifestResponse

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string attachedClusterId = "";
// Make the request
GenerateAttachedClusterInstallManifestResponse response = await attachedClustersClient.GenerateAttachedClusterInstallManifestAsync(parent, attachedClusterId);

GenerateAttachedClusterInstallManifestAsync(LocationName, string, CancellationToken)

public virtual Task<GenerateAttachedClusterInstallManifestResponse> GenerateAttachedClusterInstallManifestAsync(LocationName parent, string attachedClusterId, CancellationToken cancellationToken)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterIdstring

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.

Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskGenerateAttachedClusterInstallManifestResponse

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string attachedClusterId = "";
// Make the request
GenerateAttachedClusterInstallManifestResponse response = await attachedClustersClient.GenerateAttachedClusterInstallManifestAsync(parent, attachedClusterId);

GenerateAttachedClusterInstallManifestAsync(GenerateAttachedClusterInstallManifestRequest, CallSettings)

public virtual Task<GenerateAttachedClusterInstallManifestResponse> GenerateAttachedClusterInstallManifestAsync(GenerateAttachedClusterInstallManifestRequest request, CallSettings callSettings = null)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
requestGenerateAttachedClusterInstallManifestRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskGenerateAttachedClusterInstallManifestResponse

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
GenerateAttachedClusterInstallManifestRequest request = new GenerateAttachedClusterInstallManifestRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AttachedClusterId = "",
    PlatformVersion = "",
    ProxyConfig = new AttachedProxyConfig(),
};
// Make the request
GenerateAttachedClusterInstallManifestResponse response = await attachedClustersClient.GenerateAttachedClusterInstallManifestAsync(request);

GenerateAttachedClusterInstallManifestAsync(GenerateAttachedClusterInstallManifestRequest, CancellationToken)

public virtual Task<GenerateAttachedClusterInstallManifestResponse> GenerateAttachedClusterInstallManifestAsync(GenerateAttachedClusterInstallManifestRequest request, CancellationToken cancellationToken)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
requestGenerateAttachedClusterInstallManifestRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskGenerateAttachedClusterInstallManifestResponse

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
GenerateAttachedClusterInstallManifestRequest request = new GenerateAttachedClusterInstallManifestRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AttachedClusterId = "",
    PlatformVersion = "",
    ProxyConfig = new AttachedProxyConfig(),
};
// Make the request
GenerateAttachedClusterInstallManifestResponse response = await attachedClustersClient.GenerateAttachedClusterInstallManifestAsync(request);

GenerateAttachedClusterInstallManifestAsync(string, string, CallSettings)

public virtual Task<GenerateAttachedClusterInstallManifestResponse> GenerateAttachedClusterInstallManifestAsync(string parent, string attachedClusterId, CallSettings callSettings = null)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterIdstring

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.

Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskGenerateAttachedClusterInstallManifestResponse

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string attachedClusterId = "";
// Make the request
GenerateAttachedClusterInstallManifestResponse response = await attachedClustersClient.GenerateAttachedClusterInstallManifestAsync(parent, attachedClusterId);

GenerateAttachedClusterInstallManifestAsync(string, string, CancellationToken)

public virtual Task<GenerateAttachedClusterInstallManifestResponse> GenerateAttachedClusterInstallManifestAsync(string parent, string attachedClusterId, CancellationToken cancellationToken)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

attachedClusterIdstring

Required. A client provided ID of the resource. Must be unique within the parent resource.

The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.

Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskGenerateAttachedClusterInstallManifestResponse

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string attachedClusterId = "";
// Make the request
GenerateAttachedClusterInstallManifestResponse response = await attachedClustersClient.GenerateAttachedClusterInstallManifestAsync(parent, attachedClusterId);

GetAttachedCluster(AttachedClusterName, CallSettings)

public virtual AttachedCluster GetAttachedCluster(AttachedClusterName name, CallSettings callSettings = null)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
nameAttachedClusterName

Required. The name of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to describe.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttachedCluster

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
AttachedClusterName name = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]");
// Make the request
AttachedCluster response = attachedClustersClient.GetAttachedCluster(name);

GetAttachedCluster(GetAttachedClusterRequest, CallSettings)

public virtual AttachedCluster GetAttachedCluster(GetAttachedClusterRequest request, CallSettings callSettings = null)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
requestGetAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttachedCluster

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
GetAttachedClusterRequest request = new GetAttachedClusterRequest
{
    AttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
};
// Make the request
AttachedCluster response = attachedClustersClient.GetAttachedCluster(request);

GetAttachedCluster(string, CallSettings)

public virtual AttachedCluster GetAttachedCluster(string name, CallSettings callSettings = null)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
namestring

Required. The name of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to describe.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttachedCluster

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedClusters/[ATTACHED_CLUSTER]";
// Make the request
AttachedCluster response = attachedClustersClient.GetAttachedCluster(name);

GetAttachedClusterAsync(AttachedClusterName, CallSettings)

public virtual Task<AttachedCluster> GetAttachedClusterAsync(AttachedClusterName name, CallSettings callSettings = null)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
nameAttachedClusterName

Required. The name of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to describe.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttachedCluster

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
AttachedClusterName name = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]");
// Make the request
AttachedCluster response = await attachedClustersClient.GetAttachedClusterAsync(name);

GetAttachedClusterAsync(AttachedClusterName, CancellationToken)

public virtual Task<AttachedCluster> GetAttachedClusterAsync(AttachedClusterName name, CancellationToken cancellationToken)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
nameAttachedClusterName

Required. The name of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to describe.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttachedCluster

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
AttachedClusterName name = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]");
// Make the request
AttachedCluster response = await attachedClustersClient.GetAttachedClusterAsync(name);

GetAttachedClusterAsync(GetAttachedClusterRequest, CallSettings)

public virtual Task<AttachedCluster> GetAttachedClusterAsync(GetAttachedClusterRequest request, CallSettings callSettings = null)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
requestGetAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttachedCluster

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
GetAttachedClusterRequest request = new GetAttachedClusterRequest
{
    AttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
};
// Make the request
AttachedCluster response = await attachedClustersClient.GetAttachedClusterAsync(request);

GetAttachedClusterAsync(GetAttachedClusterRequest, CancellationToken)

public virtual Task<AttachedCluster> GetAttachedClusterAsync(GetAttachedClusterRequest request, CancellationToken cancellationToken)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
requestGetAttachedClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttachedCluster

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
GetAttachedClusterRequest request = new GetAttachedClusterRequest
{
    AttachedClusterName = AttachedClusterName.FromProjectLocationAttachedCluster("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"),
};
// Make the request
AttachedCluster response = await attachedClustersClient.GetAttachedClusterAsync(request);

GetAttachedClusterAsync(string, CallSettings)

public virtual Task<AttachedCluster> GetAttachedClusterAsync(string name, CallSettings callSettings = null)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
namestring

Required. The name of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to describe.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttachedCluster

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedClusters/[ATTACHED_CLUSTER]";
// Make the request
AttachedCluster response = await attachedClustersClient.GetAttachedClusterAsync(name);

GetAttachedClusterAsync(string, CancellationToken)

public virtual Task<AttachedCluster> GetAttachedClusterAsync(string name, CancellationToken cancellationToken)

Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.

Parameters
NameDescription
namestring

Required. The name of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to describe.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttachedCluster

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedClusters/[ATTACHED_CLUSTER]";
// Make the request
AttachedCluster response = await attachedClustersClient.GetAttachedClusterAsync(name);

GetAttachedServerConfig(AttachedServerConfigName, CallSettings)

public virtual AttachedServerConfig GetAttachedServerConfig(AttachedServerConfigName name, CallSettings callSettings = null)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameAttachedServerConfigName

Required. The name of the [AttachedServerConfig][google.cloud.gkemulticloud.v1.AttachedServerConfig] resource to describe.

AttachedServerConfig names are formatted as projects/<project-id>/locations/<region>/attachedServerConfig.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttachedServerConfig

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
AttachedServerConfigName name = AttachedServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AttachedServerConfig response = attachedClustersClient.GetAttachedServerConfig(name);

GetAttachedServerConfig(GetAttachedServerConfigRequest, CallSettings)

public virtual AttachedServerConfig GetAttachedServerConfig(GetAttachedServerConfigRequest request, CallSettings callSettings = null)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
requestGetAttachedServerConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttachedServerConfig

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
GetAttachedServerConfigRequest request = new GetAttachedServerConfigRequest
{
    AttachedServerConfigName = AttachedServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AttachedServerConfig response = attachedClustersClient.GetAttachedServerConfig(request);

GetAttachedServerConfig(string, CallSettings)

public virtual AttachedServerConfig GetAttachedServerConfig(string name, CallSettings callSettings = null)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
namestring

Required. The name of the [AttachedServerConfig][google.cloud.gkemulticloud.v1.AttachedServerConfig] resource to describe.

AttachedServerConfig names are formatted as projects/<project-id>/locations/<region>/attachedServerConfig.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AttachedServerConfig

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedServerConfig";
// Make the request
AttachedServerConfig response = attachedClustersClient.GetAttachedServerConfig(name);

GetAttachedServerConfigAsync(AttachedServerConfigName, CallSettings)

public virtual Task<AttachedServerConfig> GetAttachedServerConfigAsync(AttachedServerConfigName name, CallSettings callSettings = null)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameAttachedServerConfigName

Required. The name of the [AttachedServerConfig][google.cloud.gkemulticloud.v1.AttachedServerConfig] resource to describe.

AttachedServerConfig names are formatted as projects/<project-id>/locations/<region>/attachedServerConfig.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttachedServerConfig

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
AttachedServerConfigName name = AttachedServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AttachedServerConfig response = await attachedClustersClient.GetAttachedServerConfigAsync(name);

GetAttachedServerConfigAsync(AttachedServerConfigName, CancellationToken)

public virtual Task<AttachedServerConfig> GetAttachedServerConfigAsync(AttachedServerConfigName name, CancellationToken cancellationToken)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameAttachedServerConfigName

Required. The name of the [AttachedServerConfig][google.cloud.gkemulticloud.v1.AttachedServerConfig] resource to describe.

AttachedServerConfig names are formatted as projects/<project-id>/locations/<region>/attachedServerConfig.

See Resource Names for more details on Google Cloud resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttachedServerConfig

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
AttachedServerConfigName name = AttachedServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AttachedServerConfig response = await attachedClustersClient.GetAttachedServerConfigAsync(name);

GetAttachedServerConfigAsync(GetAttachedServerConfigRequest, CallSettings)

public virtual Task<AttachedServerConfig> GetAttachedServerConfigAsync(GetAttachedServerConfigRequest request, CallSettings callSettings = null)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
requestGetAttachedServerConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttachedServerConfig

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
GetAttachedServerConfigRequest request = new GetAttachedServerConfigRequest
{
    AttachedServerConfigName = AttachedServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AttachedServerConfig response = await attachedClustersClient.GetAttachedServerConfigAsync(request);

GetAttachedServerConfigAsync(GetAttachedServerConfigRequest, CancellationToken)

public virtual Task<AttachedServerConfig> GetAttachedServerConfigAsync(GetAttachedServerConfigRequest request, CancellationToken cancellationToken)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
requestGetAttachedServerConfigRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttachedServerConfig

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
GetAttachedServerConfigRequest request = new GetAttachedServerConfigRequest
{
    AttachedServerConfigName = AttachedServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AttachedServerConfig response = await attachedClustersClient.GetAttachedServerConfigAsync(request);

GetAttachedServerConfigAsync(string, CallSettings)

public virtual Task<AttachedServerConfig> GetAttachedServerConfigAsync(string name, CallSettings callSettings = null)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
namestring

Required. The name of the [AttachedServerConfig][google.cloud.gkemulticloud.v1.AttachedServerConfig] resource to describe.

AttachedServerConfig names are formatted as projects/<project-id>/locations/<region>/attachedServerConfig.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAttachedServerConfig

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedServerConfig";
// Make the request
AttachedServerConfig response = await attachedClustersClient.GetAttachedServerConfigAsync(name);

GetAttachedServerConfigAsync(string, CancellationToken)

public virtual Task<AttachedServerConfig> GetAttachedServerConfigAsync(string name, CancellationToken cancellationToken)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
namestring

Required. The name of the [AttachedServerConfig][google.cloud.gkemulticloud.v1.AttachedServerConfig] resource to describe.

AttachedServerConfig names are formatted as projects/<project-id>/locations/<region>/attachedServerConfig.

See Resource Names for more details on Google Cloud resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskAttachedServerConfig

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/attachedServerConfig";
// Make the request
AttachedServerConfig response = await attachedClustersClient.GetAttachedServerConfigAsync(name);

ImportAttachedCluster(LocationName, string, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> ImportAttachedCluster(LocationName parent, string fleetMembership, 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
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

fleetMembershipstring

Required. The name of the fleet membership resource to import.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string fleetMembership = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = attachedClustersClient.ImportAttachedCluster(parent, fleetMembership);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceImportAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ImportAttachedCluster(ImportAttachedClusterRequest, CallSettings)

public virtual 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
NameDescription
requestImportAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
ImportAttachedClusterRequest request = new ImportAttachedClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ValidateOnly = false,
    FleetMembership = "",
    PlatformVersion = "",
    Distribution = "",
    ProxyConfig = new AttachedProxyConfig(),
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = attachedClustersClient.ImportAttachedCluster(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceImportAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ImportAttachedCluster(string, string, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> ImportAttachedCluster(string parent, string fleetMembership, 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
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

fleetMembershipstring

Required. The name of the fleet membership resource to import.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string fleetMembership = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = attachedClustersClient.ImportAttachedCluster(parent, fleetMembership);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceImportAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ImportAttachedClusterAsync(LocationName, string, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> ImportAttachedClusterAsync(LocationName parent, string fleetMembership, 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
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

fleetMembershipstring

Required. The name of the fleet membership resource to import.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string fleetMembership = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.ImportAttachedClusterAsync(parent, fleetMembership);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceImportAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ImportAttachedClusterAsync(LocationName, string, CancellationToken)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> ImportAttachedClusterAsync(LocationName parent, string fleetMembership, CancellationToken cancellationToken)

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
NameDescription
parentLocationName

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

fleetMembershipstring

Required. The name of the fleet membership resource to import.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string fleetMembership = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.ImportAttachedClusterAsync(parent, fleetMembership);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceImportAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ImportAttachedClusterAsync(ImportAttachedClusterRequest, CallSettings)

public virtual 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
NameDescription
requestImportAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
ImportAttachedClusterRequest request = new ImportAttachedClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ValidateOnly = false,
    FleetMembership = "",
    PlatformVersion = "",
    Distribution = "",
    ProxyConfig = new AttachedProxyConfig(),
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.ImportAttachedClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceImportAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ImportAttachedClusterAsync(ImportAttachedClusterRequest, CancellationToken)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> ImportAttachedClusterAsync(ImportAttachedClusterRequest request, CancellationToken cancellationToken)

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
NameDescription
requestImportAttachedClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
ImportAttachedClusterRequest request = new ImportAttachedClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ValidateOnly = false,
    FleetMembership = "",
    PlatformVersion = "",
    Distribution = "",
    ProxyConfig = new AttachedProxyConfig(),
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.ImportAttachedClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceImportAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ImportAttachedClusterAsync(string, string, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> ImportAttachedClusterAsync(string parent, string fleetMembership, 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
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

fleetMembershipstring

Required. The name of the fleet membership resource to import.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string fleetMembership = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.ImportAttachedClusterAsync(parent, fleetMembership);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceImportAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ImportAttachedClusterAsync(string, string, CancellationToken)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> ImportAttachedClusterAsync(string parent, string fleetMembership, CancellationToken cancellationToken)

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
NameDescription
parentstring

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

fleetMembershipstring

Required. The name of the fleet membership resource to import.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string fleetMembership = "";
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.ImportAttachedClusterAsync(parent, fleetMembership);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceImportAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

ListAttachedClusters(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAttachedClustersResponse, AttachedCluster> ListAttachedClusters(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
parentLocationName

Required. The parent location which owns this collection of [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud Platform resource names.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListAttachedClustersResponseAttachedCluster

A pageable sequence of AttachedCluster resources.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListAttachedClustersResponse, AttachedCluster> response = attachedClustersClient.ListAttachedClusters(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AttachedCluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAttachedClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AttachedCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AttachedCluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AttachedCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAttachedClusters(ListAttachedClustersRequest, CallSettings)

public virtual 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
NameDescription
requestListAttachedClustersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListAttachedClustersResponseAttachedCluster

A pageable sequence of AttachedCluster resources.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
ListAttachedClustersRequest request = new ListAttachedClustersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListAttachedClustersResponse, AttachedCluster> response = attachedClustersClient.ListAttachedClusters(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AttachedCluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAttachedClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AttachedCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AttachedCluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AttachedCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAttachedClusters(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAttachedClustersResponse, AttachedCluster> ListAttachedClusters(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
parentstring

Required. The parent location which owns this collection of [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud Platform resource names.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListAttachedClustersResponseAttachedCluster

A pageable sequence of AttachedCluster resources.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListAttachedClustersResponse, AttachedCluster> response = attachedClustersClient.ListAttachedClusters(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AttachedCluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAttachedClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AttachedCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AttachedCluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AttachedCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAttachedClustersAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAttachedClustersResponse, AttachedCluster> ListAttachedClustersAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
parentLocationName

Required. The parent location which owns this collection of [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud Platform resource names.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListAttachedClustersResponseAttachedCluster

A pageable asynchronous sequence of AttachedCluster resources.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListAttachedClustersResponse, AttachedCluster> response = attachedClustersClient.ListAttachedClustersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AttachedCluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAttachedClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AttachedCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AttachedCluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AttachedCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAttachedClustersAsync(ListAttachedClustersRequest, CallSettings)

public virtual 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
NameDescription
requestListAttachedClustersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListAttachedClustersResponseAttachedCluster

A pageable asynchronous sequence of AttachedCluster resources.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
ListAttachedClustersRequest request = new ListAttachedClustersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListAttachedClustersResponse, AttachedCluster> response = attachedClustersClient.ListAttachedClustersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AttachedCluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAttachedClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AttachedCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AttachedCluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AttachedCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAttachedClustersAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAttachedClustersResponse, AttachedCluster> ListAttachedClustersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
parentstring

Required. The parent location which owns this collection of [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud Platform resource names.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListAttachedClustersResponseAttachedCluster

A pageable asynchronous sequence of AttachedCluster resources.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListAttachedClustersResponse, AttachedCluster> response = attachedClustersClient.ListAttachedClustersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AttachedCluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAttachedClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AttachedCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AttachedCluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AttachedCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateAttachedCluster(string, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> PollOnceCreateAttachedCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateAttachedCluster .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The result of polling the operation.

PollOnceCreateAttachedClusterAsync(string, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> PollOnceCreateAttachedClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateAttachedCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteAttachedCluster(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteAttachedCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteAttachedCluster .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteAttachedClusterAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteAttachedClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteAttachedCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceImportAttachedCluster(string, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> PollOnceImportAttachedCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ImportAttachedCluster .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The result of polling the operation.

PollOnceImportAttachedClusterAsync(string, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> PollOnceImportAttachedClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ImportAttachedCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateAttachedCluster(string, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> PollOnceUpdateAttachedCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateAttachedCluster .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The result of polling the operation.

PollOnceUpdateAttachedClusterAsync(string, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> PollOnceUpdateAttachedClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateAttachedCluster.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateAttachedCluster(AttachedCluster, FieldMask, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> UpdateAttachedCluster(AttachedCluster attachedCluster, FieldMask updateMask, CallSettings callSettings = null)

Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].

Parameters
NameDescription
attachedClusterAttachedCluster

Required. The [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster]:

  • annotations.
  • authorization.admin_groups.
  • authorization.admin_users.
  • binary_authorization.evaluation_mode.
  • description.
  • logging_config.component_config.enable_components.
  • monitoring_config.managed_prometheus_config.enabled.
  • platform_version.
  • proxy_config.kubernetes_secret.name.
  • proxy_config.kubernetes_secret.namespace.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
AttachedCluster attachedCluster = new AttachedCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AttachedCluster, OperationMetadata> response = attachedClustersClient.UpdateAttachedCluster(attachedCluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceUpdateAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

UpdateAttachedCluster(UpdateAttachedClusterRequest, CallSettings)

public virtual Operation<AttachedCluster, OperationMetadata> UpdateAttachedCluster(UpdateAttachedClusterRequest request, CallSettings callSettings = null)

Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].

Parameters
NameDescription
requestUpdateAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationAttachedClusterOperationMetadata

The RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = AttachedClustersClient.Create();
// Initialize request argument(s)
UpdateAttachedClusterRequest request = new UpdateAttachedClusterRequest
{
    AttachedCluster = new AttachedCluster(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = attachedClustersClient.UpdateAttachedCluster(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = attachedClustersClient.PollOnceUpdateAttachedCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

UpdateAttachedClusterAsync(AttachedCluster, FieldMask, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> UpdateAttachedClusterAsync(AttachedCluster attachedCluster, FieldMask updateMask, CallSettings callSettings = null)

Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].

Parameters
NameDescription
attachedClusterAttachedCluster

Required. The [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster]:

  • annotations.
  • authorization.admin_groups.
  • authorization.admin_users.
  • binary_authorization.evaluation_mode.
  • description.
  • logging_config.component_config.enable_components.
  • monitoring_config.managed_prometheus_config.enabled.
  • platform_version.
  • proxy_config.kubernetes_secret.name.
  • proxy_config.kubernetes_secret.namespace.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
AttachedCluster attachedCluster = new AttachedCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.UpdateAttachedClusterAsync(attachedCluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceUpdateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

UpdateAttachedClusterAsync(AttachedCluster, FieldMask, CancellationToken)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> UpdateAttachedClusterAsync(AttachedCluster attachedCluster, FieldMask updateMask, CancellationToken cancellationToken)

Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].

Parameters
NameDescription
attachedClusterAttachedCluster

Required. The [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster]:

  • annotations.
  • authorization.admin_groups.
  • authorization.admin_users.
  • binary_authorization.evaluation_mode.
  • description.
  • logging_config.component_config.enable_components.
  • monitoring_config.managed_prometheus_config.enabled.
  • platform_version.
  • proxy_config.kubernetes_secret.name.
  • proxy_config.kubernetes_secret.namespace.
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
AttachedCluster attachedCluster = new AttachedCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.UpdateAttachedClusterAsync(attachedCluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceUpdateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

UpdateAttachedClusterAsync(UpdateAttachedClusterRequest, CallSettings)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> UpdateAttachedClusterAsync(UpdateAttachedClusterRequest request, CallSettings callSettings = null)

Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].

Parameters
NameDescription
requestUpdateAttachedClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
UpdateAttachedClusterRequest request = new UpdateAttachedClusterRequest
{
    AttachedCluster = new AttachedCluster(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.UpdateAttachedClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceUpdateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}

UpdateAttachedClusterAsync(UpdateAttachedClusterRequest, CancellationToken)

public virtual Task<Operation<AttachedCluster, OperationMetadata>> UpdateAttachedClusterAsync(UpdateAttachedClusterRequest request, CancellationToken cancellationToken)

Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].

Parameters
NameDescription
requestUpdateAttachedClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationAttachedClusterOperationMetadata

A Task containing the RPC response.

Example
// Create client
AttachedClustersClient attachedClustersClient = await AttachedClustersClient.CreateAsync();
// Initialize request argument(s)
UpdateAttachedClusterRequest request = new UpdateAttachedClusterRequest
{
    AttachedCluster = new AttachedCluster(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AttachedCluster, OperationMetadata> response = await attachedClustersClient.UpdateAttachedClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<AttachedCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AttachedCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AttachedCluster, OperationMetadata> retrievedResponse = await attachedClustersClient.PollOnceUpdateAttachedClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AttachedCluster retrievedResult = retrievedResponse.Result;
}