Cloud Security Compliance v1 API - Class DeploymentClient (1.0.0-beta01)

public abstract class DeploymentClient

Reference documentation and code samples for the Cloud Security Compliance v1 API class DeploymentClient.

Deployment client wrapper, for convenient use.

Inheritance

object > DeploymentClient

Derived Types

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Remarks

Service describing handlers for resources

Properties

CreateFrameworkDeploymentOperationsClient

public virtual OperationsClient CreateFrameworkDeploymentOperationsClient { get; }

The long-running operations client for CreateFrameworkDeployment.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Deployment scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default Deployment scopes are:

DeleteFrameworkDeploymentOperationsClient

public virtual OperationsClient DeleteFrameworkDeploymentOperationsClient { get; }

The long-running operations client for DeleteFrameworkDeployment.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual Deployment.DeploymentClient GrpcClient { get; }

The underlying gRPC Deployment client

Property Value
Type Description
DeploymentDeploymentClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static DeploymentClient Create()

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

Returns
Type Description
DeploymentClient

The created DeploymentClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDeploymentClient

The task representing the created DeploymentClient.

CreateFrameworkDeployment(CreateFrameworkDeploymentRequest, CallSettings)

public virtual Operation<FrameworkDeployment, OperationMetadata> CreateFrameworkDeployment(CreateFrameworkDeploymentRequest request, CallSettings callSettings = null)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
request CreateFrameworkDeploymentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationFrameworkDeploymentOperationMetadata

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
CreateFrameworkDeploymentRequest request = new CreateFrameworkDeploymentRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    FrameworkDeploymentId = "",
    FrameworkDeployment = new FrameworkDeployment(),
};
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = deploymentClient.CreateFrameworkDeployment(request);

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

CreateFrameworkDeployment(OrganizationLocationName, FrameworkDeployment, string, CallSettings)

public virtual Operation<FrameworkDeployment, OperationMetadata> CreateFrameworkDeployment(OrganizationLocationName parent, FrameworkDeployment frameworkDeployment, string frameworkDeploymentId, CallSettings callSettings = null)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
parent OrganizationLocationName

Required. Value for parent. Supported formats: organizations/{organization}/locations/{location} Only global location is supported.

frameworkDeployment FrameworkDeployment

Required. The resource being created.

frameworkDeploymentId string

Optional. User provided identifier. It should be unique in scope of a parent Please note that this is optional and if not provided, a random UUID will be generated.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationFrameworkDeploymentOperationMetadata

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
FrameworkDeployment frameworkDeployment = new FrameworkDeployment();
string frameworkDeploymentId = "";
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = deploymentClient.CreateFrameworkDeployment(parent, frameworkDeployment, frameworkDeploymentId);

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

CreateFrameworkDeployment(string, FrameworkDeployment, string, CallSettings)

public virtual Operation<FrameworkDeployment, OperationMetadata> CreateFrameworkDeployment(string parent, FrameworkDeployment frameworkDeployment, string frameworkDeploymentId, CallSettings callSettings = null)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent. Supported formats: organizations/{organization}/locations/{location} Only global location is supported.

frameworkDeployment FrameworkDeployment

Required. The resource being created.

frameworkDeploymentId string

Optional. User provided identifier. It should be unique in scope of a parent Please note that this is optional and if not provided, a random UUID will be generated.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationFrameworkDeploymentOperationMetadata

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
FrameworkDeployment frameworkDeployment = new FrameworkDeployment();
string frameworkDeploymentId = "";
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = deploymentClient.CreateFrameworkDeployment(parent, frameworkDeployment, frameworkDeploymentId);

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

CreateFrameworkDeploymentAsync(CreateFrameworkDeploymentRequest, CallSettings)

public virtual Task<Operation<FrameworkDeployment, OperationMetadata>> CreateFrameworkDeploymentAsync(CreateFrameworkDeploymentRequest request, CallSettings callSettings = null)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
request CreateFrameworkDeploymentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationFrameworkDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
CreateFrameworkDeploymentRequest request = new CreateFrameworkDeploymentRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    FrameworkDeploymentId = "",
    FrameworkDeployment = new FrameworkDeployment(),
};
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = await deploymentClient.CreateFrameworkDeploymentAsync(request);

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

CreateFrameworkDeploymentAsync(CreateFrameworkDeploymentRequest, CancellationToken)

public virtual Task<Operation<FrameworkDeployment, OperationMetadata>> CreateFrameworkDeploymentAsync(CreateFrameworkDeploymentRequest request, CancellationToken cancellationToken)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
request CreateFrameworkDeploymentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationFrameworkDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
CreateFrameworkDeploymentRequest request = new CreateFrameworkDeploymentRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    FrameworkDeploymentId = "",
    FrameworkDeployment = new FrameworkDeployment(),
};
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = await deploymentClient.CreateFrameworkDeploymentAsync(request);

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

CreateFrameworkDeploymentAsync(OrganizationLocationName, FrameworkDeployment, string, CallSettings)

public virtual Task<Operation<FrameworkDeployment, OperationMetadata>> CreateFrameworkDeploymentAsync(OrganizationLocationName parent, FrameworkDeployment frameworkDeployment, string frameworkDeploymentId, CallSettings callSettings = null)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
parent OrganizationLocationName

Required. Value for parent. Supported formats: organizations/{organization}/locations/{location} Only global location is supported.

frameworkDeployment FrameworkDeployment

Required. The resource being created.

frameworkDeploymentId string

Optional. User provided identifier. It should be unique in scope of a parent Please note that this is optional and if not provided, a random UUID will be generated.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationFrameworkDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
FrameworkDeployment frameworkDeployment = new FrameworkDeployment();
string frameworkDeploymentId = "";
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = await deploymentClient.CreateFrameworkDeploymentAsync(parent, frameworkDeployment, frameworkDeploymentId);

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

CreateFrameworkDeploymentAsync(OrganizationLocationName, FrameworkDeployment, string, CancellationToken)

public virtual Task<Operation<FrameworkDeployment, OperationMetadata>> CreateFrameworkDeploymentAsync(OrganizationLocationName parent, FrameworkDeployment frameworkDeployment, string frameworkDeploymentId, CancellationToken cancellationToken)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
parent OrganizationLocationName

Required. Value for parent. Supported formats: organizations/{organization}/locations/{location} Only global location is supported.

frameworkDeployment FrameworkDeployment

Required. The resource being created.

frameworkDeploymentId string

Optional. User provided identifier. It should be unique in scope of a parent Please note that this is optional and if not provided, a random UUID will be generated.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationFrameworkDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
FrameworkDeployment frameworkDeployment = new FrameworkDeployment();
string frameworkDeploymentId = "";
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = await deploymentClient.CreateFrameworkDeploymentAsync(parent, frameworkDeployment, frameworkDeploymentId);

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

CreateFrameworkDeploymentAsync(string, FrameworkDeployment, string, CallSettings)

public virtual Task<Operation<FrameworkDeployment, OperationMetadata>> CreateFrameworkDeploymentAsync(string parent, FrameworkDeployment frameworkDeployment, string frameworkDeploymentId, CallSettings callSettings = null)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent. Supported formats: organizations/{organization}/locations/{location} Only global location is supported.

frameworkDeployment FrameworkDeployment

Required. The resource being created.

frameworkDeploymentId string

Optional. User provided identifier. It should be unique in scope of a parent Please note that this is optional and if not provided, a random UUID will be generated.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationFrameworkDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
FrameworkDeployment frameworkDeployment = new FrameworkDeployment();
string frameworkDeploymentId = "";
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = await deploymentClient.CreateFrameworkDeploymentAsync(parent, frameworkDeployment, frameworkDeploymentId);

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

CreateFrameworkDeploymentAsync(string, FrameworkDeployment, string, CancellationToken)

public virtual Task<Operation<FrameworkDeployment, OperationMetadata>> CreateFrameworkDeploymentAsync(string parent, FrameworkDeployment frameworkDeployment, string frameworkDeploymentId, CancellationToken cancellationToken)

Creates a new FrameworkDeployment in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent. Supported formats: organizations/{organization}/locations/{location} Only global location is supported.

frameworkDeployment FrameworkDeployment

Required. The resource being created.

frameworkDeploymentId string

Optional. User provided identifier. It should be unique in scope of a parent Please note that this is optional and if not provided, a random UUID will be generated.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationFrameworkDeploymentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
FrameworkDeployment frameworkDeployment = new FrameworkDeployment();
string frameworkDeploymentId = "";
// Make the request
Operation<FrameworkDeployment, OperationMetadata> response = await deploymentClient.CreateFrameworkDeploymentAsync(parent, frameworkDeployment, frameworkDeploymentId);

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

DeleteFrameworkDeployment(DeleteFrameworkDeploymentRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteFrameworkDeployment(DeleteFrameworkDeploymentRequest request, CallSettings callSettings = null)

Deletes a single FrameworkDeployment.

Parameters
Name Description
request DeleteFrameworkDeploymentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
DeleteFrameworkDeploymentRequest request = new DeleteFrameworkDeploymentRequest
{
    FrameworkDeploymentName = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]"),
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = deploymentClient.DeleteFrameworkDeployment(request);

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

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

DeleteFrameworkDeployment(FrameworkDeploymentName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteFrameworkDeployment(FrameworkDeploymentName name, CallSettings callSettings = null)

Deletes a single FrameworkDeployment.

Parameters
Name Description
name FrameworkDeploymentName

Required. Name of the framework deployment to be deleted FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
FrameworkDeploymentName name = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
// Make the request
Operation<Empty, OperationMetadata> response = deploymentClient.DeleteFrameworkDeployment(name);

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

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

DeleteFrameworkDeployment(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteFrameworkDeployment(string name, CallSettings callSettings = null)

Deletes a single FrameworkDeployment.

Parameters
Name Description
name string

Required. Name of the framework deployment to be deleted FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworkDeployments/[FRAMEWORK_DEPLOYMENT]";
// Make the request
Operation<Empty, OperationMetadata> response = deploymentClient.DeleteFrameworkDeployment(name);

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

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

DeleteFrameworkDeploymentAsync(DeleteFrameworkDeploymentRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteFrameworkDeploymentAsync(DeleteFrameworkDeploymentRequest request, CallSettings callSettings = null)

Deletes a single FrameworkDeployment.

Parameters
Name Description
request DeleteFrameworkDeploymentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
DeleteFrameworkDeploymentRequest request = new DeleteFrameworkDeploymentRequest
{
    FrameworkDeploymentName = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]"),
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await deploymentClient.DeleteFrameworkDeploymentAsync(request);

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

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

DeleteFrameworkDeploymentAsync(DeleteFrameworkDeploymentRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteFrameworkDeploymentAsync(DeleteFrameworkDeploymentRequest request, CancellationToken cancellationToken)

Deletes a single FrameworkDeployment.

Parameters
Name Description
request DeleteFrameworkDeploymentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
DeleteFrameworkDeploymentRequest request = new DeleteFrameworkDeploymentRequest
{
    FrameworkDeploymentName = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]"),
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await deploymentClient.DeleteFrameworkDeploymentAsync(request);

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

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

DeleteFrameworkDeploymentAsync(FrameworkDeploymentName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteFrameworkDeploymentAsync(FrameworkDeploymentName name, CallSettings callSettings = null)

Deletes a single FrameworkDeployment.

Parameters
Name Description
name FrameworkDeploymentName

Required. Name of the framework deployment to be deleted FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
FrameworkDeploymentName name = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
// Make the request
Operation<Empty, OperationMetadata> response = await deploymentClient.DeleteFrameworkDeploymentAsync(name);

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

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

DeleteFrameworkDeploymentAsync(FrameworkDeploymentName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteFrameworkDeploymentAsync(FrameworkDeploymentName name, CancellationToken cancellationToken)

Deletes a single FrameworkDeployment.

Parameters
Name Description
name FrameworkDeploymentName

Required. Name of the framework deployment to be deleted FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
FrameworkDeploymentName name = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
// Make the request
Operation<Empty, OperationMetadata> response = await deploymentClient.DeleteFrameworkDeploymentAsync(name);

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

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

DeleteFrameworkDeploymentAsync(string, CallSettings)

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

Deletes a single FrameworkDeployment.

Parameters
Name Description
name string

Required. Name of the framework deployment to be deleted FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworkDeployments/[FRAMEWORK_DEPLOYMENT]";
// Make the request
Operation<Empty, OperationMetadata> response = await deploymentClient.DeleteFrameworkDeploymentAsync(name);

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

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

DeleteFrameworkDeploymentAsync(string, CancellationToken)

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

Deletes a single FrameworkDeployment.

Parameters
Name Description
name string

Required. Name of the framework deployment to be deleted FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworkDeployments/[FRAMEWORK_DEPLOYMENT]";
// Make the request
Operation<Empty, OperationMetadata> response = await deploymentClient.DeleteFrameworkDeploymentAsync(name);

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

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

GetCloudControlDeployment(CloudControlDeploymentName, CallSettings)

public virtual CloudControlDeployment GetCloudControlDeployment(CloudControlDeploymentName name, CallSettings callSettings = null)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
name CloudControlDeploymentName

Required. CloudControlDeployment name in either of the following formats: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CloudControlDeployment

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
CloudControlDeploymentName name = CloudControlDeploymentName.FromOrganizationLocationCloudControlDeployment("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]");
// Make the request
CloudControlDeployment response = deploymentClient.GetCloudControlDeployment(name);

GetCloudControlDeployment(GetCloudControlDeploymentRequest, CallSettings)

public virtual CloudControlDeployment GetCloudControlDeployment(GetCloudControlDeploymentRequest request, CallSettings callSettings = null)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
request GetCloudControlDeploymentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CloudControlDeployment

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
GetCloudControlDeploymentRequest request = new GetCloudControlDeploymentRequest
{
    CloudControlDeploymentName = CloudControlDeploymentName.FromOrganizationLocationCloudControlDeployment("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]"),
};
// Make the request
CloudControlDeployment response = deploymentClient.GetCloudControlDeployment(request);

GetCloudControlDeployment(string, CallSettings)

public virtual CloudControlDeployment GetCloudControlDeployment(string name, CallSettings callSettings = null)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
name string

Required. CloudControlDeployment name in either of the following formats: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CloudControlDeployment

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControlDeployments/[CLOUD_CONTROL_DEPLOYMENT]";
// Make the request
CloudControlDeployment response = deploymentClient.GetCloudControlDeployment(name);

GetCloudControlDeploymentAsync(CloudControlDeploymentName, CallSettings)

public virtual Task<CloudControlDeployment> GetCloudControlDeploymentAsync(CloudControlDeploymentName name, CallSettings callSettings = null)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
name CloudControlDeploymentName

Required. CloudControlDeployment name in either of the following formats: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCloudControlDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
CloudControlDeploymentName name = CloudControlDeploymentName.FromOrganizationLocationCloudControlDeployment("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]");
// Make the request
CloudControlDeployment response = await deploymentClient.GetCloudControlDeploymentAsync(name);

GetCloudControlDeploymentAsync(CloudControlDeploymentName, CancellationToken)

public virtual Task<CloudControlDeployment> GetCloudControlDeploymentAsync(CloudControlDeploymentName name, CancellationToken cancellationToken)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
name CloudControlDeploymentName

Required. CloudControlDeployment name in either of the following formats: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCloudControlDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
CloudControlDeploymentName name = CloudControlDeploymentName.FromOrganizationLocationCloudControlDeployment("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]");
// Make the request
CloudControlDeployment response = await deploymentClient.GetCloudControlDeploymentAsync(name);

GetCloudControlDeploymentAsync(GetCloudControlDeploymentRequest, CallSettings)

public virtual Task<CloudControlDeployment> GetCloudControlDeploymentAsync(GetCloudControlDeploymentRequest request, CallSettings callSettings = null)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
request GetCloudControlDeploymentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCloudControlDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
GetCloudControlDeploymentRequest request = new GetCloudControlDeploymentRequest
{
    CloudControlDeploymentName = CloudControlDeploymentName.FromOrganizationLocationCloudControlDeployment("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]"),
};
// Make the request
CloudControlDeployment response = await deploymentClient.GetCloudControlDeploymentAsync(request);

GetCloudControlDeploymentAsync(GetCloudControlDeploymentRequest, CancellationToken)

public virtual Task<CloudControlDeployment> GetCloudControlDeploymentAsync(GetCloudControlDeploymentRequest request, CancellationToken cancellationToken)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
request GetCloudControlDeploymentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCloudControlDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
GetCloudControlDeploymentRequest request = new GetCloudControlDeploymentRequest
{
    CloudControlDeploymentName = CloudControlDeploymentName.FromOrganizationLocationCloudControlDeployment("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]"),
};
// Make the request
CloudControlDeployment response = await deploymentClient.GetCloudControlDeploymentAsync(request);

GetCloudControlDeploymentAsync(string, CallSettings)

public virtual Task<CloudControlDeployment> GetCloudControlDeploymentAsync(string name, CallSettings callSettings = null)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
name string

Required. CloudControlDeployment name in either of the following formats: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskCloudControlDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControlDeployments/[CLOUD_CONTROL_DEPLOYMENT]";
// Make the request
CloudControlDeployment response = await deploymentClient.GetCloudControlDeploymentAsync(name);

GetCloudControlDeploymentAsync(string, CancellationToken)

public virtual Task<CloudControlDeployment> GetCloudControlDeploymentAsync(string name, CancellationToken cancellationToken)

Gets details of a single CloudControlDeployment.

Parameters
Name Description
name string

Required. CloudControlDeployment name in either of the following formats: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskCloudControlDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControlDeployments/[CLOUD_CONTROL_DEPLOYMENT]";
// Make the request
CloudControlDeployment response = await deploymentClient.GetCloudControlDeploymentAsync(name);

GetFrameworkDeployment(FrameworkDeploymentName, CallSettings)

public virtual FrameworkDeployment GetFrameworkDeployment(FrameworkDeploymentName name, CallSettings callSettings = null)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
name FrameworkDeploymentName

Required. FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
FrameworkDeployment

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
FrameworkDeploymentName name = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
// Make the request
FrameworkDeployment response = deploymentClient.GetFrameworkDeployment(name);

GetFrameworkDeployment(GetFrameworkDeploymentRequest, CallSettings)

public virtual FrameworkDeployment GetFrameworkDeployment(GetFrameworkDeploymentRequest request, CallSettings callSettings = null)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
request GetFrameworkDeploymentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
FrameworkDeployment

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
GetFrameworkDeploymentRequest request = new GetFrameworkDeploymentRequest
{
    FrameworkDeploymentName = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]"),
};
// Make the request
FrameworkDeployment response = deploymentClient.GetFrameworkDeployment(request);

GetFrameworkDeployment(string, CallSettings)

public virtual FrameworkDeployment GetFrameworkDeployment(string name, CallSettings callSettings = null)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
name string

Required. FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
FrameworkDeployment

The RPC response.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworkDeployments/[FRAMEWORK_DEPLOYMENT]";
// Make the request
FrameworkDeployment response = deploymentClient.GetFrameworkDeployment(name);

GetFrameworkDeploymentAsync(FrameworkDeploymentName, CallSettings)

public virtual Task<FrameworkDeployment> GetFrameworkDeploymentAsync(FrameworkDeploymentName name, CallSettings callSettings = null)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
name FrameworkDeploymentName

Required. FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskFrameworkDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
FrameworkDeploymentName name = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
// Make the request
FrameworkDeployment response = await deploymentClient.GetFrameworkDeploymentAsync(name);

GetFrameworkDeploymentAsync(FrameworkDeploymentName, CancellationToken)

public virtual Task<FrameworkDeployment> GetFrameworkDeploymentAsync(FrameworkDeploymentName name, CancellationToken cancellationToken)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
name FrameworkDeploymentName

Required. FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskFrameworkDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
FrameworkDeploymentName name = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
// Make the request
FrameworkDeployment response = await deploymentClient.GetFrameworkDeploymentAsync(name);

GetFrameworkDeploymentAsync(GetFrameworkDeploymentRequest, CallSettings)

public virtual Task<FrameworkDeployment> GetFrameworkDeploymentAsync(GetFrameworkDeploymentRequest request, CallSettings callSettings = null)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
request GetFrameworkDeploymentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskFrameworkDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
GetFrameworkDeploymentRequest request = new GetFrameworkDeploymentRequest
{
    FrameworkDeploymentName = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]"),
};
// Make the request
FrameworkDeployment response = await deploymentClient.GetFrameworkDeploymentAsync(request);

GetFrameworkDeploymentAsync(GetFrameworkDeploymentRequest, CancellationToken)

public virtual Task<FrameworkDeployment> GetFrameworkDeploymentAsync(GetFrameworkDeploymentRequest request, CancellationToken cancellationToken)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
request GetFrameworkDeploymentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskFrameworkDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
GetFrameworkDeploymentRequest request = new GetFrameworkDeploymentRequest
{
    FrameworkDeploymentName = FrameworkDeploymentName.FromOrganizationLocationFrameworkDeployment("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]"),
};
// Make the request
FrameworkDeployment response = await deploymentClient.GetFrameworkDeploymentAsync(request);

GetFrameworkDeploymentAsync(string, CallSettings)

public virtual Task<FrameworkDeployment> GetFrameworkDeploymentAsync(string name, CallSettings callSettings = null)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
name string

Required. FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskFrameworkDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworkDeployments/[FRAMEWORK_DEPLOYMENT]";
// Make the request
FrameworkDeployment response = await deploymentClient.GetFrameworkDeploymentAsync(name);

GetFrameworkDeploymentAsync(string, CancellationToken)

public virtual Task<FrameworkDeployment> GetFrameworkDeploymentAsync(string name, CancellationToken cancellationToken)

Gets details of a single FrameworkDeployment.

Parameters
Name Description
name string

Required. FrameworkDeployment name in either of the following formats: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskFrameworkDeployment

A Task containing the RPC response.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworkDeployments/[FRAMEWORK_DEPLOYMENT]";
// Make the request
FrameworkDeployment response = await deploymentClient.GetFrameworkDeploymentAsync(name);

ListCloudControlDeployments(ListCloudControlDeploymentsRequest, CallSettings)

public virtual PagedEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> ListCloudControlDeployments(ListCloudControlDeploymentsRequest request, CallSettings callSettings = null)

Lists CloudControlDeployments under a given parent.

Parameters
Name Description
request ListCloudControlDeploymentsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListCloudControlDeploymentsResponseCloudControlDeployment

A pageable sequence of CloudControlDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
ListCloudControlDeploymentsRequest request = new ListCloudControlDeploymentsRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> response = deploymentClient.ListCloudControlDeployments(request);

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

ListCloudControlDeployments(OrganizationLocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> ListCloudControlDeployments(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists CloudControlDeployments under a given parent.

Parameters
Name Description
parent OrganizationLocationName

Required. Parent value for ListCloudControlDeploymentsRequest.

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListCloudControlDeploymentsResponseCloudControlDeployment

A pageable sequence of CloudControlDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> response = deploymentClient.ListCloudControlDeployments(parent);

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

ListCloudControlDeployments(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> ListCloudControlDeployments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists CloudControlDeployments under a given parent.

Parameters
Name Description
parent string

Required. Parent value for ListCloudControlDeploymentsRequest.

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListCloudControlDeploymentsResponseCloudControlDeployment

A pageable sequence of CloudControlDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> response = deploymentClient.ListCloudControlDeployments(parent);

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

ListCloudControlDeploymentsAsync(ListCloudControlDeploymentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> ListCloudControlDeploymentsAsync(ListCloudControlDeploymentsRequest request, CallSettings callSettings = null)

Lists CloudControlDeployments under a given parent.

Parameters
Name Description
request ListCloudControlDeploymentsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListCloudControlDeploymentsResponseCloudControlDeployment

A pageable asynchronous sequence of CloudControlDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
ListCloudControlDeploymentsRequest request = new ListCloudControlDeploymentsRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> response = deploymentClient.ListCloudControlDeploymentsAsync(request);

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

ListCloudControlDeploymentsAsync(OrganizationLocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> ListCloudControlDeploymentsAsync(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists CloudControlDeployments under a given parent.

Parameters
Name Description
parent OrganizationLocationName

Required. Parent value for ListCloudControlDeploymentsRequest.

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListCloudControlDeploymentsResponseCloudControlDeployment

A pageable asynchronous sequence of CloudControlDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> response = deploymentClient.ListCloudControlDeploymentsAsync(parent);

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

ListCloudControlDeploymentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> ListCloudControlDeploymentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists CloudControlDeployments under a given parent.

Parameters
Name Description
parent string

Required. Parent value for ListCloudControlDeploymentsRequest.

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListCloudControlDeploymentsResponseCloudControlDeployment

A pageable asynchronous sequence of CloudControlDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListCloudControlDeploymentsResponse, CloudControlDeployment> response = deploymentClient.ListCloudControlDeploymentsAsync(parent);

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

ListFrameworkDeployments(ListFrameworkDeploymentsRequest, CallSettings)

public virtual PagedEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> ListFrameworkDeployments(ListFrameworkDeploymentsRequest request, CallSettings callSettings = null)

Lists FrameworkDeployments in a given parent and location.

Parameters
Name Description
request ListFrameworkDeploymentsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListFrameworkDeploymentsResponseFrameworkDeployment

A pageable sequence of FrameworkDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
ListFrameworkDeploymentsRequest request = new ListFrameworkDeploymentsRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> response = deploymentClient.ListFrameworkDeployments(request);

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

ListFrameworkDeployments(OrganizationLocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> ListFrameworkDeployments(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists FrameworkDeployments in a given parent and location.

Parameters
Name Description
parent OrganizationLocationName

Required. Parent value for ListFrameworkDeploymentsRequest.

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListFrameworkDeploymentsResponseFrameworkDeployment

A pageable sequence of FrameworkDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> response = deploymentClient.ListFrameworkDeployments(parent);

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

ListFrameworkDeployments(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> ListFrameworkDeployments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists FrameworkDeployments in a given parent and location.

Parameters
Name Description
parent string

Required. Parent value for ListFrameworkDeploymentsRequest.

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListFrameworkDeploymentsResponseFrameworkDeployment

A pageable sequence of FrameworkDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = DeploymentClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> response = deploymentClient.ListFrameworkDeployments(parent);

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

ListFrameworkDeploymentsAsync(ListFrameworkDeploymentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> ListFrameworkDeploymentsAsync(ListFrameworkDeploymentsRequest request, CallSettings callSettings = null)

Lists FrameworkDeployments in a given parent and location.

Parameters
Name Description
request ListFrameworkDeploymentsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListFrameworkDeploymentsResponseFrameworkDeployment

A pageable asynchronous sequence of FrameworkDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
ListFrameworkDeploymentsRequest request = new ListFrameworkDeploymentsRequest
{
    ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> response = deploymentClient.ListFrameworkDeploymentsAsync(request);

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

ListFrameworkDeploymentsAsync(OrganizationLocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> ListFrameworkDeploymentsAsync(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists FrameworkDeployments in a given parent and location.

Parameters
Name Description
parent OrganizationLocationName

Required. Parent value for ListFrameworkDeploymentsRequest.

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListFrameworkDeploymentsResponseFrameworkDeployment

A pageable asynchronous sequence of FrameworkDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> response = deploymentClient.ListFrameworkDeploymentsAsync(parent);

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

ListFrameworkDeploymentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> ListFrameworkDeploymentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists FrameworkDeployments in a given parent and location.

Parameters
Name Description
parent string

Required. Parent value for ListFrameworkDeploymentsRequest.

pageToken string

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

pageSize int

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListFrameworkDeploymentsResponseFrameworkDeployment

A pageable asynchronous sequence of FrameworkDeployment resources.

Example
// Create client
DeploymentClient deploymentClient = await DeploymentClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListFrameworkDeploymentsResponse, FrameworkDeployment> response = deploymentClient.ListFrameworkDeploymentsAsync(parent);

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

PollOnceCreateFrameworkDeployment(string, CallSettings)

public virtual Operation<FrameworkDeployment, OperationMetadata> PollOnceCreateFrameworkDeployment(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationFrameworkDeploymentOperationMetadata

The result of polling the operation.

PollOnceCreateFrameworkDeploymentAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationFrameworkDeploymentOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteFrameworkDeployment(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteFrameworkDeploymentAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

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
Type Description
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.