Class AssetServiceClient (3.48.0)

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:


 // 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 (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ExportAssetsRequest request =
       ExportAssetsRequest.newBuilder()
           .setParent("ExportAssetsRequest-846449128".toString())
           .setReadTime(Timestamp.newBuilder().build())
           .addAllAssetTypes(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setOutputConfig(OutputConfig.newBuilder().build())
           .addAllRelationshipTypes(new ArrayList<String>())
           .build();
   ExportAssetsResponse response = assetServiceClient.exportAssetsAsync(request).get();
 }

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

Methods
Method	Description	Method Variants
ExportAssets	Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a google.cloud.asset.v1p7beta1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset proto as columns. This API implements the google.longrunning.Operation API , which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.	Request object method variants only take one parameter, a request object, which must be constructed before the call. exportAssetsAsync(ExportAssetsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. exportAssetsOperationCallable() exportAssetsCallable()

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:


 // 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
 AssetServiceSettings assetServiceSettings =
     AssetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);

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
 AssetServiceSettings assetServiceSettings =
     AssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);

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

Inheritance

java.lang.Object > AssetServiceClient

Static Methods

create()

public static final AssetServiceClient create()

Constructs an instance of AssetServiceClient with default settings.

Returns
Type	Description
`AssetServiceClient`

Exceptions
Type	Description
`IOException`

create(AssetServiceSettings settings)

public static final AssetServiceClient create(AssetServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`AssetServiceSettings`

Returns
Type	Description
`AssetServiceClient`

Exceptions
Type	Description
`IOException`

create(AssetServiceStub stub)

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 using create(AssetServiceSettings).

Parameter
Name	Description
`stub`	`AssetServiceStub`

Returns
Type	Description
`AssetServiceClient`

Constructors

AssetServiceClient(AssetServiceSettings settings)

protected AssetServiceClient(AssetServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`AssetServiceSettings`

AssetServiceClient(AssetServiceStub stub)

protected AssetServiceClient(AssetServiceStub stub)

Parameter
Name	Description
`stub`	`AssetServiceStub`

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

exportAssetsAsync(ExportAssetsRequest request)

public final OperationFuture<ExportAssetsResponse,ExportAssetsRequest> exportAssetsAsync(ExportAssetsRequest request)

Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a google.cloud.asset.v1p7beta1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset proto as columns. This API implements the google.longrunning.Operation API , which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

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 (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ExportAssetsRequest request =
       ExportAssetsRequest.newBuilder()
           .setParent("ExportAssetsRequest-846449128".toString())
           .setReadTime(Timestamp.newBuilder().build())
           .addAllAssetTypes(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setOutputConfig(OutputConfig.newBuilder().build())
           .addAllRelationshipTypes(new ArrayList<String>())
           .build();
   ExportAssetsResponse response = assetServiceClient.exportAssetsAsync(request).get();
 }

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

Returns
Type	Description
`OperationFuture<ExportAssetsResponse,ExportAssetsRequest>`

exportAssetsCallable()

public final UnaryCallable<ExportAssetsRequest,Operation> exportAssetsCallable()

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 (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ExportAssetsRequest request =
       ExportAssetsRequest.newBuilder()
           .setParent("ExportAssetsRequest-846449128".toString())
           .setReadTime(Timestamp.newBuilder().build())
           .addAllAssetTypes(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setOutputConfig(OutputConfig.newBuilder().build())
           .addAllRelationshipTypes(new ArrayList<String>())
           .build();
   ApiFuture<Operation> future = assetServiceClient.exportAssetsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ExportAssetsRequest,Operation>`

exportAssetsOperationCallable()

public final OperationCallable<ExportAssetsRequest,ExportAssetsResponse,ExportAssetsRequest> exportAssetsOperationCallable()

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 (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ExportAssetsRequest request =
       ExportAssetsRequest.newBuilder()
           .setParent("ExportAssetsRequest-846449128".toString())
           .setReadTime(Timestamp.newBuilder().build())
           .addAllAssetTypes(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setOutputConfig(OutputConfig.newBuilder().build())
           .addAllRelationshipTypes(new ArrayList<String>())
           .build();
   OperationFuture<ExportAssetsResponse, ExportAssetsRequest> future =
       assetServiceClient.exportAssetsOperationCallable().futureCall(request);
   // Do something.
   ExportAssetsResponse response = future.get();
 }

Returns
Type	Description
`OperationCallable<ExportAssetsRequest,ExportAssetsResponse,ExportAssetsRequest>`

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type	Description
`OperationsClient`

getSettings()

public final AssetServiceSettings getSettings()

Returns
Type	Description
`AssetServiceSettings`

getStub()

public AssetServiceStub getStub()

Returns
Type	Description
`AssetServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()