Compute Engine v1 API - Class RolloutPlansClient (3.28.0)

3.28.0 (latest) 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0

public abstract class RolloutPlansClient

Reference documentation and code samples for the Compute Engine v1 API class RolloutPlansClient.

RolloutPlans client wrapper, for convenient use.

Inheritance

object > RolloutPlansClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

RolloutPlansClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RolloutPlans API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default RolloutPlans scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default RolloutPlans scopes are:

• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/cloud-platform

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual RolloutPlans.RolloutPlansClient GrpcClient { get; }

The underlying gRPC RolloutPlans client

Property Value
Type	Description
RolloutPlansRolloutPlansClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static RolloutPlansClient Create()

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

Returns
Type	Description
RolloutPlansClient	The created RolloutPlansClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskRolloutPlansClient	The task representing the created RolloutPlansClient.

Delete(DeleteRolloutPlanRequest, CallSettings)

public virtual Operation<Operation, Operation> Delete(DeleteRolloutPlanRequest request, CallSettings callSettings = null)

Deletes a RolloutPlan.

Parameters
Name	Description
request	DeleteRolloutPlanRequest 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
OperationOperationOperation	The RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = RolloutPlansClient.Create();
// Initialize request argument(s)
DeleteRolloutPlanRequest request = new DeleteRolloutPlanRequest
{
    RequestId = "",
    Project = "",
    RolloutPlan = "",
};
// Make the request
lro::Operation<Operation, Operation> response = rolloutPlansClient.Delete(request);

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

Delete(string, string, CallSettings)

public virtual Operation<Operation, Operation> Delete(string project, string rolloutPlan, CallSettings callSettings = null)

Deletes a RolloutPlan.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlan	string Name of the RolloutPlan resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = RolloutPlansClient.Create();
// Initialize request argument(s)
string project = "";
string rolloutPlan = "";
// Make the request
lro::Operation<Operation, Operation> response = rolloutPlansClient.Delete(project, rolloutPlan);

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

DeleteAsync(DeleteRolloutPlanRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteRolloutPlanRequest request, CallSettings callSettings = null)

Deletes a RolloutPlan.

