@Generated(value="by gapic-generator") @BetaApi public class AssetServiceClient extends Object implements BackgroundResource
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:
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);
Modifier | Constructor and Description |
---|---|
protected |
AssetServiceClient(AssetServiceSettings settings)
Constructs an instance of AssetServiceClient, using the given settings.
|
protected |
AssetServiceClient(AssetServiceStub stub) |
Modifier and Type | Method and Description |
---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
com.google.cloud.asset.v1.BatchGetAssetsHistoryResponse |
batchGetAssetsHistory(com.google.cloud.asset.v1.BatchGetAssetsHistoryRequest request)
Batch gets the update history of assets that overlap a time window.
|
UnaryCallable<com.google.cloud.asset.v1.BatchGetAssetsHistoryRequest,com.google.cloud.asset.v1.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.
|
OperationFuture<com.google.cloud.asset.v1.ExportAssetsResponse,com.google.cloud.asset.v1.ExportAssetsRequest> |
exportAssetsAsync(com.google.cloud.asset.v1.ExportAssetsRequest request)
Exports assets with time and resource types to a given Cloud Storage location.
|
UnaryCallable<com.google.cloud.asset.v1.ExportAssetsRequest,Operation> |
exportAssetsCallable()
Exports assets with time and resource types to a given Cloud Storage location.
|
OperationCallable<com.google.cloud.asset.v1.ExportAssetsRequest,com.google.cloud.asset.v1.ExportAssetsResponse,com.google.cloud.asset.v1.ExportAssetsRequest> |
exportAssetsOperationCallable()
Exports assets with time and resource types to a given Cloud Storage location.
|
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() |
protected AssetServiceClient(AssetServiceSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") protected AssetServiceClient(AssetServiceStub stub)
public static final AssetServiceClient create() throws IOException
IOException
public static final AssetServiceClient create(AssetServiceSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public static final AssetServiceClient create(AssetServiceStub stub)
public final AssetServiceSettings getSettings()
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public AssetServiceStub getStub()
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.") public final OperationsClient getOperationsClient()
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.") public final OperationFuture<com.google.cloud.asset.v1.ExportAssetsResponse,com.google.cloud.asset.v1.ExportAssetsRequest> exportAssetsAsync(com.google.cloud.asset.v1.ExportAssetsRequest request)
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();
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call fails@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.") public final OperationCallable<com.google.cloud.asset.v1.ExportAssetsRequest,com.google.cloud.asset.v1.ExportAssetsResponse,com.google.cloud.asset.v1.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();
}
public final UnaryCallable<com.google.cloud.asset.v1.ExportAssetsRequest,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();
}
public final com.google.cloud.asset.v1.BatchGetAssetsHistoryResponse batchGetAssetsHistory(com.google.cloud.asset.v1.BatchGetAssetsHistoryRequest request)
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);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.cloud.asset.v1.BatchGetAssetsHistoryRequest,com.google.cloud.asset.v1.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();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2019 Google LLC. All rights reserved.