Package com.google.cloud.asset.v1p1beta1 (3.28.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()) {
   String scope = "scope109264468";
   String query = "query107944136";
   List<String> assetTypes = new ArrayList<>();
   for (StandardResourceMetadata element :
       assetServiceClient.searchAllResources(scope, query, assetTypes).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Classes

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()) {
   String scope = "scope109264468";
   String query = "query107944136";
   List<String> assetTypes = new ArrayList<>();
   for (StandardResourceMetadata element :
       assetServiceClient.searchAllResources(scope, query, assetTypes).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:

  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:


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

AssetServiceClient.SearchAllIamPoliciesFixedSizeCollection

AssetServiceClient.SearchAllIamPoliciesPage

AssetServiceClient.SearchAllIamPoliciesPagedResponse

AssetServiceClient.SearchAllResourcesFixedSizeCollection

AssetServiceClient.SearchAllResourcesPage

AssetServiceClient.SearchAllResourcesPagedResponse

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

AssetServiceSettings.Builder

Builder for AssetServiceSettings.

IamPolicySearchResult

The result for an IAM policy search.

Protobuf type google.cloud.asset.v1p1beta1.IamPolicySearchResult

IamPolicySearchResult.Builder

The result for an IAM policy search.

Protobuf type google.cloud.asset.v1p1beta1.IamPolicySearchResult

IamPolicySearchResult.Explanation

Explanation about the IAM policy search result.

Protobuf type google.cloud.asset.v1p1beta1.IamPolicySearchResult.Explanation

IamPolicySearchResult.Explanation.Builder

Explanation about the IAM policy search result.

Protobuf type google.cloud.asset.v1p1beta1.IamPolicySearchResult.Explanation

Permissions

IAM permissions.

Protobuf type google.cloud.asset.v1p1beta1.Permissions

Permissions.Builder

IAM permissions.

Protobuf type google.cloud.asset.v1p1beta1.Permissions

SearchAllIamPoliciesRequest

Search all IAM policies request.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesRequest

SearchAllIamPoliciesRequest.Builder

Search all IAM policies request.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesRequest

SearchAllIamPoliciesResponse

Search all IAM policies response.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesResponse

SearchAllIamPoliciesResponse.Builder

Search all IAM policies response.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesResponse

SearchAllResourcesRequest

Search all resources request.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesRequest

SearchAllResourcesRequest.Builder

Search all resources request.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesRequest

SearchAllResourcesResponse

Search all resources response.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesResponse

SearchAllResourcesResponse.Builder

Search all resources response.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesResponse

StandardResourceMetadata

The standard metadata of a cloud resource.

Protobuf type google.cloud.asset.v1p1beta1.StandardResourceMetadata

StandardResourceMetadata.Builder

The standard metadata of a cloud resource.

Protobuf type google.cloud.asset.v1p1beta1.StandardResourceMetadata

Interfaces

AssetServiceGrpc.AsyncService

Asset service definition.

IamPolicySearchResult.ExplanationOrBuilder

IamPolicySearchResultOrBuilder

PermissionsOrBuilder

SearchAllIamPoliciesRequestOrBuilder

SearchAllIamPoliciesResponseOrBuilder

SearchAllResourcesRequestOrBuilder

SearchAllResourcesResponseOrBuilder

StandardResourceMetadataOrBuilder