Parameters
Name	Description
request	DeleteRolloutPlanRequest 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
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
DeleteRolloutPlanRequest request = new DeleteRolloutPlanRequest
{
    RequestId = "",
    Project = "",
    RolloutPlan = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await rolloutPlansClient.DeleteAsync(request);

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

DeleteAsync(DeleteRolloutPlanRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteRolloutPlanRequest request, CancellationToken cancellationToken)

Deletes a RolloutPlan.

Parameters
Name	Description
request	DeleteRolloutPlanRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
DeleteRolloutPlanRequest request = new DeleteRolloutPlanRequest
{
    RequestId = "",
    Project = "",
    RolloutPlan = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await rolloutPlansClient.DeleteAsync(request);

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

DeleteAsync(string, string, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string rolloutPlan, CallSettings callSettings = null)

Deletes a RolloutPlan.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlan	string Name of the RolloutPlan resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string rolloutPlan = "";
// Make the request
lro::Operation<Operation, Operation> response = await rolloutPlansClient.DeleteAsync(project, rolloutPlan);

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

DeleteAsync(string, string, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string rolloutPlan, CancellationToken cancellationToken)

Deletes a RolloutPlan.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlan	string Name of the RolloutPlan resource to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string rolloutPlan = "";
// Make the request
lro::Operation<Operation, Operation> response = await rolloutPlansClient.DeleteAsync(project, rolloutPlan);

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

Get(GetRolloutPlanRequest, CallSettings)

public virtual RolloutPlan Get(GetRolloutPlanRequest request, CallSettings callSettings = null)

Gets details of a single project-scoped RolloutPlan.

Parameters
Name	Description
request	GetRolloutPlanRequest 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
RolloutPlan	The RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = RolloutPlansClient.Create();
// Initialize request argument(s)
GetRolloutPlanRequest request = new GetRolloutPlanRequest
{
    Project = "",
    RolloutPlan = "",
};
// Make the request
RolloutPlan response = rolloutPlansClient.Get(request);

Get(string, string, CallSettings)

public virtual RolloutPlan Get(string project, string rolloutPlan, CallSettings callSettings = null)

Gets details of a single project-scoped RolloutPlan.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlan	string Name of the persistent rollout plan to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RolloutPlan	The RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = RolloutPlansClient.Create();
// Initialize request argument(s)
string project = "";
string rolloutPlan = "";
// Make the request
RolloutPlan response = rolloutPlansClient.Get(project, rolloutPlan);

GetAsync(GetRolloutPlanRequest, CallSettings)

public virtual Task<RolloutPlan> GetAsync(GetRolloutPlanRequest request, CallSettings callSettings = null)

Gets details of a single project-scoped RolloutPlan.

Parameters
Name	Description
request	GetRolloutPlanRequest 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
TaskRolloutPlan	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
GetRolloutPlanRequest request = new GetRolloutPlanRequest
{
    Project = "",
    RolloutPlan = "",
};
// Make the request
RolloutPlan response = await rolloutPlansClient.GetAsync(request);

GetAsync(GetRolloutPlanRequest, CancellationToken)

public virtual Task<RolloutPlan> GetAsync(GetRolloutPlanRequest request, CancellationToken cancellationToken)

Gets details of a single project-scoped RolloutPlan.

Parameters
Name	Description
request	GetRolloutPlanRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskRolloutPlan	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
GetRolloutPlanRequest request = new GetRolloutPlanRequest
{
    Project = "",
    RolloutPlan = "",
};
// Make the request
RolloutPlan response = await rolloutPlansClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<RolloutPlan> GetAsync(string project, string rolloutPlan, CallSettings callSettings = null)

Gets details of a single project-scoped RolloutPlan.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlan	string Name of the persistent rollout plan to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskRolloutPlan	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string rolloutPlan = "";
// Make the request
RolloutPlan response = await rolloutPlansClient.GetAsync(project, rolloutPlan);

GetAsync(string, string, CancellationToken)

public virtual Task<RolloutPlan> GetAsync(string project, string rolloutPlan, CancellationToken cancellationToken)

Gets details of a single project-scoped RolloutPlan.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlan	string Name of the persistent rollout plan to return.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskRolloutPlan	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string rolloutPlan = "";
// Make the request
RolloutPlan response = await rolloutPlansClient.GetAsync(project, rolloutPlan);

Insert(InsertRolloutPlanRequest, CallSettings)

public virtual Operation<Operation, Operation> Insert(InsertRolloutPlanRequest request, CallSettings callSettings = null)

Creates a new RolloutPlan in a given project and location.

Parameters
Name	Description
request	InsertRolloutPlanRequest 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
OperationOperationOperation	The RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = RolloutPlansClient.Create();
// Initialize request argument(s)
InsertRolloutPlanRequest request = new InsertRolloutPlanRequest
{
    RequestId = "",
    RolloutPlanResource = new RolloutPlan(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = rolloutPlansClient.Insert(request);

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

Insert(string, RolloutPlan, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, RolloutPlan rolloutPlanResource, CallSettings callSettings = null)

Creates a new RolloutPlan in a given project and location.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlanResource	RolloutPlan The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = RolloutPlansClient.Create();
// Initialize request argument(s)
string project = "";
RolloutPlan rolloutPlanResource = new RolloutPlan();
// Make the request
lro::Operation<Operation, Operation> response = rolloutPlansClient.Insert(project, rolloutPlanResource);

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

InsertAsync(InsertRolloutPlanRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertRolloutPlanRequest request, CallSettings callSettings = null)

Creates a new RolloutPlan in a given project and location.

Parameters
Name	Description
request	InsertRolloutPlanRequest 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
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
InsertRolloutPlanRequest request = new InsertRolloutPlanRequest
{
    RequestId = "",
    RolloutPlanResource = new RolloutPlan(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await rolloutPlansClient.InsertAsync(request);

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

InsertAsync(InsertRolloutPlanRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertRolloutPlanRequest request, CancellationToken cancellationToken)

Creates a new RolloutPlan in a given project and location.

Parameters
Name	Description
request	InsertRolloutPlanRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
InsertRolloutPlanRequest request = new InsertRolloutPlanRequest
{
    RequestId = "",
    RolloutPlanResource = new RolloutPlan(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await rolloutPlansClient.InsertAsync(request);

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

InsertAsync(string, RolloutPlan, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, RolloutPlan rolloutPlanResource, CallSettings callSettings = null)

Creates a new RolloutPlan in a given project and location.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlanResource	RolloutPlan The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
string project = "";
RolloutPlan rolloutPlanResource = new RolloutPlan();
// Make the request
lro::Operation<Operation, Operation> response = await rolloutPlansClient.InsertAsync(project, rolloutPlanResource);

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

InsertAsync(string, RolloutPlan, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, RolloutPlan rolloutPlanResource, CancellationToken cancellationToken)

Creates a new RolloutPlan in a given project and location.

Parameters
Name	Description
project	string Project ID for this request.
rolloutPlanResource	RolloutPlan The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
string project = "";
RolloutPlan rolloutPlanResource = new RolloutPlan();
// Make the request
lro::Operation<Operation, Operation> response = await rolloutPlansClient.InsertAsync(project, rolloutPlanResource);

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

List(ListRolloutPlansRequest, CallSettings)

public virtual PagedEnumerable<RolloutPlansListResponse, RolloutPlan> List(ListRolloutPlansRequest request, CallSettings callSettings = null)

Lists RolloutPlans in a given project and location.

Parameters
Name	Description
request	ListRolloutPlansRequest 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
PagedEnumerableRolloutPlansListResponseRolloutPlan	A pageable sequence of RolloutPlan resources.

Example

// Create client
RolloutPlansClient rolloutPlansClient = RolloutPlansClient.Create();
// Initialize request argument(s)
ListRolloutPlansRequest request = new ListRolloutPlansRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<RolloutPlansListResponse, RolloutPlan> response = rolloutPlansClient.List(request);

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

List(string, string, int?, CallSettings)

public virtual PagedEnumerable<RolloutPlansListResponse, RolloutPlan> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RolloutPlans in a given project and location.

Parameters
Name	Description
project	string Project ID for this request.
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
PagedEnumerableRolloutPlansListResponseRolloutPlan	A pageable sequence of RolloutPlan resources.

Example

// Create client
RolloutPlansClient rolloutPlansClient = RolloutPlansClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<RolloutPlansListResponse, RolloutPlan> response = rolloutPlansClient.List(project);

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

ListAsync(ListRolloutPlansRequest, CallSettings)

public virtual PagedAsyncEnumerable<RolloutPlansListResponse, RolloutPlan> ListAsync(ListRolloutPlansRequest request, CallSettings callSettings = null)

Lists RolloutPlans in a given project and location.

Parameters
Name	Description
request	ListRolloutPlansRequest 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
PagedAsyncEnumerableRolloutPlansListResponseRolloutPlan	A pageable asynchronous sequence of RolloutPlan resources.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
ListRolloutPlansRequest request = new ListRolloutPlansRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<RolloutPlansListResponse, RolloutPlan> response = rolloutPlansClient.ListAsync(request);

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

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (RolloutPlansListResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (RolloutPlan 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<RolloutPlan> 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 (RolloutPlan 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;

ListAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<RolloutPlansListResponse, RolloutPlan> ListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RolloutPlans in a given project and location.

Parameters
Name	Description
project	string Project ID for this request.
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
PagedAsyncEnumerableRolloutPlansListResponseRolloutPlan	A pageable asynchronous sequence of RolloutPlan resources.

Example

// Create client
RolloutPlansClient rolloutPlansClient = await RolloutPlansClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<RolloutPlansListResponse, RolloutPlan> response = rolloutPlansClient.ListAsync(project);

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

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (RolloutPlansListResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (RolloutPlan 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<RolloutPlan> 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 (RolloutPlan 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;

PollOnceDelete(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)

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

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
OperationOperationOperation	The result of polling the operation.

PollOnceDeleteAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationOperationOperation	A task representing the result of polling the operation.

PollOnceInsert(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)

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

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
OperationOperationOperation	The result of polling the operation.

PollOnceInsertAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationOperationOperation	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.