Package com.google.cloud.asset.v1 (3.2.17)

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

AssetServiceClient

Service Description: Asset service definition.

Sample for AssetServiceClient:


 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   BatchGetAssetsHistoryRequest request =
       BatchGetAssetsHistoryRequest.newBuilder()
           .setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString())
           .addAllAssetNames(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setReadTimeWindow(TimeWindow.newBuilder().build())
           .addAllRelationshipTypes(new ArrayList<String>())
           .build();
   BatchGetAssetsHistoryResponse response = assetServiceClient.batchGetAssetsHistory(request);
 }

Classes

AnalyzeIamPolicyLongrunningMetadata

Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyLongrunningMetadata

AnalyzeIamPolicyLongrunningMetadata.Builder

Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyLongrunningMetadata

AnalyzeIamPolicyLongrunningRequest

A request message for AssetService.AnalyzeIamPolicyLongrunning.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyLongrunningRequest

AnalyzeIamPolicyLongrunningRequest.Builder

A request message for AssetService.AnalyzeIamPolicyLongrunning.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyLongrunningRequest

AnalyzeIamPolicyLongrunningResponse

A response message for AssetService.AnalyzeIamPolicyLongrunning.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyLongrunningResponse

AnalyzeIamPolicyLongrunningResponse.Builder

A response message for AssetService.AnalyzeIamPolicyLongrunning.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyLongrunningResponse

AnalyzeIamPolicyRequest

A request message for AssetService.AnalyzeIamPolicy.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyRequest

AnalyzeIamPolicyRequest.Builder

A request message for AssetService.AnalyzeIamPolicy.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyRequest

AnalyzeIamPolicyResponse

A response message for AssetService.AnalyzeIamPolicy.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyResponse

AnalyzeIamPolicyResponse.Builder

A response message for AssetService.AnalyzeIamPolicy.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyResponse

AnalyzeIamPolicyResponse.IamPolicyAnalysis

An analysis message to group the query and results.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyResponse.IamPolicyAnalysis

AnalyzeIamPolicyResponse.IamPolicyAnalysis.Builder

An analysis message to group the query and results.

Protobuf type google.cloud.asset.v1.AnalyzeIamPolicyResponse.IamPolicyAnalysis

AnalyzeMoveRequest

The request message for performing resource move analysis.

Protobuf type google.cloud.asset.v1.AnalyzeMoveRequest

AnalyzeMoveRequest.Builder

The request message for performing resource move analysis.

Protobuf type google.cloud.asset.v1.AnalyzeMoveRequest

AnalyzeMoveResponse

The response message for resource move analysis.

Protobuf type google.cloud.asset.v1.AnalyzeMoveResponse

AnalyzeMoveResponse.Builder

The response message for resource move analysis.

Protobuf type google.cloud.asset.v1.AnalyzeMoveResponse

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. Cloud IAM policy), or a relationship (e.g. an INSTANCE_TO_INSTANCEGROUP relationship). See Supported asset types for more information.

Protobuf type google.cloud.asset.v1.Asset

Asset.Builder

