Class SaasRolloutsClient (0.2.0)

Service Description: Manages the rollout of SaaS services.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   RolloutName name = RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]");
   Rollout response = saasRolloutsClient.getRollout(name);
 }

Note: close() needs to be called on the SaasRolloutsClient 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
ListRollouts	Retrieve a collection of rollouts.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRollouts(ListRolloutsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRollouts(LocationName parent) listRollouts(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRolloutsPagedCallable() listRolloutsCallable()
GetRollout	Retrieve a single rollout.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRollout(GetRolloutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRollout(RolloutName name) getRollout(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRolloutCallable()
CreateRollout	Create a new rollout.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createRollout(CreateRolloutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createRollout(LocationName parent, Rollout rollout, String rolloutId) createRollout(String parent, Rollout rollout, String rolloutId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRolloutCallable()
UpdateRollout	Update a single rollout.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateRollout(UpdateRolloutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateRollout(Rollout rollout, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateRolloutCallable()
DeleteRollout	Delete a single rollout.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteRollout(DeleteRolloutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteRollout(RolloutName name) deleteRollout(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteRolloutCallable()
ListRolloutKinds	Retrieve a collection of rollout kinds.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRolloutKinds(ListRolloutKindsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRolloutKinds(LocationName parent) listRolloutKinds(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRolloutKindsPagedCallable() listRolloutKindsCallable()
GetRolloutKind	Retrieve a single rollout kind.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRolloutKind(GetRolloutKindRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRolloutKind(RolloutKindName name) getRolloutKind(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRolloutKindCallable()
CreateRolloutKind	Create a new rollout kind.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createRolloutKind(CreateRolloutKindRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createRolloutKind(LocationName parent, RolloutKind rolloutKind, String rolloutKindId) createRolloutKind(String parent, RolloutKind rolloutKind, String rolloutKindId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRolloutKindCallable()
UpdateRolloutKind	Update a single rollout kind.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateRolloutKind(UpdateRolloutKindRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateRolloutKind(RolloutKind rolloutKind, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateRolloutKindCallable()
DeleteRolloutKind	Delete a single rollout kind.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteRolloutKind(DeleteRolloutKindRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteRolloutKind(RolloutKindName name) deleteRolloutKind(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteRolloutKindCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a ___location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 SaasRolloutsSettings 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
 SaasRolloutsSettings saasRolloutsSettings =
     SaasRolloutsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create(saasRolloutsSettings);

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
 SaasRolloutsSettings saasRolloutsSettings =
     SaasRolloutsSettings.newBuilder().setEndpoint(myEndpoint).build();
 SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create(saasRolloutsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 SaasRolloutsSettings saasRolloutsSettings = SaasRolloutsSettings.newHttpJsonBuilder().build();
 SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create(saasRolloutsSettings);

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

Inheritance

java.lang.Object > SaasRolloutsClient

Static Methods

create()

public static final SaasRolloutsClient create()

Constructs an instance of SaasRolloutsClient with default settings.

Returns
Type	Description
`SaasRolloutsClient`

Exceptions
Type	Description
`IOException`

create(SaasRolloutsSettings settings)

public static final SaasRolloutsClient create(SaasRolloutsSettings settings)

Constructs an instance of SaasRolloutsClient, 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`	`SaasRolloutsSettings`

Returns
Type	Description
`SaasRolloutsClient`

Exceptions
Type	Description
`IOException`

create(SaasRolloutsStub stub)

public static final SaasRolloutsClient create(SaasRolloutsStub stub)

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

Parameter
Name	Description
`stub`	`SaasRolloutsStub`

Returns
Type	Description
`SaasRolloutsClient`

Constructors

SaasRolloutsClient(SaasRolloutsSettings settings)

protected SaasRolloutsClient(SaasRolloutsSettings settings)

Constructs an instance of SaasRolloutsClient, 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`	`SaasRolloutsSettings`

SaasRolloutsClient(SaasRolloutsStub stub)

protected SaasRolloutsClient(SaasRolloutsStub stub)

Parameter
Name	Description
`stub`	`SaasRolloutsStub`

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()

createRollout(CreateRolloutRequest request)

public final Rollout createRollout(CreateRolloutRequest request)

Create a new rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   CreateRolloutRequest request =
       CreateRolloutRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRolloutId("rolloutId551248556")
           .setRollout(Rollout.newBuilder().build())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .build();
   Rollout response = saasRolloutsClient.createRollout(request);
 }

Parameter
Name	Description
`request`	`CreateRolloutRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Rollout`

createRollout(LocationName parent, Rollout rollout, String rolloutId)

public final Rollout createRollout(LocationName parent, Rollout rollout, String rolloutId)

Create a new rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Rollout rollout = Rollout.newBuilder().build();
   String rolloutId = "rolloutId551248556";
   Rollout response = saasRolloutsClient.createRollout(parent, rollout, rolloutId);
 }

Parameters
Name	Description
`parent`	`LocationName` Required. The parent of the rollout.
`rollout`	`Rollout` Required. The desired state for the rollout.
`rolloutId`	`String` Required. The ID value for the new rollout.

Returns
Type	Description
`Rollout`

createRollout(String parent, Rollout rollout, String rolloutId)

public final Rollout createRollout(String parent, Rollout rollout, String rolloutId)

Create a new rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Rollout rollout = Rollout.newBuilder().build();
   String rolloutId = "rolloutId551248556";
   Rollout response = saasRolloutsClient.createRollout(parent, rollout, rolloutId);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent of the rollout.
`rollout`	`Rollout` Required. The desired state for the rollout.
`rolloutId`	`String` Required. The ID value for the new rollout.

Returns
Type	Description
`Rollout`

createRolloutCallable()

public final UnaryCallable<CreateRolloutRequest,Rollout> createRolloutCallable()

Create a new rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   CreateRolloutRequest request =
       CreateRolloutRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRolloutId("rolloutId551248556")
           .setRollout(Rollout.newBuilder().build())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Rollout> future = saasRolloutsClient.createRolloutCallable().futureCall(request);
   // Do something.
   Rollout response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateRolloutRequest,Rollout>`

createRolloutKind(CreateRolloutKindRequest request)

public final RolloutKind createRolloutKind(CreateRolloutKindRequest request)

Create a new rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   CreateRolloutKindRequest request =
       CreateRolloutKindRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRolloutKindId("rolloutKindId-1380592416")
           .setRolloutKind(RolloutKind.newBuilder().build())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .build();
   RolloutKind response = saasRolloutsClient.createRolloutKind(request);
 }

Parameter
Name	Description
`request`	`CreateRolloutKindRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RolloutKind`

createRolloutKind(LocationName parent, RolloutKind rolloutKind, String rolloutKindId)

public final RolloutKind createRolloutKind(LocationName parent, RolloutKind rolloutKind, String rolloutKindId)

Create a new rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RolloutKind rolloutKind = RolloutKind.newBuilder().build();
   String rolloutKindId = "rolloutKindId-1380592416";
   RolloutKind response =
       saasRolloutsClient.createRolloutKind(parent, rolloutKind, rolloutKindId);
 }

Parameters
Name	Description
`parent`	`LocationName` Required. The parent of the rollout kind.
`rolloutKind`	`RolloutKind` Required. The desired state for the rollout kind.
`rolloutKindId`	`String` Required. The ID value for the new rollout kind.

Returns
Type	Description
`RolloutKind`

createRolloutKind(String parent, RolloutKind rolloutKind, String rolloutKindId)

public final RolloutKind createRolloutKind(String parent, RolloutKind rolloutKind, String rolloutKindId)

Create a new rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   RolloutKind rolloutKind = RolloutKind.newBuilder().build();
   String rolloutKindId = "rolloutKindId-1380592416";
   RolloutKind response =
       saasRolloutsClient.createRolloutKind(parent, rolloutKind, rolloutKindId);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent of the rollout kind.
`rolloutKind`	`RolloutKind` Required. The desired state for the rollout kind.
`rolloutKindId`	`String` Required. The ID value for the new rollout kind.

Returns
Type	Description
`RolloutKind`

createRolloutKindCallable()

public final UnaryCallable<CreateRolloutKindRequest,RolloutKind> createRolloutKindCallable()

Create a new rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   CreateRolloutKindRequest request =
       CreateRolloutKindRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRolloutKindId("rolloutKindId-1380592416")
           .setRolloutKind(RolloutKind.newBuilder().build())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<RolloutKind> future =
       saasRolloutsClient.createRolloutKindCallable().futureCall(request);
   // Do something.
   RolloutKind response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateRolloutKindRequest,RolloutKind>`

deleteRollout(DeleteRolloutRequest request)

public final void deleteRollout(DeleteRolloutRequest request)

Delete a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   DeleteRolloutRequest request =
       DeleteRolloutRequest.newBuilder()
           .setName(RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]").toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .build();
   saasRolloutsClient.deleteRollout(request);
 }

Parameter
Name	Description
`request`	`DeleteRolloutRequest` The request object containing all of the parameters for the API call.

deleteRollout(RolloutName name)

public final void deleteRollout(RolloutName name)

Delete a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   RolloutName name = RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]");
   saasRolloutsClient.deleteRollout(name);
 }

Parameter
Name	Description
`name`	`RolloutName` Required. The resource name of the resource within a service.

deleteRollout(String name)

public final void deleteRollout(String name)

Delete a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   String name = RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]").toString();
   saasRolloutsClient.deleteRollout(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the resource within a service.

deleteRolloutCallable()

public final UnaryCallable<DeleteRolloutRequest,Empty> deleteRolloutCallable()

Delete a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   DeleteRolloutRequest request =
       DeleteRolloutRequest.newBuilder()
           .setName(RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]").toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Empty> future = saasRolloutsClient.deleteRolloutCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteRolloutRequest,Empty>`

deleteRolloutKind(DeleteRolloutKindRequest request)

public final void deleteRolloutKind(DeleteRolloutKindRequest request)

Delete a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   DeleteRolloutKindRequest request =
       DeleteRolloutKindRequest.newBuilder()
           .setName(
               RolloutKindName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_KIND_ID]").toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .build();
   saasRolloutsClient.deleteRolloutKind(request);
 }

Parameter
Name	Description
`request`	`DeleteRolloutKindRequest` The request object containing all of the parameters for the API call.

deleteRolloutKind(RolloutKindName name)

public final void deleteRolloutKind(RolloutKindName name)

Delete a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   RolloutKindName name = RolloutKindName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_KIND_ID]");
   saasRolloutsClient.deleteRolloutKind(name);
 }

Parameter
Name	Description
`name`	`RolloutKindName` Required. The resource name of the resource within a service.

deleteRolloutKind(String name)

public final void deleteRolloutKind(String name)

Delete a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   String name = RolloutKindName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_KIND_ID]").toString();
   saasRolloutsClient.deleteRolloutKind(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the resource within a service.

deleteRolloutKindCallable()

public final UnaryCallable<DeleteRolloutKindRequest,Empty> deleteRolloutKindCallable()

Delete a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   DeleteRolloutKindRequest request =
       DeleteRolloutKindRequest.newBuilder()
           .setName(
               RolloutKindName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_KIND_ID]").toString())
           .setEtag("etag3123477")
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Empty> future = saasRolloutsClient.deleteRolloutKindCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteRolloutKindRequest,Empty>`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a ___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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = saasRolloutsClient.getLocation(request);
 }

Parameter
Name	Description
`request`	`com.google.cloud.___location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.___location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a ___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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = saasRolloutsClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.___location.GetLocationRequest,com.google.cloud.___location.Location>`

getRollout(GetRolloutRequest request)

public final Rollout getRollout(GetRolloutRequest request)

Retrieve a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   GetRolloutRequest request =
       GetRolloutRequest.newBuilder()
           .setName(RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]").toString())
           .build();
   Rollout response = saasRolloutsClient.getRollout(request);
 }

Parameter
Name	Description
`request`	`GetRolloutRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Rollout`

getRollout(RolloutName name)

public final Rollout getRollout(RolloutName name)

Retrieve a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   RolloutName name = RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]");
   Rollout response = saasRolloutsClient.getRollout(name);
 }

Parameter
Name	Description
`name`	`RolloutName` Required. The resource name of the resource within a service.

Returns
Type	Description
`Rollout`

getRollout(String name)

public final Rollout getRollout(String name)

Retrieve a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   String name = RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]").toString();
   Rollout response = saasRolloutsClient.getRollout(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the resource within a service.

Returns
Type	Description
`Rollout`

getRolloutCallable()

public final UnaryCallable<GetRolloutRequest,Rollout> getRolloutCallable()

Retrieve a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   GetRolloutRequest request =
       GetRolloutRequest.newBuilder()
           .setName(RolloutName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_ID]").toString())
           .build();
   ApiFuture<Rollout> future = saasRolloutsClient.getRolloutCallable().futureCall(request);
   // Do something.
   Rollout response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRolloutRequest,Rollout>`

getRolloutKind(GetRolloutKindRequest request)

public final RolloutKind getRolloutKind(GetRolloutKindRequest request)

Retrieve a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   GetRolloutKindRequest request =
       GetRolloutKindRequest.newBuilder()
           .setName(
               RolloutKindName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_KIND_ID]").toString())
           .build();
   RolloutKind response = saasRolloutsClient.getRolloutKind(request);
 }

Parameter
Name	Description
`request`	`GetRolloutKindRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RolloutKind`

getRolloutKind(RolloutKindName name)

public final RolloutKind getRolloutKind(RolloutKindName name)

Retrieve a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   RolloutKindName name = RolloutKindName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_KIND_ID]");
   RolloutKind response = saasRolloutsClient.getRolloutKind(name);
 }

Parameter
Name	Description
`name`	`RolloutKindName` Required. The resource name of the resource within a service.

Returns
Type	Description
`RolloutKind`

getRolloutKind(String name)

public final RolloutKind getRolloutKind(String name)

Retrieve a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   String name = RolloutKindName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_KIND_ID]").toString();
   RolloutKind response = saasRolloutsClient.getRolloutKind(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the resource within a service.

Returns
Type	Description
`RolloutKind`

getRolloutKindCallable()

public final UnaryCallable<GetRolloutKindRequest,RolloutKind> getRolloutKindCallable()

Retrieve a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   GetRolloutKindRequest request =
       GetRolloutKindRequest.newBuilder()
           .setName(
               RolloutKindName.of("[PROJECT]", "[LOCATION]", "[ROLLOUT_KIND_ID]").toString())
           .build();
   ApiFuture<RolloutKind> future =
       saasRolloutsClient.getRolloutKindCallable().futureCall(request);
   // Do something.
   RolloutKind response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRolloutKindRequest,RolloutKind>`

getSettings()

public final SaasRolloutsSettings getSettings()

Returns
Type	Description
`SaasRolloutsSettings`

getStub()

public SaasRolloutsStub getStub()

Returns
Type	Description
`SaasRolloutsStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listLocations(ListLocationsRequest request)

public final SaasRolloutsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : saasRolloutsClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.___location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`SaasRolloutsClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = saasRolloutsClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.___location.ListLocationsRequest,com.google.cloud.___location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,SaasRolloutsClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       saasRolloutsClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.___location.ListLocationsRequest,ListLocationsPagedResponse>`

listRolloutKinds(ListRolloutKindsRequest request)

public final SaasRolloutsClient.ListRolloutKindsPagedResponse listRolloutKinds(ListRolloutKindsRequest request)

Retrieve a collection of rollout kinds.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListRolloutKindsRequest request =
       ListRolloutKindsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (RolloutKind element : saasRolloutsClient.listRolloutKinds(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRolloutKindsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`SaasRolloutsClient.ListRolloutKindsPagedResponse`

listRolloutKinds(LocationName parent)

public final SaasRolloutsClient.ListRolloutKindsPagedResponse listRolloutKinds(LocationName parent)

Retrieve a collection of rollout kinds.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (RolloutKind element : saasRolloutsClient.listRolloutKinds(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`LocationName` Required. The parent of the rollout kind.

Returns
Type	Description
`SaasRolloutsClient.ListRolloutKindsPagedResponse`

listRolloutKinds(String parent)

public final SaasRolloutsClient.ListRolloutKindsPagedResponse listRolloutKinds(String parent)

Retrieve a collection of rollout kinds.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (RolloutKind element : saasRolloutsClient.listRolloutKinds(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent of the rollout kind.

Returns
Type	Description
`SaasRolloutsClient.ListRolloutKindsPagedResponse`

listRolloutKindsCallable()

public final UnaryCallable<ListRolloutKindsRequest,ListRolloutKindsResponse> listRolloutKindsCallable()

Retrieve a collection of rollout kinds.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListRolloutKindsRequest request =
       ListRolloutKindsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListRolloutKindsResponse response =
         saasRolloutsClient.listRolloutKindsCallable().call(request);
     for (RolloutKind element : response.getRolloutKindsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRolloutKindsRequest,ListRolloutKindsResponse>`

listRolloutKindsPagedCallable()

public final UnaryCallable<ListRolloutKindsRequest,SaasRolloutsClient.ListRolloutKindsPagedResponse> listRolloutKindsPagedCallable()

Retrieve a collection of rollout kinds.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListRolloutKindsRequest request =
       ListRolloutKindsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<RolloutKind> future =
       saasRolloutsClient.listRolloutKindsPagedCallable().futureCall(request);
   // Do something.
   for (RolloutKind element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRolloutKindsRequest,ListRolloutKindsPagedResponse>`

listRollouts(ListRolloutsRequest request)

public final SaasRolloutsClient.ListRolloutsPagedResponse listRollouts(ListRolloutsRequest request)

Retrieve a collection of rollouts.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListRolloutsRequest request =
       ListRolloutsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Rollout element : saasRolloutsClient.listRollouts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRolloutsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`SaasRolloutsClient.ListRolloutsPagedResponse`

listRollouts(LocationName parent)

public final SaasRolloutsClient.ListRolloutsPagedResponse listRollouts(LocationName parent)

Retrieve a collection of rollouts.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Rollout element : saasRolloutsClient.listRollouts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`LocationName` Required. The parent of the rollout.

Returns
Type	Description
`SaasRolloutsClient.ListRolloutsPagedResponse`

listRollouts(String parent)

public final SaasRolloutsClient.ListRolloutsPagedResponse listRollouts(String parent)

Retrieve a collection of rollouts.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Rollout element : saasRolloutsClient.listRollouts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent of the rollout.

Returns
Type	Description
`SaasRolloutsClient.ListRolloutsPagedResponse`

listRolloutsCallable()

public final UnaryCallable<ListRolloutsRequest,ListRolloutsResponse> listRolloutsCallable()

Retrieve a collection of rollouts.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListRolloutsRequest request =
       ListRolloutsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListRolloutsResponse response = saasRolloutsClient.listRolloutsCallable().call(request);
     for (Rollout element : response.getRolloutsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRolloutsRequest,ListRolloutsResponse>`

listRolloutsPagedCallable()

public final UnaryCallable<ListRolloutsRequest,SaasRolloutsClient.ListRolloutsPagedResponse> listRolloutsPagedCallable()

Retrieve a collection of rollouts.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   ListRolloutsRequest request =
       ListRolloutsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Rollout> future =
       saasRolloutsClient.listRolloutsPagedCallable().futureCall(request);
   // Do something.
   for (Rollout element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRolloutsRequest,ListRolloutsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateRollout(Rollout rollout, FieldMask updateMask)

public final Rollout updateRollout(Rollout rollout, FieldMask updateMask)

Update a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   Rollout rollout = Rollout.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Rollout response = saasRolloutsClient.updateRollout(rollout, updateMask);
 }

Parameters

Name Description

rollout

Rollout

Required. The desired state for the rollout.

updateMask

FieldMask

Field mask is used to specify the fields to be overwritten in the Rollout resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

If the user does not provide a mask then all fields in the Rollout will be overwritten.

Returns
Type	Description
`Rollout`

updateRollout(UpdateRolloutRequest request)

public final Rollout updateRollout(UpdateRolloutRequest request)

Update a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   UpdateRolloutRequest request =
       UpdateRolloutRequest.newBuilder()
           .setRollout(Rollout.newBuilder().build())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Rollout response = saasRolloutsClient.updateRollout(request);
 }

Parameter
Name	Description
`request`	`UpdateRolloutRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Rollout`

updateRolloutCallable()

public final UnaryCallable<UpdateRolloutRequest,Rollout> updateRolloutCallable()

Update a single rollout.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   UpdateRolloutRequest request =
       UpdateRolloutRequest.newBuilder()
           .setRollout(Rollout.newBuilder().build())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Rollout> future = saasRolloutsClient.updateRolloutCallable().futureCall(request);
   // Do something.
   Rollout response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateRolloutRequest,Rollout>`

updateRolloutKind(RolloutKind rolloutKind, FieldMask updateMask)

public final RolloutKind updateRolloutKind(RolloutKind rolloutKind, FieldMask updateMask)

Update a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   RolloutKind rolloutKind = RolloutKind.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   RolloutKind response = saasRolloutsClient.updateRolloutKind(rolloutKind, updateMask);
 }

Parameters

Name Description

rolloutKind

RolloutKind

Required. The desired state for the rollout kind.

updateMask

FieldMask

Field mask is used to specify the fields to be overwritten in the RolloutKind resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

If the user does not provide a mask then all fields in the RolloutKind will be overwritten.

Returns
Type	Description
`RolloutKind`

updateRolloutKind(UpdateRolloutKindRequest request)

public final RolloutKind updateRolloutKind(UpdateRolloutKindRequest request)

Update a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   UpdateRolloutKindRequest request =
       UpdateRolloutKindRequest.newBuilder()
           .setRolloutKind(RolloutKind.newBuilder().build())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   RolloutKind response = saasRolloutsClient.updateRolloutKind(request);
 }

Parameter
Name	Description
`request`	`UpdateRolloutKindRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RolloutKind`

updateRolloutKindCallable()

public final UnaryCallable<UpdateRolloutKindRequest,RolloutKind> updateRolloutKindCallable()

Update a single rollout kind.

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 (SaasRolloutsClient saasRolloutsClient = SaasRolloutsClient.create()) {
   UpdateRolloutKindRequest request =
       UpdateRolloutKindRequest.newBuilder()
           .setRolloutKind(RolloutKind.newBuilder().build())
           .setValidateOnly(true)
           .setRequestId("requestId693933066")
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<RolloutKind> future =
       saasRolloutsClient.updateRolloutKindCallable().futureCall(request);
   // Do something.
   RolloutKind response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateRolloutKindRequest,RolloutKind>`

Class SaasRolloutsClient (0.2.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(SaasRolloutsSettings settings)

create(SaasRolloutsStub stub)

Constructors

SaasRolloutsClient(SaasRolloutsSettings settings)

SaasRolloutsClient(SaasRolloutsStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createRollout(CreateRolloutRequest request)

createRollout(LocationName parent, Rollout rollout, String rolloutId)

createRollout(String parent, Rollout rollout, String rolloutId)

createRolloutCallable()

createRolloutKind(CreateRolloutKindRequest request)

createRolloutKind(LocationName parent, RolloutKind rolloutKind, String rolloutKindId)

createRolloutKind(String parent, RolloutKind rolloutKind, String rolloutKindId)

createRolloutKindCallable()

deleteRollout(DeleteRolloutRequest request)

deleteRollout(RolloutName name)

deleteRollout(String name)

deleteRolloutCallable()

deleteRolloutKind(DeleteRolloutKindRequest request)

deleteRolloutKind(RolloutKindName name)

deleteRolloutKind(String name)

deleteRolloutKindCallable()

getLocation(GetLocationRequest request)

getLocationCallable()

getRollout(GetRolloutRequest request)

getRollout(RolloutName name)

getRollout(String name)

getRolloutCallable()

getRolloutKind(GetRolloutKindRequest request)

getRolloutKind(RolloutKindName name)

getRolloutKind(String name)

getRolloutKindCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listLocations(ListLocationsRequest request)

listLocationsCallable()

listLocationsPagedCallable()

listRolloutKinds(ListRolloutKindsRequest request)

listRolloutKinds(LocationName parent)

listRolloutKinds(String parent)

listRolloutKindsCallable()

listRolloutKindsPagedCallable()

listRollouts(ListRolloutsRequest request)

listRollouts(LocationName parent)

listRollouts(String parent)

listRolloutsCallable()

listRolloutsPagedCallable()

shutdown()

shutdownNow()

updateRollout(Rollout rollout, FieldMask updateMask)

updateRollout(UpdateRolloutRequest request)

updateRolloutCallable()

updateRolloutKind(RolloutKind rolloutKind, FieldMask updateMask)

updateRolloutKind(UpdateRolloutKindRequest request)

updateRolloutKindCallable()

Class SaasRolloutsClient (0.2.0)