Package com.google.cloud.asset.v1p5beta1 (3.17.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()) {
   ResourceName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
   for (Asset element : assetServiceClient.listAssets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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.v1p5beta1.Asset

Asset.Builder

Protobuf type google.cloud.asset.v1p5beta1.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()) {
   ResourceName parent =
       new ResourceName() {
         {@literal @}Override
         public Map<String, String> getFieldValuesMap() {
           Map<String, String> fieldValuesMap = new HashMap<>();
           fieldValuesMap.put("parent", "parent-4715/parent-4715");
           return fieldValuesMap;
         }

         {@literal @}Override
         public String getFieldValue(String fieldName) {
           return getFieldValuesMap().get(fieldName);
         }

         {@literal @}Override
         public String toString() {
           return "parent-4715/parent-4715";
         }
       };
   for (Asset element : assetServiceClient.listAssets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.newHttpJsonBuilder().build();
 AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);

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

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

Enums

Asset.AccessContextPolicyCase

ContentType

Asset content type.

Protobuf enum google.cloud.asset.v1p5beta1.ContentType

Package com.google.cloud.asset.v1p5beta1 (3.17.0)

AssetServiceClient

Classes

Asset

Asset.Builder

AssetProto

AssetServiceClient

AssetServiceClient.ListAssetsFixedSizeCollection

AssetServiceClient.ListAssetsPage

AssetServiceClient.ListAssetsPagedResponse

AssetServiceGrpc

AssetServiceGrpc.AssetServiceBlockingStub

AssetServiceGrpc.AssetServiceFutureStub

AssetServiceGrpc.AssetServiceImplBase

AssetServiceGrpc.AssetServiceStub

AssetServiceProto

AssetServiceSettings

AssetServiceSettings.Builder

ListAssetsRequest

ListAssetsRequest.Builder

ListAssetsResponse

ListAssetsResponse.Builder

Resource

Resource.Builder

Interfaces

AssetOrBuilder

ListAssetsRequestOrBuilder

ListAssetsResponseOrBuilder

ResourceOrBuilder

Enums

Asset.AccessContextPolicyCase

ContentType