Infrastructure Manager v1 API - Class ConfigClient (1.2.0)

public abstract class ConfigClient

Reference documentation and code samples for the Infrastructure Manager v1 API class ConfigClient.

Config client wrapper, for convenient use.

Inheritance

object > ConfigClient

Derived Types

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Remarks

Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.

Properties

CreateDeploymentOperationsClient

public virtual OperationsClient CreateDeploymentOperationsClient { get; }

The long-running operations client for CreateDeployment.

Property Value
TypeDescription
OperationsClient

CreatePreviewOperationsClient

public virtual OperationsClient CreatePreviewOperationsClient { get; }

The long-running operations client for CreatePreview.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Config scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

The default Config scopes are:

DeleteDeploymentOperationsClient

public virtual OperationsClient DeleteDeploymentOperationsClient { get; }

The long-running operations client for DeleteDeployment.

Property Value
TypeDescription
OperationsClient

DeletePreviewOperationsClient

public virtual OperationsClient DeletePreviewOperationsClient { get; }

The long-running operations client for DeletePreview.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual Config.ConfigClient GrpcClient { get; }

The underlying gRPC Config client

Property Value
TypeDescription
ConfigConfigClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient

LockDeploymentOperationsClient

public virtual OperationsClient LockDeploymentOperationsClient { get; }

The long-running operations client for LockDeployment.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

UnlockDeploymentOperationsClient

public virtual OperationsClient UnlockDeploymentOperationsClient { get; }

The long-running operations client for UnlockDeployment.

Property Value
TypeDescription
OperationsClient

UpdateDeploymentOperationsClient

public virtual OperationsClient UpdateDeploymentOperationsClient { get; }

The long-running operations client for UpdateDeployment.

Property Value
TypeDescription
OperationsClient

Methods

Create()

public static ConfigClient Create()

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

Returns
TypeDescription
ConfigClient

The created ConfigClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskConfigClient

The task representing the created ConfigClient.

