Package com.google.cloud.asset.v1p7beta1 (3.25.0)

A client to Cloud Asset API

The interfaces provided are listed below, along with usage samples.

AssetServiceClient

Service Description: Asset service definition.

Sample for AssetServiceClient:


 // 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(BillingAccountName.of("[BILLING_ACCOUNT]").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();
 }

Classes

Asset

An asset in Google Cloud. An asset can be any resource in the Google Cloud resource hierarchy, a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy). See Supported asset types for more information.

Protobuf type google.cloud.asset.v1p7beta1.Asset

Asset.Builder

Protobuf type google.cloud.asset.v1p7beta1.Asset

AssetProto

AssetServiceClient

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

The surface of this class includes several types of Java methods for each of the API's methods:

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.
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.
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:


 // 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.

AssetServiceGrpc

Asset service definition.

AssetServiceGrpc.AssetServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service AssetService.

Asset service definition.

AssetServiceGrpc.AssetServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service AssetService.

Asset service definition.

AssetServiceGrpc.AssetServiceImplBase

Base class for the server implementation of the service AssetService.

Asset service definition.

AssetServiceGrpc.AssetServiceStub

A stub to allow clients to do asynchronous rpc calls to service AssetService.

Asset service definition.

AssetServiceProto

AssetServiceSettings

Settings class to configure an instance of AssetServiceClient.

The default instance has everything set to sensible defaults:

The default service address (cloudasset.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of exportAssets to 30 seconds:


 // 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.Builder assetServiceSettingsBuilder = AssetServiceSettings.newBuilder();
 assetServiceSettingsBuilder
     .exportAssetsSettings()
     .setRetrySettings(
         assetServiceSettingsBuilder
             .exportAssetsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AssetServiceSettings assetServiceSettings = assetServiceSettingsBuilder.build();

AssetServiceSettings.Builder

Builder for AssetServiceSettings.

BigQueryDestination

A BigQuery destination for exporting assets to.

Protobuf type google.cloud.asset.v1p7beta1.BigQueryDestination

BigQueryDestination.Builder

A BigQuery destination for exporting assets to.

Protobuf type google.cloud.asset.v1p7beta1.BigQueryDestination

ExportAssetsRequest

Export asset request.

Protobuf type google.cloud.asset.v1p7beta1.ExportAssetsRequest

ExportAssetsRequest.Builder

Export asset request.

Protobuf type google.cloud.asset.v1p7beta1.ExportAssetsRequest

ExportAssetsResponse

The export asset response. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.

Protobuf type google.cloud.asset.v1p7beta1.ExportAssetsResponse

ExportAssetsResponse.Builder

The export asset response. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.

Protobuf type google.cloud.asset.v1p7beta1.ExportAssetsResponse

GcsDestination

A Cloud Storage location.

Protobuf type google.cloud.asset.v1p7beta1.GcsDestination

GcsDestination.Builder

A Cloud Storage location.

Protobuf type google.cloud.asset.v1p7beta1.GcsDestination

GcsOutputResult

A Cloud Storage output result.

Protobuf type google.cloud.asset.v1p7beta1.GcsOutputResult

GcsOutputResult.Builder

A Cloud Storage output result.

Protobuf type google.cloud.asset.v1p7beta1.GcsOutputResult

OutputConfig

Output configuration for export assets destination.

Protobuf type google.cloud.asset.v1p7beta1.OutputConfig

OutputConfig.Builder

Output configuration for export assets destination.

Protobuf type google.cloud.asset.v1p7beta1.OutputConfig

OutputResult

Output result of export assets.

Protobuf type google.cloud.asset.v1p7beta1.OutputResult

OutputResult.Builder

Output result of export assets.

Protobuf type google.cloud.asset.v1p7beta1.OutputResult

PartitionSpec

Specifications of BigQuery partitioned table as export destination.

Protobuf type google.cloud.asset.v1p7beta1.PartitionSpec

PartitionSpec.Builder

Specifications of BigQuery partitioned table as export destination.

Protobuf type google.cloud.asset.v1p7beta1.PartitionSpec

RelatedAsset

An asset identify in Google Cloud which contains its name, type and ancestors. An asset can be any resource in the Google Cloud resource hierarchy, a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy). See Supported asset types for more information.

Protobuf type google.cloud.asset.v1p7beta1.RelatedAsset

This enum is used to determine the partition key column when exporting assets to BigQuery partitioned table(s). Note that, if the partition key is a timestamp column, the actual partition is based on its date value (expressed in UTC. see details in https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables).

Protobuf enum google.cloud.asset.v1p7beta1.PartitionSpec.PartitionKey

Package com.google.cloud.asset.v1p7beta1 (3.25.0)

AssetServiceClient

Classes

Interfaces

Enums