Package com.google.cloud.asset.v1p2beta1 (3.24.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 parent = "parent-995424086";
   Feed response = assetServiceClient.createFeed(parent);
 }

Classes

Asset

Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets.

Protobuf type google.cloud.asset.v1p2beta1.Asset

Asset.Builder

Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets.

Protobuf type google.cloud.asset.v1p2beta1.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()) {
   String parent = "parent-995424086";
   Feed response = assetServiceClient.createFeed(parent);
 }

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.

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

AssetServiceSettings.Builder

Builder for AssetServiceSettings.

CreateFeedRequest

Create asset feed request.

Protobuf type google.cloud.asset.v1p2beta1.CreateFeedRequest

CreateFeedRequest.Builder

Create asset feed request.

Protobuf type google.cloud.asset.v1p2beta1.CreateFeedRequest

DeleteFeedRequest

Protobuf type google.cloud.asset.v1p2beta1.DeleteFeedRequest

DeleteFeedRequest.Builder

Protobuf type google.cloud.asset.v1p2beta1.DeleteFeedRequest

Feed

An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Cloud Pub/Sub topics.

Protobuf type google.cloud.asset.v1p2beta1.Feed

Feed.Builder

An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Cloud Pub/Sub topics.

Protobuf type google.cloud.asset.v1p2beta1.Feed

FeedName

FeedName.Builder

Builder for projects/{project}/feeds/{feed}.

FeedName.FolderFeedBuilder

Builder for folders/{folder}/feeds/{feed}.

FeedName.OrganizationFeedBuilder

Builder for organizations/{organization}/feeds/{feed}.

FeedOutputConfig

Output configuration for asset feed destination.

Protobuf type google.cloud.asset.v1p2beta1.FeedOutputConfig

FeedOutputConfig.Builder

Output configuration for asset feed destination.

Protobuf type google.cloud.asset.v1p2beta1.FeedOutputConfig

GcsDestination

A Cloud Storage location.

Protobuf type google.cloud.asset.v1p2beta1.GcsDestination

GcsDestination.Builder

A Cloud Storage location.

Protobuf type google.cloud.asset.v1p2beta1.GcsDestination

GetFeedRequest

Get asset feed request.

Protobuf type google.cloud.asset.v1p2beta1.GetFeedRequest

GetFeedRequest.Builder

Get asset feed request.

Protobuf type google.cloud.asset.v1p2beta1.GetFeedRequest

ListFeedsRequest

List asset feeds request.

Protobuf type google.cloud.asset.v1p2beta1.ListFeedsRequest

ListFeedsRequest.Builder

List asset feeds request.

Protobuf type google.cloud.asset.v1p2beta1.ListFeedsRequest

ListFeedsResponse

Protobuf type google.cloud.asset.v1p2beta1.ListFeedsResponse

ListFeedsResponse.Builder

Protobuf type google.cloud.asset.v1p2beta1.ListFeedsResponse

OutputConfig

Output configuration for export assets destination.

Protobuf type google.cloud.asset.v1p2beta1.OutputConfig

OutputConfig.Builder

Output configuration for export assets destination.

Protobuf type google.cloud.asset.v1p2beta1.OutputConfig

PubsubDestination

A Cloud Pubsub destination.

Protobuf type google.cloud.asset.v1p2beta1.PubsubDestination

PubsubDestination.Builder

A Cloud Pubsub destination.

Protobuf type google.cloud.asset.v1p2beta1.PubsubDestination

Resource

Representation of a cloud resource.

Protobuf type google.cloud.asset.v1p2beta1.Resource

Resource.Builder

Representation of a cloud resource.

Protobuf type google.cloud.asset.v1p2beta1.Resource

TemporalAsset

Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it.

Protobuf type google.cloud.asset.v1p2beta1.TemporalAsset

TemporalAsset.Builder

Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it.

Protobuf type google.cloud.asset.v1p2beta1.TemporalAsset

TimeWindow

A time window of (start_time, end_time].

Protobuf type google.cloud.asset.v1p2beta1.TimeWindow

TimeWindow.Builder

A time window of (start_time, end_time].

Protobuf type google.cloud.asset.v1p2beta1.TimeWindow

UpdateFeedRequest

Update asset feed request.

Protobuf type google.cloud.asset.v1p2beta1.UpdateFeedRequest

UpdateFeedRequest.Builder

Update asset feed request.

Protobuf type google.cloud.asset.v1p2beta1.UpdateFeedRequest

Interfaces

AssetOrBuilder

AssetServiceGrpc.AsyncService

Asset service definition.

CreateFeedRequestOrBuilder

DeleteFeedRequestOrBuilder

FeedOrBuilder

FeedOutputConfigOrBuilder

GcsDestinationOrBuilder

GetFeedRequestOrBuilder

ListFeedsRequestOrBuilder

ListFeedsResponseOrBuilder

OutputConfigOrBuilder

PubsubDestinationOrBuilder

ResourceOrBuilder

TemporalAssetOrBuilder

TimeWindowOrBuilder

UpdateFeedRequestOrBuilder

Enums

ContentType

Asset content type.

Protobuf enum google.cloud.asset.v1p2beta1.ContentType

FeedOutputConfig.DestinationCase

GcsDestination.ObjectUriCase

OutputConfig.DestinationCase