CreateDeployment(LocationName, Deployment, string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> CreateDeployment(LocationName parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] resource to be created.

deploymentIdstring

Required. The Deployment ID.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.CreateDeployment(parent, deployment, deploymentId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceCreateDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreateDeployment(CreateDeploymentRequest, CallSettings)

public virtual Operation<Deployment, OperationMetadata> CreateDeployment(CreateDeploymentRequest request, CallSettings callSettings = null)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestCreateDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
CreateDeploymentRequest request = new CreateDeploymentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DeploymentId = "",
    Deployment = new Deployment(),
    RequestId = "",
};
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.CreateDeployment(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceCreateDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreateDeployment(string, Deployment, string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> CreateDeployment(string parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
parentstring

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] resource to be created.

deploymentIdstring

Required. The Deployment ID.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.CreateDeployment(parent, deployment, deploymentId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceCreateDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreateDeploymentAsync(LocationName, Deployment, string, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> CreateDeploymentAsync(LocationName parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] resource to be created.

deploymentIdstring

Required. The Deployment ID.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.CreateDeploymentAsync(parent, deployment, deploymentId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceCreateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreateDeploymentAsync(LocationName, Deployment, string, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> CreateDeploymentAsync(LocationName parent, Deployment deployment, string deploymentId, CancellationToken cancellationToken)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] resource to be created.

deploymentIdstring

Required. The Deployment ID.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.CreateDeploymentAsync(parent, deployment, deploymentId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceCreateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreateDeploymentAsync(CreateDeploymentRequest, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> CreateDeploymentAsync(CreateDeploymentRequest request, CallSettings callSettings = null)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestCreateDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CreateDeploymentRequest request = new CreateDeploymentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DeploymentId = "",
    Deployment = new Deployment(),
    RequestId = "",
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.CreateDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceCreateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> CreateDeploymentAsync(CreateDeploymentRequest request, CancellationToken cancellationToken)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestCreateDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CreateDeploymentRequest request = new CreateDeploymentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DeploymentId = "",
    Deployment = new Deployment(),
    RequestId = "",
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.CreateDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceCreateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreateDeploymentAsync(string, Deployment, string, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> CreateDeploymentAsync(string parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
parentstring

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] resource to be created.

deploymentIdstring

Required. The Deployment ID.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.CreateDeploymentAsync(parent, deployment, deploymentId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceCreateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreateDeploymentAsync(string, Deployment, string, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> CreateDeploymentAsync(string parent, Deployment deployment, string deploymentId, CancellationToken cancellationToken)

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
parentstring

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] resource to be created.

deploymentIdstring

Required. The Deployment ID.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.CreateDeploymentAsync(parent, deployment, deploymentId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceCreateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

CreatePreview(LocationName, Preview, CallSettings)

public virtual Operation<Preview, OperationMetadata> CreatePreview(LocationName parent, Preview preview, CallSettings callSettings = null)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

previewPreview

Required. [Preview][google.cloud.config.v1.Preview] resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationPreviewOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Preview preview = new Preview();
// Make the request
Operation<Preview, OperationMetadata> response = configClient.CreatePreview(parent, preview);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = configClient.PollOnceCreatePreview(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

CreatePreview(CreatePreviewRequest, CallSettings)

public virtual Operation<Preview, OperationMetadata> CreatePreview(CreatePreviewRequest request, CallSettings callSettings = null)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestCreatePreviewRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationPreviewOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
CreatePreviewRequest request = new CreatePreviewRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    PreviewId = "",
    Preview = new Preview(),
    RequestId = "",
};
// Make the request
Operation<Preview, OperationMetadata> response = configClient.CreatePreview(request);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = configClient.PollOnceCreatePreview(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

CreatePreview(string, Preview, CallSettings)

public virtual Operation<Preview, OperationMetadata> CreatePreview(string parent, Preview preview, CallSettings callSettings = null)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
parentstring

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

previewPreview

Required. [Preview][google.cloud.config.v1.Preview] resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationPreviewOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Preview preview = new Preview();
// Make the request
Operation<Preview, OperationMetadata> response = configClient.CreatePreview(parent, preview);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = configClient.PollOnceCreatePreview(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

CreatePreviewAsync(LocationName, Preview, CallSettings)

public virtual Task<Operation<Preview, OperationMetadata>> CreatePreviewAsync(LocationName parent, Preview preview, CallSettings callSettings = null)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

previewPreview

Required. [Preview][google.cloud.config.v1.Preview] resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Preview preview = new Preview();
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.CreatePreviewAsync(parent, preview);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceCreatePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

CreatePreviewAsync(LocationName, Preview, CancellationToken)

public virtual Task<Operation<Preview, OperationMetadata>> CreatePreviewAsync(LocationName parent, Preview preview, CancellationToken cancellationToken)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

previewPreview

Required. [Preview][google.cloud.config.v1.Preview] resource to be created.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Preview preview = new Preview();
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.CreatePreviewAsync(parent, preview);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceCreatePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

CreatePreviewAsync(CreatePreviewRequest, CallSettings)

public virtual Task<Operation<Preview, OperationMetadata>> CreatePreviewAsync(CreatePreviewRequest request, CallSettings callSettings = null)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestCreatePreviewRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CreatePreviewRequest request = new CreatePreviewRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    PreviewId = "",
    Preview = new Preview(),
    RequestId = "",
};
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.CreatePreviewAsync(request);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceCreatePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

CreatePreviewAsync(CreatePreviewRequest, CancellationToken)

public virtual Task<Operation<Preview, OperationMetadata>> CreatePreviewAsync(CreatePreviewRequest request, CancellationToken cancellationToken)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestCreatePreviewRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CreatePreviewRequest request = new CreatePreviewRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    PreviewId = "",
    Preview = new Preview(),
    RequestId = "",
};
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.CreatePreviewAsync(request);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceCreatePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

CreatePreviewAsync(string, Preview, CallSettings)

public virtual Task<Operation<Preview, OperationMetadata>> CreatePreviewAsync(string parent, Preview preview, CallSettings callSettings = null)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
parentstring

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

previewPreview

Required. [Preview][google.cloud.config.v1.Preview] resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Preview preview = new Preview();
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.CreatePreviewAsync(parent, preview);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceCreatePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

CreatePreviewAsync(string, Preview, CancellationToken)

public virtual Task<Operation<Preview, OperationMetadata>> CreatePreviewAsync(string parent, Preview preview, CancellationToken cancellationToken)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
parentstring

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

previewPreview

Required. [Preview][google.cloud.config.v1.Preview] resource to be created.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Preview preview = new Preview();
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.CreatePreviewAsync(parent, preview);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceCreatePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeleteDeployment(DeleteDeploymentRequest, CallSettings)

public virtual Operation<Deployment, OperationMetadata> DeleteDeployment(DeleteDeploymentRequest request, CallSettings callSettings = null)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestDeleteDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeleteDeploymentRequest request = new DeleteDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    RequestId = "",
    Force = false,
    DeletePolicy = DeleteDeploymentRequest.Types.DeletePolicy.Unspecified,
};
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.DeleteDeployment(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceDeleteDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeleteDeployment(DeploymentName, CallSettings)

public virtual Operation<Deployment, OperationMetadata> DeleteDeployment(DeploymentName name, CallSettings callSettings = null)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
nameDeploymentName

Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.DeleteDeployment(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceDeleteDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeleteDeployment(string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> DeleteDeployment(string name, CallSettings callSettings = null)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
namestring

Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.DeleteDeployment(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceDeleteDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeleteDeploymentAsync(DeleteDeploymentRequest, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> DeleteDeploymentAsync(DeleteDeploymentRequest request, CallSettings callSettings = null)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestDeleteDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeleteDeploymentRequest request = new DeleteDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    RequestId = "",
    Force = false,
    DeletePolicy = DeleteDeploymentRequest.Types.DeletePolicy.Unspecified,
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.DeleteDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceDeleteDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeleteDeploymentAsync(DeleteDeploymentRequest, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> DeleteDeploymentAsync(DeleteDeploymentRequest request, CancellationToken cancellationToken)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestDeleteDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeleteDeploymentRequest request = new DeleteDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    RequestId = "",
    Force = false,
    DeletePolicy = DeleteDeploymentRequest.Types.DeletePolicy.Unspecified,
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.DeleteDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceDeleteDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeleteDeploymentAsync(DeploymentName, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> DeleteDeploymentAsync(DeploymentName name, CallSettings callSettings = null)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
nameDeploymentName

Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.DeleteDeploymentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceDeleteDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeleteDeploymentAsync(DeploymentName, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> DeleteDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
nameDeploymentName

Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.DeleteDeploymentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceDeleteDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeleteDeploymentAsync(string, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> DeleteDeploymentAsync(string name, CallSettings callSettings = null)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
namestring

Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.DeleteDeploymentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceDeleteDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeleteDeploymentAsync(string, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> DeleteDeploymentAsync(string name, CancellationToken cancellationToken)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
namestring

Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.DeleteDeploymentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceDeleteDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

DeletePreview(DeletePreviewRequest, CallSettings)

public virtual Operation<Preview, OperationMetadata> DeletePreview(DeletePreviewRequest request, CallSettings callSettings = null)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestDeletePreviewRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationPreviewOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeletePreviewRequest request = new DeletePreviewRequest
{
    PreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
    RequestId = "",
};
// Make the request
Operation<Preview, OperationMetadata> response = configClient.DeletePreview(request);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = configClient.PollOnceDeletePreview(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeletePreview(PreviewName, CallSettings)

public virtual Operation<Preview, OperationMetadata> DeletePreview(PreviewName name, CallSettings callSettings = null)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namePreviewName

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationPreviewOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
PreviewName name = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]");
// Make the request
Operation<Preview, OperationMetadata> response = configClient.DeletePreview(name);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = configClient.PollOnceDeletePreview(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeletePreview(string, CallSettings)

public virtual Operation<Preview, OperationMetadata> DeletePreview(string name, CallSettings callSettings = null)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namestring

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationPreviewOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/previews/[PREVIEW]";
// Make the request
Operation<Preview, OperationMetadata> response = configClient.DeletePreview(name);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = configClient.PollOnceDeletePreview(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeletePreviewAsync(DeletePreviewRequest, CallSettings)

public virtual Task<Operation<Preview, OperationMetadata>> DeletePreviewAsync(DeletePreviewRequest request, CallSettings callSettings = null)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestDeletePreviewRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeletePreviewRequest request = new DeletePreviewRequest
{
    PreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
    RequestId = "",
};
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.DeletePreviewAsync(request);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceDeletePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeletePreviewAsync(DeletePreviewRequest, CancellationToken)

public virtual Task<Operation<Preview, OperationMetadata>> DeletePreviewAsync(DeletePreviewRequest request, CancellationToken cancellationToken)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestDeletePreviewRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeletePreviewRequest request = new DeletePreviewRequest
{
    PreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
    RequestId = "",
};
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.DeletePreviewAsync(request);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceDeletePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeletePreviewAsync(PreviewName, CallSettings)

public virtual Task<Operation<Preview, OperationMetadata>> DeletePreviewAsync(PreviewName name, CallSettings callSettings = null)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namePreviewName

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
PreviewName name = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]");
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.DeletePreviewAsync(name);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceDeletePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeletePreviewAsync(PreviewName, CancellationToken)

public virtual Task<Operation<Preview, OperationMetadata>> DeletePreviewAsync(PreviewName name, CancellationToken cancellationToken)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namePreviewName

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
PreviewName name = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]");
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.DeletePreviewAsync(name);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceDeletePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeletePreviewAsync(string, CallSettings)

public virtual Task<Operation<Preview, OperationMetadata>> DeletePreviewAsync(string name, CallSettings callSettings = null)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namestring

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/previews/[PREVIEW]";
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.DeletePreviewAsync(name);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceDeletePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeletePreviewAsync(string, CancellationToken)

public virtual Task<Operation<Preview, OperationMetadata>> DeletePreviewAsync(string name, CancellationToken cancellationToken)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namestring

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationPreviewOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/previews/[PREVIEW]";
// Make the request
Operation<Preview, OperationMetadata> response = await configClient.DeletePreviewAsync(name);

// Poll until the returned long-running operation is complete
Operation<Preview, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Preview 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<Preview, OperationMetadata> retrievedResponse = await configClient.PollOnceDeletePreviewAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Preview retrievedResult = retrievedResponse.Result;
}

DeleteStatefile(DeleteStatefileRequest, CallSettings)

public virtual void DeleteStatefile(DeleteStatefileRequest request, CallSettings callSettings = null)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
requestDeleteStatefileRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeleteStatefileRequest request = new DeleteStatefileRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
};
// Make the request
configClient.DeleteStatefile(request);

DeleteStatefile(DeploymentName, CallSettings)

public virtual void DeleteStatefile(DeploymentName name, CallSettings callSettings = null)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
configClient.DeleteStatefile(name);

DeleteStatefile(string, CallSettings)

public virtual void DeleteStatefile(string name, CallSettings callSettings = null)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
configClient.DeleteStatefile(name);

DeleteStatefileAsync(DeleteStatefileRequest, CallSettings)

public virtual Task DeleteStatefileAsync(DeleteStatefileRequest request, CallSettings callSettings = null)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
requestDeleteStatefileRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeleteStatefileRequest request = new DeleteStatefileRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
};
// Make the request
await configClient.DeleteStatefileAsync(request);

DeleteStatefileAsync(DeleteStatefileRequest, CancellationToken)

public virtual Task DeleteStatefileAsync(DeleteStatefileRequest request, CancellationToken cancellationToken)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
requestDeleteStatefileRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeleteStatefileRequest request = new DeleteStatefileRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
};
// Make the request
await configClient.DeleteStatefileAsync(request);

DeleteStatefileAsync(DeploymentName, CallSettings)

public virtual Task DeleteStatefileAsync(DeploymentName name, CallSettings callSettings = null)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
await configClient.DeleteStatefileAsync(name);

DeleteStatefileAsync(DeploymentName, CancellationToken)

public virtual Task DeleteStatefileAsync(DeploymentName name, CancellationToken cancellationToken)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
await configClient.DeleteStatefileAsync(name);

DeleteStatefileAsync(string, CallSettings)

public virtual Task DeleteStatefileAsync(string name, CallSettings callSettings = null)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
await configClient.DeleteStatefileAsync(name);

DeleteStatefileAsync(string, CancellationToken)

public virtual Task DeleteStatefileAsync(string name, CancellationToken cancellationToken)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
await configClient.DeleteStatefileAsync(name);

ExportDeploymentStatefile(ExportDeploymentStatefileRequest, CallSettings)

public virtual Statefile ExportDeploymentStatefile(ExportDeploymentStatefileRequest request, CallSettings callSettings = null)

Exports Terraform state file from a given deployment.

Parameters
NameDescription
requestExportDeploymentStatefileRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Statefile

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ExportDeploymentStatefileRequest request = new ExportDeploymentStatefileRequest
{
    ParentAsDeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    Draft = false,
};
// Make the request
Statefile response = configClient.ExportDeploymentStatefile(request);

ExportDeploymentStatefileAsync(ExportDeploymentStatefileRequest, CallSettings)

public virtual Task<Statefile> ExportDeploymentStatefileAsync(ExportDeploymentStatefileRequest request, CallSettings callSettings = null)

Exports Terraform state file from a given deployment.

Parameters
NameDescription
requestExportDeploymentStatefileRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ExportDeploymentStatefileRequest request = new ExportDeploymentStatefileRequest
{
    ParentAsDeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    Draft = false,
};
// Make the request
Statefile response = await configClient.ExportDeploymentStatefileAsync(request);

ExportDeploymentStatefileAsync(ExportDeploymentStatefileRequest, CancellationToken)

public virtual Task<Statefile> ExportDeploymentStatefileAsync(ExportDeploymentStatefileRequest request, CancellationToken cancellationToken)

Exports Terraform state file from a given deployment.

Parameters
NameDescription
requestExportDeploymentStatefileRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ExportDeploymentStatefileRequest request = new ExportDeploymentStatefileRequest
{
    ParentAsDeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    Draft = false,
};
// Make the request
Statefile response = await configClient.ExportDeploymentStatefileAsync(request);

ExportLockInfo(DeploymentName, CallSettings)

public virtual LockInfo ExportLockInfo(DeploymentName name, CallSettings callSettings = null)

Exports the lock info on a locked deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
LockInfo

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
LockInfo response = configClient.ExportLockInfo(name);

ExportLockInfo(ExportLockInfoRequest, CallSettings)

public virtual LockInfo ExportLockInfo(ExportLockInfoRequest request, CallSettings callSettings = null)

Exports the lock info on a locked deployment.

Parameters
NameDescription
requestExportLockInfoRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
LockInfo

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ExportLockInfoRequest request = new ExportLockInfoRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
LockInfo response = configClient.ExportLockInfo(request);

ExportLockInfo(string, CallSettings)

public virtual LockInfo ExportLockInfo(string name, CallSettings callSettings = null)

Exports the lock info on a locked deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
LockInfo

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
LockInfo response = configClient.ExportLockInfo(name);

ExportLockInfoAsync(DeploymentName, CallSettings)

public virtual Task<LockInfo> ExportLockInfoAsync(DeploymentName name, CallSettings callSettings = null)

Exports the lock info on a locked deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskLockInfo

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
LockInfo response = await configClient.ExportLockInfoAsync(name);

ExportLockInfoAsync(DeploymentName, CancellationToken)

public virtual Task<LockInfo> ExportLockInfoAsync(DeploymentName name, CancellationToken cancellationToken)

Exports the lock info on a locked deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskLockInfo

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
LockInfo response = await configClient.ExportLockInfoAsync(name);

ExportLockInfoAsync(ExportLockInfoRequest, CallSettings)

public virtual Task<LockInfo> ExportLockInfoAsync(ExportLockInfoRequest request, CallSettings callSettings = null)

Exports the lock info on a locked deployment.

Parameters
NameDescription
requestExportLockInfoRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskLockInfo

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ExportLockInfoRequest request = new ExportLockInfoRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
LockInfo response = await configClient.ExportLockInfoAsync(request);

ExportLockInfoAsync(ExportLockInfoRequest, CancellationToken)

public virtual Task<LockInfo> ExportLockInfoAsync(ExportLockInfoRequest request, CancellationToken cancellationToken)

Exports the lock info on a locked deployment.

Parameters
NameDescription
requestExportLockInfoRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskLockInfo

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ExportLockInfoRequest request = new ExportLockInfoRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
LockInfo response = await configClient.ExportLockInfoAsync(request);

ExportLockInfoAsync(string, CallSettings)

public virtual Task<LockInfo> ExportLockInfoAsync(string name, CallSettings callSettings = null)

Exports the lock info on a locked deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskLockInfo

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
LockInfo response = await configClient.ExportLockInfoAsync(name);

ExportLockInfoAsync(string, CancellationToken)

public virtual Task<LockInfo> ExportLockInfoAsync(string name, CancellationToken cancellationToken)

Exports the lock info on a locked deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskLockInfo

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
LockInfo response = await configClient.ExportLockInfoAsync(name);

ExportPreviewResult(ExportPreviewResultRequest, CallSettings)

public virtual ExportPreviewResultResponse ExportPreviewResult(ExportPreviewResultRequest request, CallSettings callSettings = null)

Export [Preview][google.cloud.config.v1.Preview] results.

Parameters
NameDescription
requestExportPreviewResultRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ExportPreviewResultResponse

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ExportPreviewResultRequest request = new ExportPreviewResultRequest
{
    ParentAsPreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
};
// Make the request
ExportPreviewResultResponse response = configClient.ExportPreviewResult(request);

ExportPreviewResultAsync(ExportPreviewResultRequest, CallSettings)

public virtual Task<ExportPreviewResultResponse> ExportPreviewResultAsync(ExportPreviewResultRequest request, CallSettings callSettings = null)

Export [Preview][google.cloud.config.v1.Preview] results.

Parameters
NameDescription
requestExportPreviewResultRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskExportPreviewResultResponse

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ExportPreviewResultRequest request = new ExportPreviewResultRequest
{
    ParentAsPreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
};
// Make the request
ExportPreviewResultResponse response = await configClient.ExportPreviewResultAsync(request);

ExportPreviewResultAsync(ExportPreviewResultRequest, CancellationToken)

public virtual Task<ExportPreviewResultResponse> ExportPreviewResultAsync(ExportPreviewResultRequest request, CancellationToken cancellationToken)

Export [Preview][google.cloud.config.v1.Preview] results.

Parameters
NameDescription
requestExportPreviewResultRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskExportPreviewResultResponse

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ExportPreviewResultRequest request = new ExportPreviewResultRequest
{
    ParentAsPreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
};
// Make the request
ExportPreviewResultResponse response = await configClient.ExportPreviewResultAsync(request);

ExportRevisionStatefile(ExportRevisionStatefileRequest, CallSettings)

public virtual Statefile ExportRevisionStatefile(ExportRevisionStatefileRequest request, CallSettings callSettings = null)

Exports Terraform state file from a given revision.

Parameters
NameDescription
requestExportRevisionStatefileRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Statefile

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ExportRevisionStatefileRequest request = new ExportRevisionStatefileRequest
{
    ParentAsRevisionName = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]"),
};
// Make the request
Statefile response = configClient.ExportRevisionStatefile(request);

ExportRevisionStatefileAsync(ExportRevisionStatefileRequest, CallSettings)

public virtual Task<Statefile> ExportRevisionStatefileAsync(ExportRevisionStatefileRequest request, CallSettings callSettings = null)

Exports Terraform state file from a given revision.

Parameters
NameDescription
requestExportRevisionStatefileRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ExportRevisionStatefileRequest request = new ExportRevisionStatefileRequest
{
    ParentAsRevisionName = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]"),
};
// Make the request
Statefile response = await configClient.ExportRevisionStatefileAsync(request);

ExportRevisionStatefileAsync(ExportRevisionStatefileRequest, CancellationToken)

public virtual Task<Statefile> ExportRevisionStatefileAsync(ExportRevisionStatefileRequest request, CancellationToken cancellationToken)

Exports Terraform state file from a given revision.

Parameters
NameDescription
requestExportRevisionStatefileRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ExportRevisionStatefileRequest request = new ExportRevisionStatefileRequest
{
    ParentAsRevisionName = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]"),
};
// Make the request
Statefile response = await configClient.ExportRevisionStatefileAsync(request);

GetDeployment(DeploymentName, CallSettings)

public virtual Deployment GetDeployment(DeploymentName name, CallSettings callSettings = null)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Deployment

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Deployment response = configClient.GetDeployment(name);

GetDeployment(GetDeploymentRequest, CallSettings)

public virtual Deployment GetDeployment(GetDeploymentRequest request, CallSettings callSettings = null)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestGetDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Deployment

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
GetDeploymentRequest request = new GetDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Deployment response = configClient.GetDeployment(request);

GetDeployment(string, CallSettings)

public virtual Deployment GetDeployment(string name, CallSettings callSettings = null)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
namestring

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Deployment

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Deployment response = configClient.GetDeployment(name);

GetDeploymentAsync(DeploymentName, CallSettings)

public virtual Task<Deployment> GetDeploymentAsync(DeploymentName name, CallSettings callSettings = null)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskDeployment

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Deployment response = await configClient.GetDeploymentAsync(name);

GetDeploymentAsync(DeploymentName, CancellationToken)

public virtual Task<Deployment> GetDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskDeployment

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Deployment response = await configClient.GetDeploymentAsync(name);

GetDeploymentAsync(GetDeploymentRequest, CallSettings)

public virtual Task<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CallSettings callSettings = null)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestGetDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskDeployment

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetDeploymentRequest request = new GetDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Deployment response = await configClient.GetDeploymentAsync(request);

GetDeploymentAsync(GetDeploymentRequest, CancellationToken)

public virtual Task<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CancellationToken cancellationToken)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestGetDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskDeployment

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetDeploymentRequest request = new GetDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Deployment response = await configClient.GetDeploymentAsync(request);

GetDeploymentAsync(string, CallSettings)

public virtual Task<Deployment> GetDeploymentAsync(string name, CallSettings callSettings = null)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
namestring

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskDeployment

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Deployment response = await configClient.GetDeploymentAsync(name);

GetDeploymentAsync(string, CancellationToken)

public virtual Task<Deployment> GetDeploymentAsync(string name, CancellationToken cancellationToken)

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
namestring

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskDeployment

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Deployment response = await configClient.GetDeploymentAsync(name);

GetPreview(GetPreviewRequest, CallSettings)

public virtual Preview GetPreview(GetPreviewRequest request, CallSettings callSettings = null)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestGetPreviewRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Preview

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
GetPreviewRequest request = new GetPreviewRequest
{
    PreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
};
// Make the request
Preview response = configClient.GetPreview(request);

GetPreview(PreviewName, CallSettings)

public virtual Preview GetPreview(PreviewName name, CallSettings callSettings = null)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namePreviewName

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Preview

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
PreviewName name = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]");
// Make the request
Preview response = configClient.GetPreview(name);

GetPreview(string, CallSettings)

public virtual Preview GetPreview(string name, CallSettings callSettings = null)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namestring

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Preview

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/previews/[PREVIEW]";
// Make the request
Preview response = configClient.GetPreview(name);

GetPreviewAsync(GetPreviewRequest, CallSettings)

public virtual Task<Preview> GetPreviewAsync(GetPreviewRequest request, CallSettings callSettings = null)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestGetPreviewRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPreview

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetPreviewRequest request = new GetPreviewRequest
{
    PreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
};
// Make the request
Preview response = await configClient.GetPreviewAsync(request);

GetPreviewAsync(GetPreviewRequest, CancellationToken)

public virtual Task<Preview> GetPreviewAsync(GetPreviewRequest request, CancellationToken cancellationToken)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestGetPreviewRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPreview

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetPreviewRequest request = new GetPreviewRequest
{
    PreviewName = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]"),
};
// Make the request
Preview response = await configClient.GetPreviewAsync(request);

GetPreviewAsync(PreviewName, CallSettings)

public virtual Task<Preview> GetPreviewAsync(PreviewName name, CallSettings callSettings = null)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namePreviewName

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPreview

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
PreviewName name = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]");
// Make the request
Preview response = await configClient.GetPreviewAsync(name);

GetPreviewAsync(PreviewName, CancellationToken)

public virtual Task<Preview> GetPreviewAsync(PreviewName name, CancellationToken cancellationToken)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namePreviewName

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPreview

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
PreviewName name = PreviewName.FromProjectLocationPreview("[PROJECT]", "[LOCATION]", "[PREVIEW]");
// Make the request
Preview response = await configClient.GetPreviewAsync(name);

GetPreviewAsync(string, CallSettings)

public virtual Task<Preview> GetPreviewAsync(string name, CallSettings callSettings = null)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namestring

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPreview

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/previews/[PREVIEW]";
// Make the request
Preview response = await configClient.GetPreviewAsync(name);

GetPreviewAsync(string, CancellationToken)

public virtual Task<Preview> GetPreviewAsync(string name, CancellationToken cancellationToken)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
namestring

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPreview

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/previews/[PREVIEW]";
// Make the request
Preview response = await configClient.GetPreviewAsync(name);

GetResource(GetResourceRequest, CallSettings)

public virtual Resource GetResource(GetResourceRequest request, CallSettings callSettings = null)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
requestGetResourceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Resource

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
GetResourceRequest request = new GetResourceRequest
{
    ResourceName = ResourceName.FromProjectLocationDeploymentRevisionResource("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]", "[RESOURCE]"),
};
// Make the request
Resource response = configClient.GetResource(request);

GetResource(ResourceName, CallSettings)

public virtual Resource GetResource(ResourceName name, CallSettings callSettings = null)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
nameResourceName

Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Resource

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ResourceName name = ResourceName.FromProjectLocationDeploymentRevisionResource("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]", "[RESOURCE]");
// Make the request
Resource response = configClient.GetResource(name);

GetResource(string, CallSettings)

public virtual Resource GetResource(string name, CallSettings callSettings = null)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
namestring

Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Resource

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]/revisions/[REVISION]/resources/[RESOURCE]";
// Make the request
Resource response = configClient.GetResource(name);

GetResourceAsync(GetResourceRequest, CallSettings)

public virtual Task<Resource> GetResourceAsync(GetResourceRequest request, CallSettings callSettings = null)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
requestGetResourceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskResource

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetResourceRequest request = new GetResourceRequest
{
    ResourceName = ResourceName.FromProjectLocationDeploymentRevisionResource("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]", "[RESOURCE]"),
};
// Make the request
Resource response = await configClient.GetResourceAsync(request);

GetResourceAsync(GetResourceRequest, CancellationToken)

public virtual Task<Resource> GetResourceAsync(GetResourceRequest request, CancellationToken cancellationToken)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
requestGetResourceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskResource

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetResourceRequest request = new GetResourceRequest
{
    ResourceName = ResourceName.FromProjectLocationDeploymentRevisionResource("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]", "[RESOURCE]"),
};
// Make the request
Resource response = await configClient.GetResourceAsync(request);

GetResourceAsync(ResourceName, CallSettings)

public virtual Task<Resource> GetResourceAsync(ResourceName name, CallSettings callSettings = null)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
nameResourceName

Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskResource

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ResourceName name = ResourceName.FromProjectLocationDeploymentRevisionResource("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]", "[RESOURCE]");
// Make the request
Resource response = await configClient.GetResourceAsync(name);

GetResourceAsync(ResourceName, CancellationToken)

public virtual Task<Resource> GetResourceAsync(ResourceName name, CancellationToken cancellationToken)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
nameResourceName

Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskResource

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ResourceName name = ResourceName.FromProjectLocationDeploymentRevisionResource("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]", "[RESOURCE]");
// Make the request
Resource response = await configClient.GetResourceAsync(name);

GetResourceAsync(string, CallSettings)

public virtual Task<Resource> GetResourceAsync(string name, CallSettings callSettings = null)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
namestring

Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskResource

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]/revisions/[REVISION]/resources/[RESOURCE]";
// Make the request
Resource response = await configClient.GetResourceAsync(name);

GetResourceAsync(string, CancellationToken)

public virtual Task<Resource> GetResourceAsync(string name, CancellationToken cancellationToken)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
namestring

Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskResource

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]/revisions/[REVISION]/resources/[RESOURCE]";
// Make the request
Resource response = await configClient.GetResourceAsync(name);

GetRevision(GetRevisionRequest, CallSettings)

public virtual Revision GetRevision(GetRevisionRequest request, CallSettings callSettings = null)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
requestGetRevisionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Revision

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
GetRevisionRequest request = new GetRevisionRequest
{
    RevisionName = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]"),
};
// Make the request
Revision response = configClient.GetRevision(request);

GetRevision(RevisionName, CallSettings)

public virtual Revision GetRevision(RevisionName name, CallSettings callSettings = null)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
nameRevisionName

Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Revision

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
RevisionName name = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]");
// Make the request
Revision response = configClient.GetRevision(name);

GetRevision(string, CallSettings)

public virtual Revision GetRevision(string name, CallSettings callSettings = null)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
namestring

Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Revision

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]/revisions/[REVISION]";
// Make the request
Revision response = configClient.GetRevision(name);

GetRevisionAsync(GetRevisionRequest, CallSettings)

public virtual Task<Revision> GetRevisionAsync(GetRevisionRequest request, CallSettings callSettings = null)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
requestGetRevisionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskRevision

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetRevisionRequest request = new GetRevisionRequest
{
    RevisionName = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]"),
};
// Make the request
Revision response = await configClient.GetRevisionAsync(request);

GetRevisionAsync(GetRevisionRequest, CancellationToken)

public virtual Task<Revision> GetRevisionAsync(GetRevisionRequest request, CancellationToken cancellationToken)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
requestGetRevisionRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskRevision

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetRevisionRequest request = new GetRevisionRequest
{
    RevisionName = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]"),
};
// Make the request
Revision response = await configClient.GetRevisionAsync(request);

