Class RolloutPlansClient (1.105.0)

GitHub RepositoryProduct Reference

Service Description: The RolloutPlans API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   String project = "project-309310695";
   String rolloutPlan = "rolloutPlan1469104250";
   RolloutPlan response = rolloutPlansClient.get(project, rolloutPlan);
 }

Note: close() needs to be called on the RolloutPlansClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

Delete

Deletes a RolloutPlan.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteRolloutPlanRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String rolloutPlan)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteOperationCallable()

  • deleteCallable()

Get

Gets details of a single project-scoped RolloutPlan.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetRolloutPlanRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String rolloutPlan)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

Insert

Creates a new RolloutPlan in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • insertAsync(InsertRolloutPlanRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, RolloutPlan rolloutPlanResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertOperationCallable()

  • insertCallable()

List

Lists RolloutPlans in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListRolloutPlansRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of RolloutPlansSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RolloutPlansSettings rolloutPlansSettings =
     RolloutPlansSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create(rolloutPlansSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RolloutPlansSettings rolloutPlansSettings =
     RolloutPlansSettings.newBuilder().setEndpoint(myEndpoint).build();
 RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create(rolloutPlansSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > RolloutPlansClient

Static Methods

create()

public static final RolloutPlansClient create()

Constructs an instance of RolloutPlansClient with default settings.

Returns
Type Description
RolloutPlansClient
Exceptions
Type Description
IOException

create(RolloutPlansSettings settings)

public static final RolloutPlansClient create(RolloutPlansSettings settings)

Constructs an instance of RolloutPlansClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings RolloutPlansSettings
Returns
Type Description
RolloutPlansClient
Exceptions
Type Description
IOException

create(RolloutPlansStub stub)

public static final RolloutPlansClient create(RolloutPlansStub stub)

Constructs an instance of RolloutPlansClient, using the given stub for making calls. This is for advanced usage - prefer using create(RolloutPlansSettings).

Parameter
Name Description
stub RolloutPlansStub
Returns
Type Description
RolloutPlansClient

Constructors

RolloutPlansClient(RolloutPlansSettings settings)

protected RolloutPlansClient(RolloutPlansSettings settings)

Constructs an instance of RolloutPlansClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings RolloutPlansSettings

RolloutPlansClient(RolloutPlansStub stub)

protected RolloutPlansClient(RolloutPlansStub stub)
Parameter
Name Description
stub RolloutPlansStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteRolloutPlanRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRolloutPlanRequest request)

Deletes a RolloutPlan.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   DeleteRolloutPlanRequest request =
       DeleteRolloutPlanRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRolloutPlan("rolloutPlan1469104250")
           .build();
   Operation response = rolloutPlansClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteRolloutPlanRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String rolloutPlan)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String rolloutPlan)

Deletes a RolloutPlan.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   String project = "project-309310695";
   String rolloutPlan = "rolloutPlan1469104250";
   Operation response = rolloutPlansClient.deleteAsync(project, rolloutPlan).get();
 }
Parameters
Name Description
project String

Project ID for this request.
rolloutPlan String

Name of the RolloutPlan resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteRolloutPlanRequest,Operation> deleteCallable()

Deletes a RolloutPlan.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   DeleteRolloutPlanRequest request =
       DeleteRolloutPlanRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRolloutPlan("rolloutPlan1469104250")
           .build();
   ApiFuture<Operation> future = rolloutPlansClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteRolloutPlanRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteRolloutPlanRequest,Operation,Operation> deleteOperationCallable()

Deletes a RolloutPlan.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   DeleteRolloutPlanRequest request =
       DeleteRolloutPlanRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRolloutPlan("rolloutPlan1469104250")
           .build();
   OperationFuture<Operation, Operation> future =
       rolloutPlansClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteRolloutPlanRequest,Operation,Operation>

get(GetRolloutPlanRequest request)

public final RolloutPlan get(GetRolloutPlanRequest request)

Gets details of a single project-scoped RolloutPlan.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   GetRolloutPlanRequest request =
       GetRolloutPlanRequest.newBuilder()
           .setProject("project-309310695")
           .setRolloutPlan("rolloutPlan1469104250")
           .build();
   RolloutPlan response = rolloutPlansClient.get(request);
 }