Protobuf type google.cloud.asset.v1.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:


 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   BatchGetAssetsHistoryRequest request =
       BatchGetAssetsHistoryRequest.newBuilder()
           .setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString())
           .addAllAssetNames(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setReadTimeWindow(TimeWindow.newBuilder().build())
           .addAllRelationshipTypes(new ArrayList<String>())
           .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:

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:


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

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

AssetServiceClient.ListAssetsFixedSizeCollection

AssetServiceClient.ListAssetsPage

AssetServiceClient.ListAssetsPagedResponse

AssetServiceClient.SearchAllIamPoliciesFixedSizeCollection

AssetServiceClient.SearchAllIamPoliciesPage

AssetServiceClient.SearchAllIamPoliciesPagedResponse

AssetServiceClient.SearchAllResourcesFixedSizeCollection

AssetServiceClient.SearchAllResourcesPage

AssetServiceClient.SearchAllResourcesPagedResponse

AssetServiceGrpc

Asset service definition.

AssetServiceGrpc.AssetServiceBlockingStub

Asset service definition.

AssetServiceGrpc.AssetServiceFutureStub

Asset service definition.

AssetServiceGrpc.AssetServiceImplBase

Asset service definition.

AssetServiceGrpc.AssetServiceStub

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 batchGetAssetsHistory to 30 seconds:


 AssetServiceSettings.Builder assetServiceSettingsBuilder = AssetServiceSettings.newBuilder();
 assetServiceSettingsBuilder
     .batchGetAssetsHistorySettings()
     .setRetrySettings(
         assetServiceSettingsBuilder
             .batchGetAssetsHistorySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AssetServiceSettings assetServiceSettings = assetServiceSettingsBuilder.build();

AssetServiceSettings.Builder

Builder for AssetServiceSettings.

AttachedResource

Attached resource representation, which is defined by the corresponding service provider. It represents an attached resource's payload.

Protobuf type google.cloud.asset.v1.AttachedResource

AttachedResource.Builder

Attached resource representation, which is defined by the corresponding service provider. It represents an attached resource's payload.

Protobuf type google.cloud.asset.v1.AttachedResource

BatchGetAssetsHistoryRequest

Batch get assets history request.

Protobuf type google.cloud.asset.v1.BatchGetAssetsHistoryRequest

BatchGetAssetsHistoryRequest.Builder

Batch get assets history request.

Protobuf type google.cloud.asset.v1.BatchGetAssetsHistoryRequest

BatchGetAssetsHistoryResponse

Batch get assets history response.

Protobuf type google.cloud.asset.v1.BatchGetAssetsHistoryResponse

BatchGetAssetsHistoryResponse.Builder

Batch get assets history response.

Protobuf type google.cloud.asset.v1.BatchGetAssetsHistoryResponse

BigQueryDestination

A BigQuery destination for exporting assets to.

Protobuf type google.cloud.asset.v1.BigQueryDestination

BigQueryDestination.Builder

A BigQuery destination for exporting assets to.

Protobuf type google.cloud.asset.v1.BigQueryDestination

ConditionEvaluation

The Condition evaluation.

Protobuf type google.cloud.asset.v1.ConditionEvaluation

ConditionEvaluation.Builder

The Condition evaluation.

Protobuf type google.cloud.asset.v1.ConditionEvaluation

CreateFeedRequest

Create asset feed request.

Protobuf type google.cloud.asset.v1.CreateFeedRequest

CreateFeedRequest.Builder

Create asset feed request.

Protobuf type google.cloud.asset.v1.CreateFeedRequest

DeleteFeedRequest

Protobuf type google.cloud.asset.v1.DeleteFeedRequest

DeleteFeedRequest.Builder

Protobuf type google.cloud.asset.v1.DeleteFeedRequest

ExportAssetsRequest

Export asset request.

Protobuf type google.cloud.asset.v1.ExportAssetsRequest

ExportAssetsRequest.Builder

Export asset request.

Protobuf type google.cloud.asset.v1.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.v1.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.v1.ExportAssetsResponse

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: Pub/Sub topics.

Protobuf type google.cloud.asset.v1.Feed

Feed.Builder

Protobuf type google.cloud.asset.v1.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.v1.FeedOutputConfig

FeedOutputConfig.Builder

Output configuration for asset feed destination.

Protobuf type google.cloud.asset.v1.FeedOutputConfig

GcsDestination

A Cloud Storage location.

Protobuf type google.cloud.asset.v1.GcsDestination

GcsDestination.Builder

A Cloud Storage location.

Protobuf type google.cloud.asset.v1.GcsDestination

GcsOutputResult

A Cloud Storage output result.

Protobuf type google.cloud.asset.v1.GcsOutputResult

GcsOutputResult.Builder

A Cloud Storage output result.

Protobuf type google.cloud.asset.v1.GcsOutputResult

GetFeedRequest

Get asset feed request.

Protobuf type google.cloud.asset.v1.GetFeedRequest

GetFeedRequest.Builder

Get asset feed request.

Protobuf type google.cloud.asset.v1.GetFeedRequest

IamPolicyAnalysisOutputConfig

Output configuration for export IAM policy analysis destination.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisOutputConfig

IamPolicyAnalysisOutputConfig.BigQueryDestination

A BigQuery destination.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisOutputConfig.BigQueryDestination

IamPolicyAnalysisOutputConfig.BigQueryDestination.Builder

A BigQuery destination.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisOutputConfig.BigQueryDestination

IamPolicyAnalysisOutputConfig.Builder

Output configuration for export IAM policy analysis destination.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisOutputConfig

IamPolicyAnalysisOutputConfig.GcsDestination

A Cloud Storage location.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisOutputConfig.GcsDestination

IamPolicyAnalysisOutputConfig.GcsDestination.Builder

A Cloud Storage location.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisOutputConfig.GcsDestination

IamPolicyAnalysisQuery

IAM policy analysis query message.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery

IamPolicyAnalysisQuery.AccessSelector

Specifies roles and/or permissions to analyze, to determine both the identities possessing them and the resources they control. If multiple values are specified, results will include roles or permissions matching any of them. The total number of roles and permissions should be equal or less than 10.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.AccessSelector

IamPolicyAnalysisQuery.AccessSelector.Builder

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.AccessSelector

IamPolicyAnalysisQuery.Builder

IAM policy analysis query message.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery

IamPolicyAnalysisQuery.ConditionContext

The IAM conditions context.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.ConditionContext

IamPolicyAnalysisQuery.ConditionContext.Builder

The IAM conditions context.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.ConditionContext

IamPolicyAnalysisQuery.IdentitySelector

Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.IdentitySelector

IamPolicyAnalysisQuery.IdentitySelector.Builder

Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.IdentitySelector

IamPolicyAnalysisQuery.Options

Contains query options.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.Options

IamPolicyAnalysisQuery.Options.Builder

Contains query options.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.Options

IamPolicyAnalysisQuery.ResourceSelector

Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.ResourceSelector

IamPolicyAnalysisQuery.ResourceSelector.Builder

Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.ResourceSelector

IamPolicyAnalysisResult

IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult

IamPolicyAnalysisResult.Access

An IAM role or permission under analysis.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.Access

IamPolicyAnalysisResult.Access.Builder

An IAM role or permission under analysis.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.Access

IamPolicyAnalysisResult.AccessControlList

An access control list, derived from the above IAM policy binding, which contains a set of resources and accesses. May include one item from each set to compose an access control entry. NOTICE that there could be multiple access control lists for one IAM policy binding. The access control lists are created based on resource and access combinations. For example, assume we have the following cases in one IAM policy binding:

Permission P1 and P2 apply to resource R1 and R2;
Permission P3 applies to resource R2 and R3; This will result in the following access control lists:
AccessControlList 1: [R1, R2], [P1, P2]
AccessControlList 2: [R2, R3], [P3]

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.AccessControlList

IamPolicyAnalysisResult.AccessControlList.Builder

Permission P1 and P2 apply to resource R1 and R2;
Permission P3 applies to resource R2 and R3; This will result in the following access control lists:
AccessControlList 1: [R1, R2], [P1, P2]
AccessControlList 2: [R2, R3], [P3]

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.AccessControlList

IamPolicyAnalysisResult.Builder

IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult

IamPolicyAnalysisResult.Edge

A directional edge.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.Edge

IamPolicyAnalysisResult.Edge.Builder

A directional edge.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.Edge

IamPolicyAnalysisResult.Identity

An identity under analysis.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.Identity

IamPolicyAnalysisResult.Identity.Builder

An identity under analysis.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.Identity

IamPolicyAnalysisResult.IdentityList

The identities and group edges.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.IdentityList

IamPolicyAnalysisResult.IdentityList.Builder

The identities and group edges.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.IdentityList

IamPolicyAnalysisResult.Resource

A Google Cloud resource under analysis.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.Resource

IamPolicyAnalysisResult.Resource.Builder

A Google Cloud resource under analysis.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisResult.Resource

IamPolicyAnalysisState

Represents the detailed state of an entity under analysis, such as a resource, an identity or an access.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisState

IamPolicyAnalysisState.Builder

Represents the detailed state of an entity under analysis, such as a resource, an identity or an access.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisState

IamPolicySearchResult

A result of IAM Policy search, containing information of an IAM policy.

Protobuf type google.cloud.asset.v1.IamPolicySearchResult

IamPolicySearchResult.Builder

A result of IAM Policy search, containing information of an IAM policy.

Protobuf type google.cloud.asset.v1.IamPolicySearchResult

IamPolicySearchResult.Explanation

Explanation about the IAM policy search result.

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

IamPolicySearchResult.Explanation.Builder

Explanation about the IAM policy search result.

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

IamPolicySearchResult.Explanation.Permissions

IAM permissions

Protobuf type google.cloud.asset.v1.IamPolicySearchResult.Explanation.Permissions

IamPolicySearchResult.Explanation.Permissions.Builder

IAM permissions

Protobuf type google.cloud.asset.v1.IamPolicySearchResult.Explanation.Permissions

ListAssetsRequest

ListAssets request.

Protobuf type google.cloud.asset.v1.ListAssetsRequest

ListAssetsRequest.Builder

ListAssets request.

Protobuf type google.cloud.asset.v1.ListAssetsRequest

ListAssetsResponse

ListAssets response.

Protobuf type google.cloud.asset.v1.ListAssetsResponse

ListAssetsResponse.Builder

ListAssets response.

Protobuf type google.cloud.asset.v1.ListAssetsResponse

ListFeedsRequest

List asset feeds request.

Protobuf type google.cloud.asset.v1.ListFeedsRequest

ListFeedsRequest.Builder

List asset feeds request.

Protobuf type google.cloud.asset.v1.ListFeedsRequest

ListFeedsResponse

Protobuf type google.cloud.asset.v1.ListFeedsResponse

ListFeedsResponse.Builder

Protobuf type google.cloud.asset.v1.ListFeedsResponse

MoveAnalysis

A message to group the analysis information.

Protobuf type google.cloud.asset.v1.MoveAnalysis

MoveAnalysis.Builder

A message to group the analysis information.

Protobuf type google.cloud.asset.v1.MoveAnalysis

MoveAnalysisResult

An analysis result including blockers and warnings.

Protobuf type google.cloud.asset.v1.MoveAnalysisResult

MoveAnalysisResult.Builder

An analysis result including blockers and warnings.

Protobuf type google.cloud.asset.v1.MoveAnalysisResult

MoveImpact

A message to group impacts of moving the target resource.

Protobuf type google.cloud.asset.v1.MoveImpact

MoveImpact.Builder

A message to group impacts of moving the target resource.

Protobuf type google.cloud.asset.v1.MoveImpact

OutputConfig

Output configuration for export assets destination.

Protobuf type google.cloud.asset.v1.OutputConfig

OutputConfig.Builder

Output configuration for export assets destination.

Protobuf type google.cloud.asset.v1.OutputConfig

OutputResult

Output result of export assets.

Protobuf type google.cloud.asset.v1.OutputResult

OutputResult.Builder

Output result of export assets.

Protobuf type google.cloud.asset.v1.OutputResult

PartitionSpec

Specifications of BigQuery partitioned table as export destination.

Protobuf type google.cloud.asset.v1.PartitionSpec

PartitionSpec.Builder

Specifications of BigQuery partitioned table as export destination.

Protobuf type google.cloud.asset.v1.PartitionSpec

ProjectName

AUTO-GENERATED DOCUMENTATION AND CLASS

ProjectName.Builder

Builder for ProjectName.

PubsubDestination

A Pub/Sub destination.

Protobuf type google.cloud.asset.v1.PubsubDestination

PubsubDestination.Builder

A Pub/Sub destination.

Protobuf type google.cloud.asset.v1.PubsubDestination

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. Cloud IAM policy). See Supported asset types for more information.

Protobuf type google.cloud.asset.v1.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.v1.PartitionSpec.PartitionKey

TemporalAsset.PriorAssetState

State of prior asset.

Protobuf enum google.cloud.asset.v1.TemporalAsset.PriorAssetState