GetRevisionAsync(RevisionName, CallSettings)

public virtual Task<Revision> GetRevisionAsync(RevisionName name, CallSettings callSettings = null)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
nameRevisionName

Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskRevision

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
RevisionName name = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]");
// Make the request
Revision response = await configClient.GetRevisionAsync(name);

GetRevisionAsync(RevisionName, CancellationToken)

public virtual Task<Revision> GetRevisionAsync(RevisionName name, CancellationToken cancellationToken)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
nameRevisionName

Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskRevision

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
RevisionName name = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]");
// Make the request
Revision response = await configClient.GetRevisionAsync(name);

GetRevisionAsync(string, CallSettings)

public virtual Task<Revision> GetRevisionAsync(string name, CallSettings callSettings = null)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
namestring

Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskRevision

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]/revisions/[REVISION]";
// Make the request
Revision response = await configClient.GetRevisionAsync(name);

GetRevisionAsync(string, CancellationToken)

public virtual Task<Revision> GetRevisionAsync(string name, CancellationToken cancellationToken)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
namestring

Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskRevision

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]/revisions/[REVISION]";
// Make the request
Revision response = await configClient.GetRevisionAsync(name);

ImportStatefile(DeploymentName, long, CallSettings)

public virtual Statefile ImportStatefile(DeploymentName parent, long lockId, CallSettings callSettings = null)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
parentDeploymentName

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Statefile

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeploymentName parent = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
long lockId = 0L;
// Make the request
Statefile response = configClient.ImportStatefile(parent, lockId);