Parameter
Name Description
request GetRolloutPlanRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RolloutPlan

get(String project, String rolloutPlan)

public final RolloutPlan get(String project, String rolloutPlan)

Gets details of a single project-scoped RolloutPlan.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   String project = "project-309310695";
   String rolloutPlan = "rolloutPlan1469104250";
   RolloutPlan response = rolloutPlansClient.get(project, rolloutPlan);
 }
Parameters
Name Description
project String

Project ID for this request.
rolloutPlan String

Name of the persistent rollout plan to return.
Returns
Type Description
RolloutPlan

getCallable()

public final UnaryCallable<GetRolloutPlanRequest,RolloutPlan> getCallable()

Gets details of a single project-scoped RolloutPlan.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   GetRolloutPlanRequest request =
       GetRolloutPlanRequest.newBuilder()
           .setProject("project-309310695")
           .setRolloutPlan("rolloutPlan1469104250")
           .build();
   ApiFuture<RolloutPlan> future = rolloutPlansClient.getCallable().futureCall(request);
   // Do something.
   RolloutPlan response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRolloutPlanRequest,RolloutPlan>

getSettings()

public final @Nullable RolloutPlansSettings getSettings()
Returns
Type Description
@org.jspecify.annotations.Nullable com.google.cloud.compute.v1.RolloutPlansSettings

getStub()

public RolloutPlansStub getStub()
Returns
Type Description
RolloutPlansStub

insertAsync(InsertRolloutPlanRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRolloutPlanRequest request)

Creates a new RolloutPlan in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   InsertRolloutPlanRequest request =
       InsertRolloutPlanRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRolloutPlanResource(RolloutPlan.newBuilder().build())
           .build();
   Operation response = rolloutPlansClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertRolloutPlanRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, RolloutPlan rolloutPlanResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, RolloutPlan rolloutPlanResource)

Creates a new RolloutPlan in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   String project = "project-309310695";
   RolloutPlan rolloutPlanResource = RolloutPlan.newBuilder().build();
   Operation response = rolloutPlansClient.insertAsync(project, rolloutPlanResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
rolloutPlanResource RolloutPlan

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRolloutPlanRequest,Operation> insertCallable()

Creates a new RolloutPlan in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   InsertRolloutPlanRequest request =
       InsertRolloutPlanRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRolloutPlanResource(RolloutPlan.newBuilder().build())
           .build();
   ApiFuture<Operation> future = rolloutPlansClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertRolloutPlanRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertRolloutPlanRequest,Operation,Operation> insertOperationCallable()

Creates a new RolloutPlan in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   InsertRolloutPlanRequest request =
       InsertRolloutPlanRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setRolloutPlanResource(RolloutPlan.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       rolloutPlansClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertRolloutPlanRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListRolloutPlansRequest request)

public final RolloutPlansClient.ListPagedResponse list(ListRolloutPlansRequest request)

Lists RolloutPlans in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   ListRolloutPlansRequest request =
       ListRolloutPlansRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (RolloutPlan element : rolloutPlansClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListRolloutPlansRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RolloutPlansClient.ListPagedResponse

list(String project)

public final RolloutPlansClient.ListPagedResponse list(String project)

Lists RolloutPlans in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   String project = "project-309310695";
   for (RolloutPlan element : rolloutPlansClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
RolloutPlansClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRolloutPlansRequest,RolloutPlansListResponse> listCallable()

Lists RolloutPlans in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   ListRolloutPlansRequest request =
       ListRolloutPlansRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RolloutPlansListResponse response = rolloutPlansClient.listCallable().call(request);
     for (RolloutPlan element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRolloutPlansRequest,RolloutPlansListResponse>

listPagedCallable()

public final UnaryCallable<ListRolloutPlansRequest,RolloutPlansClient.ListPagedResponse> listPagedCallable()

Lists RolloutPlans in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RolloutPlansClient rolloutPlansClient = RolloutPlansClient.create()) {
   ListRolloutPlansRequest request =
       ListRolloutPlansRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<RolloutPlan> future = rolloutPlansClient.listPagedCallable().futureCall(request);
   // Do something.
   for (RolloutPlan element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListRolloutPlansRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()