Class PreviewFeaturesClient (1.88.0)

GitHub RepositoryProduct Reference

Service Description: The PreviewFeatures 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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   String project = "project-309310695";
   String previewFeature = "previewFeature-712516082";
   PreviewFeature response = previewFeaturesClient.get(project, previewFeature);
 }

Note: close() needs to be called on the PreviewFeaturesClient 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

Get

Returns the details of the given PreviewFeature.

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

  • get(GetPreviewFeatureRequest 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 previewFeature)

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

  • getCallable()

List

Returns the details of the given PreviewFeature.

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

  • list(ListPreviewFeaturesRequest 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()

Update

Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.

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

  • updateAsync(UpdatePreviewFeatureRequest request)

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

  • updateAsync(String project, String previewFeature, PreviewFeature previewFeatureResource)

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

  • updateOperationCallable()

  • updateCallable()

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 PreviewFeaturesSettings 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
 PreviewFeaturesSettings previewFeaturesSettings =
     PreviewFeaturesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PreviewFeaturesClient previewFeaturesClient =
     PreviewFeaturesClient.create(previewFeaturesSettings);

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
 PreviewFeaturesSettings previewFeaturesSettings =
     PreviewFeaturesSettings.newBuilder().setEndpoint(myEndpoint).build();
 PreviewFeaturesClient previewFeaturesClient =
     PreviewFeaturesClient.create(previewFeaturesSettings);

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

Inheritance

java.lang.Object > PreviewFeaturesClient

Static Methods

create()

public static final PreviewFeaturesClient create()

Constructs an instance of PreviewFeaturesClient with default settings.

Returns
Type Description
PreviewFeaturesClient
Exceptions
Type Description
IOException

create(PreviewFeaturesSettings settings)

public static final PreviewFeaturesClient create(PreviewFeaturesSettings settings)

Constructs an instance of PreviewFeaturesClient, 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 PreviewFeaturesSettings
Returns
Type Description
PreviewFeaturesClient
Exceptions
Type Description
IOException

create(PreviewFeaturesStub stub)

public static final PreviewFeaturesClient create(PreviewFeaturesStub stub)

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

Parameter
Name Description
stub PreviewFeaturesStub
Returns
Type Description
PreviewFeaturesClient

Constructors

PreviewFeaturesClient(PreviewFeaturesSettings settings)

protected PreviewFeaturesClient(PreviewFeaturesSettings settings)

Constructs an instance of PreviewFeaturesClient, 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 PreviewFeaturesSettings

PreviewFeaturesClient(PreviewFeaturesStub stub)

protected PreviewFeaturesClient(PreviewFeaturesStub stub)
Parameter
Name Description
stub PreviewFeaturesStub

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

get(GetPreviewFeatureRequest request)

public final PreviewFeature get(GetPreviewFeatureRequest request)

Returns the details of the given PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   GetPreviewFeatureRequest request =
       GetPreviewFeatureRequest.newBuilder()
           .setPreviewFeature("previewFeature-712516082")
           .setProject("project-309310695")
           .build();
   PreviewFeature response = previewFeaturesClient.get(request);
 }
Parameter
Name Description
request GetPreviewFeatureRequest

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

get(String project, String previewFeature)

public final PreviewFeature get(String project, String previewFeature)

Returns the details of the given PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   String project = "project-309310695";
   String previewFeature = "previewFeature-712516082";
   PreviewFeature response = previewFeaturesClient.get(project, previewFeature);
 }
Parameters
Name Description
project String

Project ID for this request.
previewFeature String

Name of the PreviewFeature for this request.
Returns
Type Description
PreviewFeature

getCallable()

public final UnaryCallable<GetPreviewFeatureRequest,PreviewFeature> getCallable()

Returns the details of the given PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   GetPreviewFeatureRequest request =
       GetPreviewFeatureRequest.newBuilder()
           .setPreviewFeature("previewFeature-712516082")
           .setProject("project-309310695")
           .build();
   ApiFuture<PreviewFeature> future = previewFeaturesClient.getCallable().futureCall(request);
   // Do something.
   PreviewFeature response = future.get();
 }
Returns
Type Description
UnaryCallable<GetPreviewFeatureRequest,PreviewFeature>

getSettings()

public final PreviewFeaturesSettings getSettings()
Returns
Type Description
PreviewFeaturesSettings

getStub()

public PreviewFeaturesStub getStub()
Returns
Type Description
PreviewFeaturesStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListPreviewFeaturesRequest request)

public final PreviewFeaturesClient.ListPagedResponse list(ListPreviewFeaturesRequest request)

Returns the details of the given PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   ListPreviewFeaturesRequest request =
       ListPreviewFeaturesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (PreviewFeature element : previewFeaturesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListPreviewFeaturesRequest

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

list(String project)

public final PreviewFeaturesClient.ListPagedResponse list(String project)

Returns the details of the given PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   String project = "project-309310695";
   for (PreviewFeature element : previewFeaturesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

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

listCallable()

public final UnaryCallable<ListPreviewFeaturesRequest,PreviewFeatureList> listCallable()

Returns the details of the given PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   ListPreviewFeaturesRequest request =
       ListPreviewFeaturesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     PreviewFeatureList response = previewFeaturesClient.listCallable().call(request);
     for (PreviewFeature 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<ListPreviewFeaturesRequest,PreviewFeatureList>

listPagedCallable()

public final UnaryCallable<ListPreviewFeaturesRequest,PreviewFeaturesClient.ListPagedResponse> listPagedCallable()

Returns the details of the given PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   ListPreviewFeaturesRequest request =
       ListPreviewFeaturesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<PreviewFeature> future =
       previewFeaturesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (PreviewFeature element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListPreviewFeaturesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdatePreviewFeatureRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdatePreviewFeatureRequest request)

Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   UpdatePreviewFeatureRequest request =
       UpdatePreviewFeatureRequest.newBuilder()
           .setPreviewFeature("previewFeature-712516082")
           .setPreviewFeatureResource(PreviewFeature.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = previewFeaturesClient.updateAsync(request).get();
 }
Parameter
Name Description
request UpdatePreviewFeatureRequest

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

updateAsync(String project, String previewFeature, PreviewFeature previewFeatureResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String previewFeature, PreviewFeature previewFeatureResource)

Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   String project = "project-309310695";
   String previewFeature = "previewFeature-712516082";
   PreviewFeature previewFeatureResource = PreviewFeature.newBuilder().build();
   Operation response =
       previewFeaturesClient.updateAsync(project, previewFeature, previewFeatureResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
previewFeature String

Name of the PreviewFeature for this request.
previewFeatureResource PreviewFeature

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

updateCallable()

public final UnaryCallable<UpdatePreviewFeatureRequest,Operation> updateCallable()

Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   UpdatePreviewFeatureRequest request =
       UpdatePreviewFeatureRequest.newBuilder()
           .setPreviewFeature("previewFeature-712516082")
           .setPreviewFeatureResource(PreviewFeature.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = previewFeaturesClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdatePreviewFeatureRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdatePreviewFeatureRequest,Operation,Operation> updateOperationCallable()

Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.

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 (PreviewFeaturesClient previewFeaturesClient = PreviewFeaturesClient.create()) {
   UpdatePreviewFeatureRequest request =
       UpdatePreviewFeatureRequest.newBuilder()
           .setPreviewFeature("previewFeature-712516082")
           .setPreviewFeatureResource(PreviewFeature.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       previewFeaturesClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<UpdatePreviewFeatureRequest,Operation,Operation>