AssetServiceClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.asset.v1.AssetServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class AssetServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Asset service definition.
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:
```
 
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ContentType contentType = ContentType.CONTENT_TYPE_UNSPECIFIED;
   TimeWindow readTimeWindow = TimeWindow.newBuilder().build();
   BatchGetAssetsHistoryRequest request = BatchGetAssetsHistoryRequest.newBuilder()
     .setParent(parent.toString())
     .setContentType(contentType)
     .setReadTimeWindow(readTimeWindow)
     .build();
   BatchGetAssetsHistoryResponse response = assetServiceClient.batchGetAssetsHistory(request);
 }
 
 
```
Note: close() needs to be called on the assetServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
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 AssetServiceSettings to create(). For example:
To customize credentials:
```
 
 AssetServiceSettings assetServiceSettings =
     AssetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AssetServiceClient assetServiceClient =
     AssetServiceClient.create(assetServiceSettings);
 
 
```
To customize the endpoint:
```
 
 AssetServiceSettings assetServiceSettings =
     AssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AssetServiceClient assetServiceClient =
     AssetServiceClient.create(assetServiceSettings);
 
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AssetServiceClient(AssetServiceSettings settings)` Constructs an instance of AssetServiceClient, using the given settings.
`protected`	`AssetServiceClient(AssetServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`BatchGetAssetsHistoryResponse`	`batchGetAssetsHistory(BatchGetAssetsHistoryRequest request)` Batch gets the update history of assets that overlap a time window.
`com.google.api.gax.rpc.UnaryCallable<BatchGetAssetsHistoryRequest,BatchGetAssetsHistoryResponse>`	`batchGetAssetsHistoryCallable()` Batch gets the update history of assets that overlap a time window.
`void`	`close()`
`static AssetServiceClient`	`create()` Constructs an instance of AssetServiceClient with default settings.
`static AssetServiceClient`	`create(AssetServiceSettings settings)` Constructs an instance of AssetServiceClient, using the given settings.
`static AssetServiceClient`	`create(AssetServiceStub stub)` Constructs an instance of AssetServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<ExportAssetsResponse,ExportAssetsRequest>`	`exportAssetsAsync(ExportAssetsRequest request)` Exports assets with time and resource types to a given Cloud Storage location.
`com.google.api.gax.rpc.UnaryCallable<ExportAssetsRequest,com.google.longrunning.Operation>`	`exportAssetsCallable()` Exports assets with time and resource types to a given Cloud Storage location.
`com.google.api.gax.rpc.OperationCallable<ExportAssetsRequest,ExportAssetsResponse,ExportAssetsRequest>`	`exportAssetsOperationCallable()` Exports assets with time and resource types to a given Cloud Storage location.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`AssetServiceSettings`	`getSettings()`
`AssetServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- AssetServiceClient
```
protected AssetServiceClient(AssetServiceSettings settings)
                      throws IOException
```
  Constructs an instance of AssetServiceClient, 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
- AssetServiceClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected AssetServiceClient(AssetServiceStub stub)
```

Method Detail

create

public static final AssetServiceClient create()
                                       throws IOException

Constructs an instance of AssetServiceClient with default settings.

Throws:: IOException

create
```
public static final AssetServiceClient create(AssetServiceSettings settings)
                                       throws IOException
```
Constructs an instance of AssetServiceClient, 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final AssetServiceClient create(AssetServiceStub stub)

Constructs an instance of AssetServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use AssetServiceSettings}.

getSettings

public final AssetServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public AssetServiceStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

exportAssetsAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<ExportAssetsResponse,ExportAssetsRequest> exportAssetsAsync(ExportAssetsRequest request)

Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export.

Sample code:


 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportAssetsRequest request = ExportAssetsRequest.newBuilder()
     .setParent(parent.toString())
     .setOutputConfig(outputConfig)
     .build();
   ExportAssetsResponse response = assetServiceClient.exportAssetsAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

exportAssetsOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<ExportAssetsRequest,ExportAssetsResponse,ExportAssetsRequest> exportAssetsOperationCallable()

Sample code:


 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportAssetsRequest request = ExportAssetsRequest.newBuilder()
     .setParent(parent.toString())
     .setOutputConfig(outputConfig)
     .build();
   OperationFuture<ExportAssetsResponse, ExportAssetsRequest> future = assetServiceClient.exportAssetsOperationCallable().futureCall(request);
   // Do something
   ExportAssetsResponse response = future.get();
 }

exportAssetsCallable

public final com.google.api.gax.rpc.UnaryCallable<ExportAssetsRequest,com.google.longrunning.Operation> exportAssetsCallable()

Sample code:


 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportAssetsRequest request = ExportAssetsRequest.newBuilder()
     .setParent(parent.toString())
     .setOutputConfig(outputConfig)
     .build();
   ApiFuture<Operation> future = assetServiceClient.exportAssetsCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

batchGetAssetsHistory

public final BatchGetAssetsHistoryResponse batchGetAssetsHistory(BatchGetAssetsHistoryRequest request)

Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

Sample code:


 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ContentType contentType = ContentType.CONTENT_TYPE_UNSPECIFIED;
   TimeWindow readTimeWindow = TimeWindow.newBuilder().build();
   BatchGetAssetsHistoryRequest request = BatchGetAssetsHistoryRequest.newBuilder()
     .setParent(parent.toString())
     .setContentType(contentType)
     .setReadTimeWindow(readTimeWindow)
     .build();
   BatchGetAssetsHistoryResponse response = assetServiceClient.batchGetAssetsHistory(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

batchGetAssetsHistoryCallable

public final com.google.api.gax.rpc.UnaryCallable<BatchGetAssetsHistoryRequest,BatchGetAssetsHistoryResponse> batchGetAssetsHistoryCallable()

Sample code:


 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ContentType contentType = ContentType.CONTENT_TYPE_UNSPECIFIED;
   TimeWindow readTimeWindow = TimeWindow.newBuilder().build();
   BatchGetAssetsHistoryRequest request = BatchGetAssetsHistoryRequest.newBuilder()
     .setParent(parent.toString())
     .setContentType(contentType)
     .setReadTimeWindow(readTimeWindow)
     .build();
   ApiFuture<BatchGetAssetsHistoryResponse> future = assetServiceClient.batchGetAssetsHistoryCallable().futureCall(request);
   // Do something
   BatchGetAssetsHistoryResponse response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class AssetServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssetServiceClient

AssetServiceClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

exportAssetsAsync

exportAssetsOperationCallable

exportAssetsCallable

batchGetAssetsHistory

batchGetAssetsHistoryCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination