PreviewFeaturesClient (Google Compute Engine 1.88.0 API)

java.lang.Object
- com.google.cloud.compute.v1.PreviewFeaturesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class PreviewFeaturesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PreviewFeaturesClient.ListFixedSizeCollection`
`static class`	`PreviewFeaturesClient.ListPage`
`static class`	`PreviewFeaturesClient.ListPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PreviewFeaturesClient(PreviewFeaturesSettings settings)` Constructs an instance of PreviewFeaturesClient, using the given settings.
`protected`	`PreviewFeaturesClient(PreviewFeaturesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static PreviewFeaturesClient`	`create()` Constructs an instance of PreviewFeaturesClient with default settings.
`static PreviewFeaturesClient`	`create(PreviewFeaturesSettings settings)` Constructs an instance of PreviewFeaturesClient, using the given settings.
`static PreviewFeaturesClient`	`create(PreviewFeaturesStub stub)` Constructs an instance of PreviewFeaturesClient, using the given stub for making calls.
`PreviewFeature`	`get(GetPreviewFeatureRequest request)` Returns the details of the given PreviewFeature.
`PreviewFeature`	`get(String project, String previewFeature)` Returns the details of the given PreviewFeature.
`com.google.api.gax.rpc.UnaryCallable<GetPreviewFeatureRequest,PreviewFeature>`	`getCallable()` Returns the details of the given PreviewFeature.
`PreviewFeaturesSettings`	`getSettings()`
`PreviewFeaturesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`PreviewFeaturesClient.ListPagedResponse`	`list(ListPreviewFeaturesRequest request)` Returns the details of the given PreviewFeature.
`PreviewFeaturesClient.ListPagedResponse`	`list(String project)` Returns the details of the given PreviewFeature.
`com.google.api.gax.rpc.UnaryCallable<ListPreviewFeaturesRequest,PreviewFeatureList>`	`listCallable()` Returns the details of the given PreviewFeature.
`com.google.api.gax.rpc.UnaryCallable<ListPreviewFeaturesRequest,PreviewFeaturesClient.ListPagedResponse>`	`listPagedCallable()` Returns the details of the given PreviewFeature.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`updateAsync(String project, String previewFeature, PreviewFeature previewFeatureResource)` Patches the given PreviewFeature.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`updateAsync(UpdatePreviewFeatureRequest request)` Patches the given PreviewFeature.
`com.google.api.gax.rpc.UnaryCallable<UpdatePreviewFeatureRequest,Operation>`	`updateCallable()` Patches the given PreviewFeature.
`com.google.api.gax.rpc.OperationCallable<UpdatePreviewFeatureRequest,Operation,Operation>`	`updateOperationCallable()` Patches the given PreviewFeature.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PreviewFeaturesClient
```
protected PreviewFeaturesClient(PreviewFeaturesSettings settings)
                         throws IOException
```
  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.
  
  Throws:
  
  IOException
- PreviewFeaturesClient
```
protected PreviewFeaturesClient(PreviewFeaturesStub stub)
```

Method Detail

create

public static final PreviewFeaturesClient create()
                                          throws IOException

Constructs an instance of PreviewFeaturesClient with default settings.

Throws:: IOException

create
```
public static final PreviewFeaturesClient create(PreviewFeaturesSettings settings)
                                          throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final PreviewFeaturesSettings getSettings()

getStub
```
public PreviewFeaturesStub getStub()
```