ImportStatefile(ImportStatefileRequest, CallSettings)

public virtual Statefile ImportStatefile(ImportStatefileRequest request, CallSettings callSettings = null)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
requestImportStatefileRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Statefile

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ImportStatefileRequest request = new ImportStatefileRequest
{
    ParentAsDeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
    SkipDraft = false,
};
// Make the request
Statefile response = configClient.ImportStatefile(request);

ImportStatefile(string, long, CallSettings)

public virtual Statefile ImportStatefile(string parent, long lockId, CallSettings callSettings = null)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
parentstring

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Statefile

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
long lockId = 0L;
// Make the request
Statefile response = configClient.ImportStatefile(parent, lockId);

ImportStatefileAsync(DeploymentName, long, CallSettings)

public virtual Task<Statefile> ImportStatefileAsync(DeploymentName parent, long lockId, CallSettings callSettings = null)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
parentDeploymentName

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName parent = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
long lockId = 0L;
// Make the request
Statefile response = await configClient.ImportStatefileAsync(parent, lockId);

ImportStatefileAsync(DeploymentName, long, CancellationToken)

public virtual Task<Statefile> ImportStatefileAsync(DeploymentName parent, long lockId, CancellationToken cancellationToken)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
parentDeploymentName

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName parent = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
long lockId = 0L;
// Make the request
Statefile response = await configClient.ImportStatefileAsync(parent, lockId);

ImportStatefileAsync(ImportStatefileRequest, CallSettings)

public virtual Task<Statefile> ImportStatefileAsync(ImportStatefileRequest request, CallSettings callSettings = null)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
requestImportStatefileRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ImportStatefileRequest request = new ImportStatefileRequest
{
    ParentAsDeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
    SkipDraft = false,
};
// Make the request
Statefile response = await configClient.ImportStatefileAsync(request);

ImportStatefileAsync(ImportStatefileRequest, CancellationToken)

public virtual Task<Statefile> ImportStatefileAsync(ImportStatefileRequest request, CancellationToken cancellationToken)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
requestImportStatefileRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ImportStatefileRequest request = new ImportStatefileRequest
{
    ParentAsDeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
    SkipDraft = false,
};
// Make the request
Statefile response = await configClient.ImportStatefileAsync(request);

ImportStatefileAsync(string, long, CallSettings)

public virtual Task<Statefile> ImportStatefileAsync(string parent, long lockId, CallSettings callSettings = null)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
parentstring

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
long lockId = 0L;
// Make the request
Statefile response = await configClient.ImportStatefileAsync(parent, lockId);

ImportStatefileAsync(string, long, CancellationToken)

public virtual Task<Statefile> ImportStatefileAsync(string parent, long lockId, CancellationToken cancellationToken)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
parentstring

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskStatefile

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
long lockId = 0L;
// Make the request
Statefile response = await configClient.ImportStatefileAsync(parent, lockId);

ListDeployments(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Deployment][google.cloud.config.v1.Deployment]s in a given project and location.

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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
PagedEnumerableListDeploymentsResponseDeployment

A pageable sequence of Deployment resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListDeploymentsResponse, Deployment> response = configClient.ListDeployments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Deployment 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 (ListDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeployments(ListDeploymentsRequest, CallSettings)

public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(ListDeploymentsRequest request, CallSettings callSettings = null)

Lists [Deployment][google.cloud.config.v1.Deployment]s in a given project and location.

Parameters
NameDescription
requestListDeploymentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListDeploymentsResponseDeployment

A pageable sequence of Deployment resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ListDeploymentsRequest request = new ListDeploymentsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListDeploymentsResponse, Deployment> response = configClient.ListDeployments(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Deployment 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 (ListDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeployments(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Deployment][google.cloud.config.v1.Deployment]s in a given project and location.

Parameters
NameDescription
parentstring

Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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
PagedEnumerableListDeploymentsResponseDeployment

A pageable sequence of Deployment resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListDeploymentsResponse, Deployment> response = configClient.ListDeployments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Deployment 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 (ListDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeploymentsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Deployment][google.cloud.config.v1.Deployment]s in a given project and location.

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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
PagedAsyncEnumerableListDeploymentsResponseDeployment

A pageable asynchronous sequence of Deployment resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> response = configClient.ListDeploymentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Deployment 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((ListDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeploymentsAsync(ListDeploymentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(ListDeploymentsRequest request, CallSettings callSettings = null)

Lists [Deployment][google.cloud.config.v1.Deployment]s in a given project and location.

Parameters
NameDescription
requestListDeploymentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListDeploymentsResponseDeployment

A pageable asynchronous sequence of Deployment resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ListDeploymentsRequest request = new ListDeploymentsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> response = configClient.ListDeploymentsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Deployment 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((ListDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeploymentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Deployment][google.cloud.config.v1.Deployment]s in a given project and location.

Parameters
NameDescription
parentstring

Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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
PagedAsyncEnumerableListDeploymentsResponseDeployment

A pageable asynchronous sequence of Deployment resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> response = configClient.ListDeploymentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Deployment 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((ListDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListPreviews(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListPreviewsResponse, Preview> ListPreviews(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Preview][google.cloud.config.v1.Preview]s in a given project and location.

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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
PagedEnumerableListPreviewsResponsePreview

A pageable sequence of Preview resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListPreviewsResponse, Preview> response = configClient.ListPreviews(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Preview 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 (ListPreviewsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Preview 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<Preview> 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 (Preview 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;

ListPreviews(ListPreviewsRequest, CallSettings)

public virtual PagedEnumerable<ListPreviewsResponse, Preview> ListPreviews(ListPreviewsRequest request, CallSettings callSettings = null)

Lists [Preview][google.cloud.config.v1.Preview]s in a given project and location.

Parameters
NameDescription
requestListPreviewsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListPreviewsResponsePreview

A pageable sequence of Preview resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ListPreviewsRequest request = new ListPreviewsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListPreviewsResponse, Preview> response = configClient.ListPreviews(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Preview 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 (ListPreviewsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Preview 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<Preview> 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 (Preview 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;

ListPreviews(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListPreviewsResponse, Preview> ListPreviews(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Preview][google.cloud.config.v1.Preview]s in a given project and location.

Parameters
NameDescription
parentstring

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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
PagedEnumerableListPreviewsResponsePreview

A pageable sequence of Preview resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListPreviewsResponse, Preview> response = configClient.ListPreviews(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Preview 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 (ListPreviewsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Preview 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<Preview> 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 (Preview 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;

ListPreviewsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListPreviewsResponse, Preview> ListPreviewsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Preview][google.cloud.config.v1.Preview]s in a given project and location.

Parameters
NameDescription
parentLocationName

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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
PagedAsyncEnumerableListPreviewsResponsePreview

A pageable asynchronous sequence of Preview resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListPreviewsResponse, Preview> response = configClient.ListPreviewsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Preview 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((ListPreviewsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Preview 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<Preview> 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 (Preview 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;

ListPreviewsAsync(ListPreviewsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPreviewsResponse, Preview> ListPreviewsAsync(ListPreviewsRequest request, CallSettings callSettings = null)

Lists [Preview][google.cloud.config.v1.Preview]s in a given project and location.

Parameters
NameDescription
requestListPreviewsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListPreviewsResponsePreview

A pageable asynchronous sequence of Preview resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ListPreviewsRequest request = new ListPreviewsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListPreviewsResponse, Preview> response = configClient.ListPreviewsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Preview 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((ListPreviewsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Preview 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<Preview> 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 (Preview 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;

ListPreviewsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListPreviewsResponse, Preview> ListPreviewsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Preview][google.cloud.config.v1.Preview]s in a given project and location.

Parameters
NameDescription
parentstring

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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
PagedAsyncEnumerableListPreviewsResponsePreview

A pageable asynchronous sequence of Preview resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListPreviewsResponse, Preview> response = configClient.ListPreviewsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Preview 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((ListPreviewsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Preview 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<Preview> 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 (Preview 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;

ListResources(ListResourcesRequest, CallSettings)

public virtual PagedEnumerable<ListResourcesResponse, Resource> ListResources(ListResourcesRequest request, CallSettings callSettings = null)

Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.

Parameters
NameDescription
requestListResourcesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListResourcesResponseResource

A pageable sequence of Resource resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ListResourcesRequest request = new ListResourcesRequest
{
    ParentAsRevisionName = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListResourcesResponse, Resource> response = configClient.ListResources(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Resource 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 (ListResourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Resource 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<Resource> 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 (Resource 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;

ListResources(RevisionName, string, int?, CallSettings)

public virtual PagedEnumerable<ListResourcesResponse, Resource> ListResources(RevisionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.

Parameters
NameDescription
parentRevisionName

Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

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
PagedEnumerableListResourcesResponseResource

A pageable sequence of Resource resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
RevisionName parent = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]");
// Make the request
PagedEnumerable<ListResourcesResponse, Resource> response = configClient.ListResources(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Resource 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 (ListResourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Resource 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<Resource> 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 (Resource 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;

ListResources(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListResourcesResponse, Resource> ListResources(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.

Parameters
NameDescription
parentstring

Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

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
PagedEnumerableListResourcesResponseResource

A pageable sequence of Resource resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]/revisions/[REVISION]";
// Make the request
PagedEnumerable<ListResourcesResponse, Resource> response = configClient.ListResources(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Resource 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 (ListResourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Resource 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<Resource> 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 (Resource 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;

ListResourcesAsync(ListResourcesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListResourcesResponse, Resource> ListResourcesAsync(ListResourcesRequest request, CallSettings callSettings = null)

Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.

Parameters
NameDescription
requestListResourcesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListResourcesResponseResource

A pageable asynchronous sequence of Resource resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ListResourcesRequest request = new ListResourcesRequest
{
    ParentAsRevisionName = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListResourcesResponse, Resource> response = configClient.ListResourcesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Resource 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((ListResourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Resource 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<Resource> 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 (Resource 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;

ListResourcesAsync(RevisionName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListResourcesResponse, Resource> ListResourcesAsync(RevisionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.

Parameters
NameDescription
parentRevisionName

Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

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
PagedAsyncEnumerableListResourcesResponseResource

A pageable asynchronous sequence of Resource resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
RevisionName parent = RevisionName.FromProjectLocationDeploymentRevision("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[REVISION]");
// Make the request
PagedAsyncEnumerable<ListResourcesResponse, Resource> response = configClient.ListResourcesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Resource 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((ListResourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Resource 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<Resource> 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 (Resource 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;

ListResourcesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListResourcesResponse, Resource> ListResourcesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.

Parameters
NameDescription
parentstring

Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

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
PagedAsyncEnumerableListResourcesResponseResource

A pageable asynchronous sequence of Resource resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]/revisions/[REVISION]";
// Make the request
PagedAsyncEnumerable<ListResourcesResponse, Resource> response = configClient.ListResourcesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Resource 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((ListResourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Resource 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<Resource> 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 (Resource 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;

ListRevisions(DeploymentName, string, int?, CallSettings)

public virtual PagedEnumerable<ListRevisionsResponse, Revision> ListRevisions(DeploymentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Revision][google.cloud.config.v1.Revision]s of a deployment.

Parameters
NameDescription
parentDeploymentName

Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

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
PagedEnumerableListRevisionsResponseRevision

A pageable sequence of Revision resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeploymentName parent = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
PagedEnumerable<ListRevisionsResponse, Revision> response = configClient.ListRevisions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Revision 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 (ListRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Revision 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<Revision> 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 (Revision 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;

ListRevisions(ListRevisionsRequest, CallSettings)

public virtual PagedEnumerable<ListRevisionsResponse, Revision> ListRevisions(ListRevisionsRequest request, CallSettings callSettings = null)

Lists [Revision][google.cloud.config.v1.Revision]s of a deployment.

Parameters
NameDescription
requestListRevisionsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListRevisionsResponseRevision

A pageable sequence of Revision resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ListRevisionsRequest request = new ListRevisionsRequest
{
    ParentAsDeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListRevisionsResponse, Revision> response = configClient.ListRevisions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Revision 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 (ListRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Revision 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<Revision> 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 (Revision 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;

ListRevisions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListRevisionsResponse, Revision> ListRevisions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Revision][google.cloud.config.v1.Revision]s of a deployment.

Parameters
NameDescription
parentstring

Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

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
PagedEnumerableListRevisionsResponseRevision

A pageable sequence of Revision resources.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
PagedEnumerable<ListRevisionsResponse, Revision> response = configClient.ListRevisions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Revision 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 (ListRevisionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Revision 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<Revision> 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 (Revision 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;

ListRevisionsAsync(DeploymentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRevisionsResponse, Revision> ListRevisionsAsync(DeploymentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Revision][google.cloud.config.v1.Revision]s of a deployment.

Parameters
NameDescription
parentDeploymentName

Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

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
PagedAsyncEnumerableListRevisionsResponseRevision

A pageable asynchronous sequence of Revision resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName parent = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
PagedAsyncEnumerable<ListRevisionsResponse, Revision> response = configClient.ListRevisionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Revision 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((ListRevisionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Revision 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<Revision> 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 (Revision 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;

ListRevisionsAsync(ListRevisionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListRevisionsResponse, Revision> ListRevisionsAsync(ListRevisionsRequest request, CallSettings callSettings = null)

Lists [Revision][google.cloud.config.v1.Revision]s of a deployment.

Parameters
NameDescription
requestListRevisionsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListRevisionsResponseRevision

A pageable asynchronous sequence of Revision resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ListRevisionsRequest request = new ListRevisionsRequest
{
    ParentAsDeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListRevisionsResponse, Revision> response = configClient.ListRevisionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Revision 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((ListRevisionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Revision 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<Revision> 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 (Revision 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;

ListRevisionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRevisionsResponse, Revision> ListRevisionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists [Revision][google.cloud.config.v1.Revision]s of a deployment.

Parameters
NameDescription
parentstring

Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

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
PagedAsyncEnumerableListRevisionsResponseRevision

A pageable asynchronous sequence of Revision resources.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
PagedAsyncEnumerable<ListRevisionsResponse, Revision> response = configClient.ListRevisionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Revision 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((ListRevisionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Revision 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<Revision> 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 (Revision 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;

LockDeployment(DeploymentName, CallSettings)

public virtual Operation<Deployment, OperationMetadata> LockDeployment(DeploymentName name, CallSettings callSettings = null)

Locks a deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.LockDeployment(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceLockDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

LockDeployment(LockDeploymentRequest, CallSettings)

public virtual Operation<Deployment, OperationMetadata> LockDeployment(LockDeploymentRequest request, CallSettings callSettings = null)

Locks a deployment.

Parameters
NameDescription
requestLockDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
LockDeploymentRequest request = new LockDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.LockDeployment(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceLockDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

LockDeployment(string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> LockDeployment(string name, CallSettings callSettings = null)

Locks a deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.LockDeployment(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceLockDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

LockDeploymentAsync(DeploymentName, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> LockDeploymentAsync(DeploymentName name, CallSettings callSettings = null)

Locks a deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.LockDeploymentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceLockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

LockDeploymentAsync(DeploymentName, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> LockDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)

Locks a deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.LockDeploymentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceLockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

LockDeploymentAsync(LockDeploymentRequest, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> LockDeploymentAsync(LockDeploymentRequest request, CallSettings callSettings = null)

Locks a deployment.

Parameters
NameDescription
requestLockDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
LockDeploymentRequest request = new LockDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.LockDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceLockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

LockDeploymentAsync(LockDeploymentRequest, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> LockDeploymentAsync(LockDeploymentRequest request, CancellationToken cancellationToken)

Locks a deployment.

Parameters
NameDescription
requestLockDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
LockDeploymentRequest request = new LockDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.LockDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceLockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

LockDeploymentAsync(string, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> LockDeploymentAsync(string name, CallSettings callSettings = null)

Locks a deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.LockDeploymentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceLockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

LockDeploymentAsync(string, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> LockDeploymentAsync(string name, CancellationToken cancellationToken)

Locks a deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.LockDeploymentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceLockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

PollOnceCreateDeployment(string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> PollOnceCreateDeployment(string operationName, CallSettings callSettings = null)

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

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
OperationDeploymentOperationMetadata

The result of polling the operation.

PollOnceCreateDeploymentAsync(string, CallSettings)

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

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

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
TaskOperationDeploymentOperationMetadata

A task representing the result of polling the operation.

PollOnceCreatePreview(string, CallSettings)

public virtual Operation<Preview, OperationMetadata> PollOnceCreatePreview(string operationName, CallSettings callSettings = null)

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

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
OperationPreviewOperationMetadata

The result of polling the operation.

PollOnceCreatePreviewAsync(string, CallSettings)

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

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

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
TaskOperationPreviewOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteDeployment(string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> PollOnceDeleteDeployment(string operationName, CallSettings callSettings = null)

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

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
OperationDeploymentOperationMetadata

The result of polling the operation.

PollOnceDeleteDeploymentAsync(string, CallSettings)

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

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

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
TaskOperationDeploymentOperationMetadata

A task representing the result of polling the operation.

PollOnceDeletePreview(string, CallSettings)

public virtual Operation<Preview, OperationMetadata> PollOnceDeletePreview(string operationName, CallSettings callSettings = null)

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

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
OperationPreviewOperationMetadata

The result of polling the operation.

PollOnceDeletePreviewAsync(string, CallSettings)

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

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

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
TaskOperationPreviewOperationMetadata

A task representing the result of polling the operation.

PollOnceLockDeployment(string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> PollOnceLockDeployment(string operationName, CallSettings callSettings = null)

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

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
OperationDeploymentOperationMetadata

The result of polling the operation.

PollOnceLockDeploymentAsync(string, CallSettings)

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

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

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
TaskOperationDeploymentOperationMetadata

A task representing the result of polling the operation.

PollOnceUnlockDeployment(string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> PollOnceUnlockDeployment(string operationName, CallSettings callSettings = null)

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

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
OperationDeploymentOperationMetadata

The result of polling the operation.

PollOnceUnlockDeploymentAsync(string, CallSettings)

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

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

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
TaskOperationDeploymentOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateDeployment(string, CallSettings)

public virtual Operation<Deployment, OperationMetadata> PollOnceUpdateDeployment(string operationName, CallSettings callSettings = null)

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

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
OperationDeploymentOperationMetadata

The result of polling the operation.

PollOnceUpdateDeploymentAsync(string, CallSettings)

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

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

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
TaskOperationDeploymentOperationMetadata

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.

UnlockDeployment(DeploymentName, long, CallSettings)

public virtual Operation<Deployment, OperationMetadata> UnlockDeployment(DeploymentName name, long lockId, CallSettings callSettings = null)

Unlocks a locked deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to be unlocked.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
long lockId = 0L;
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.UnlockDeployment(name, lockId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceUnlockDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UnlockDeployment(UnlockDeploymentRequest, CallSettings)

public virtual Operation<Deployment, OperationMetadata> UnlockDeployment(UnlockDeploymentRequest request, CallSettings callSettings = null)

Unlocks a locked deployment.

Parameters
NameDescription
requestUnlockDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
UnlockDeploymentRequest request = new UnlockDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
};
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.UnlockDeployment(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceUnlockDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UnlockDeployment(string, long, CallSettings)

public virtual Operation<Deployment, OperationMetadata> UnlockDeployment(string name, long lockId, CallSettings callSettings = null)

Unlocks a locked deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to be unlocked.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
long lockId = 0L;
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.UnlockDeployment(name, lockId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceUnlockDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UnlockDeploymentAsync(DeploymentName, long, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> UnlockDeploymentAsync(DeploymentName name, long lockId, CallSettings callSettings = null)

Unlocks a locked deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to be unlocked.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
long lockId = 0L;
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UnlockDeploymentAsync(name, lockId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUnlockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UnlockDeploymentAsync(DeploymentName, long, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> UnlockDeploymentAsync(DeploymentName name, long lockId, CancellationToken cancellationToken)

Unlocks a locked deployment.

Parameters
NameDescription
nameDeploymentName

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to be unlocked.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
long lockId = 0L;
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UnlockDeploymentAsync(name, lockId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUnlockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UnlockDeploymentAsync(UnlockDeploymentRequest, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> UnlockDeploymentAsync(UnlockDeploymentRequest request, CallSettings callSettings = null)

Unlocks a locked deployment.

Parameters
NameDescription
requestUnlockDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
UnlockDeploymentRequest request = new UnlockDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UnlockDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUnlockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UnlockDeploymentAsync(UnlockDeploymentRequest, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> UnlockDeploymentAsync(UnlockDeploymentRequest request, CancellationToken cancellationToken)

Unlocks a locked deployment.

Parameters
NameDescription
requestUnlockDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
UnlockDeploymentRequest request = new UnlockDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    LockId = 0L,
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UnlockDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUnlockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UnlockDeploymentAsync(string, long, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> UnlockDeploymentAsync(string name, long lockId, CallSettings callSettings = null)

Unlocks a locked deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to be unlocked.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
long lockId = 0L;
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UnlockDeploymentAsync(name, lockId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUnlockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UnlockDeploymentAsync(string, long, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> UnlockDeploymentAsync(string name, long lockId, CancellationToken cancellationToken)

Unlocks a locked deployment.

Parameters
NameDescription
namestring

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

lockIdlong

Required. Lock ID of the lock file to be unlocked.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deployments/[DEPLOYMENT]";
long lockId = 0L;
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UnlockDeploymentAsync(name, lockId);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUnlockDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UpdateDeployment(Deployment, FieldMask, CallSettings)

public virtual Operation<Deployment, OperationMetadata> UpdateDeployment(Deployment deployment, FieldMask updateMask, CallSettings callSettings = null)

Updates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] to update.

The deployment's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deployments/{deployment}

updateMaskFieldMask

Optional. Field mask used to specify the fields to be overwritten in the Deployment resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
Deployment deployment = new Deployment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.UpdateDeployment(deployment, updateMask);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceUpdateDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UpdateDeployment(UpdateDeploymentRequest, CallSettings)

public virtual Operation<Deployment, OperationMetadata> UpdateDeployment(UpdateDeploymentRequest request, CallSettings callSettings = null)

Updates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestUpdateDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeploymentOperationMetadata

The RPC response.

Example
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
UpdateDeploymentRequest request = new UpdateDeploymentRequest
{
    UpdateMask = new FieldMask(),
    Deployment = new Deployment(),
    RequestId = "",
};
// Make the request
Operation<Deployment, OperationMetadata> response = configClient.UpdateDeployment(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = configClient.PollOnceUpdateDeployment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UpdateDeploymentAsync(Deployment, FieldMask, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> UpdateDeploymentAsync(Deployment deployment, FieldMask updateMask, CallSettings callSettings = null)

Updates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] to update.

The deployment's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deployments/{deployment}

updateMaskFieldMask

Optional. Field mask used to specify the fields to be overwritten in the Deployment resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
Deployment deployment = new Deployment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UpdateDeploymentAsync(deployment, updateMask);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUpdateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UpdateDeploymentAsync(Deployment, FieldMask, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> UpdateDeploymentAsync(Deployment deployment, FieldMask updateMask, CancellationToken cancellationToken)

Updates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
deploymentDeployment

Required. [Deployment][google.cloud.config.v1.Deployment] to update.

The deployment's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deployments/{deployment}

updateMaskFieldMask

Optional. Field mask used to specify the fields to be overwritten in the Deployment resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
Deployment deployment = new Deployment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UpdateDeploymentAsync(deployment, updateMask);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUpdateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UpdateDeploymentAsync(UpdateDeploymentRequest, CallSettings)

public virtual Task<Operation<Deployment, OperationMetadata>> UpdateDeploymentAsync(UpdateDeploymentRequest request, CallSettings callSettings = null)

Updates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestUpdateDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
UpdateDeploymentRequest request = new UpdateDeploymentRequest
{
    UpdateMask = new FieldMask(),
    Deployment = new Deployment(),
    RequestId = "",
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UpdateDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUpdateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}

UpdateDeploymentAsync(UpdateDeploymentRequest, CancellationToken)

public virtual Task<Operation<Deployment, OperationMetadata>> UpdateDeploymentAsync(UpdateDeploymentRequest request, CancellationToken cancellationToken)

Updates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestUpdateDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
UpdateDeploymentRequest request = new UpdateDeploymentRequest
{
    UpdateMask = new FieldMask(),
    Deployment = new Deployment(),
    RequestId = "",
};
// Make the request
Operation<Deployment, OperationMetadata> response = await configClient.UpdateDeploymentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Deployment, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Deployment 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<Deployment, OperationMetadata> retrievedResponse = await configClient.PollOnceUpdateDeploymentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Deployment retrievedResult = retrievedResponse.Result;
}