Class AssetServiceClient
- java.lang.Object
-
- com.google.cloud.asset.v1.AssetServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class AssetServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
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()) { BatchGetAssetsHistoryRequest request = BatchGetAssetsHistoryRequest.newBuilder() .setParent(FolderName.of("[FOLDER]").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:
// 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.
-
-
Nested Class Summary
-
Constructor Summary
Constructors Modifier Constructor Description protected
AssetServiceClient(AssetServiceSettings settings)
Constructs an instance of AssetServiceClient, using the given settings.protected
AssetServiceClient(AssetServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AnalyzeIamPolicyResponse
analyzeIamPolicy(AnalyzeIamPolicyRequest request)
Analyzes IAM policies to answer which identities have what accesses on which resources.com.google.api.gax.rpc.UnaryCallable<AnalyzeIamPolicyRequest,AnalyzeIamPolicyResponse>
analyzeIamPolicyCallable()
Analyzes IAM policies to answer which identities have what accesses on which resources.com.google.api.gax.longrunning.OperationFuture<AnalyzeIamPolicyLongrunningResponse,AnalyzeIamPolicyLongrunningMetadata>
analyzeIamPolicyLongrunningAsync(AnalyzeIamPolicyLongrunningRequest request)
Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination.com.google.api.gax.rpc.UnaryCallable<AnalyzeIamPolicyLongrunningRequest,com.google.longrunning.Operation>
analyzeIamPolicyLongrunningCallable()
Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination.com.google.api.gax.rpc.OperationCallable<AnalyzeIamPolicyLongrunningRequest,AnalyzeIamPolicyLongrunningResponse,AnalyzeIamPolicyLongrunningMetadata>
analyzeIamPolicyLongrunningOperationCallable()
Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination.AnalyzeMoveResponse
analyzeMove(AnalyzeMoveRequest request)
Analyze moving a resource to a specified destination without kicking off the actual move.com.google.api.gax.rpc.UnaryCallable<AnalyzeMoveRequest,AnalyzeMoveResponse>
analyzeMoveCallable()
Analyze moving a resource to a specified destination without kicking off the actual move.AssetServiceClient.AnalyzeOrgPoliciesPagedResponse
analyzeOrgPolicies(AnalyzeOrgPoliciesRequest request)
Analyzes organization policies under a scope.AssetServiceClient.AnalyzeOrgPoliciesPagedResponse
analyzeOrgPolicies(String scope, String constraint, String filter)
Analyzes organization policies under a scope.com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPoliciesRequest,AnalyzeOrgPoliciesResponse>
analyzeOrgPoliciesCallable()
Analyzes organization policies under a scope.com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPoliciesRequest,AssetServiceClient.AnalyzeOrgPoliciesPagedResponse>
analyzeOrgPoliciesPagedCallable()
Analyzes organization policies under a scope.AssetServiceClient.AnalyzeOrgPolicyGovernedAssetsPagedResponse
analyzeOrgPolicyGovernedAssets(AnalyzeOrgPolicyGovernedAssetsRequest request)
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope.AssetServiceClient.AnalyzeOrgPolicyGovernedAssetsPagedResponse
analyzeOrgPolicyGovernedAssets(String scope, String constraint, String filter)
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope.com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPolicyGovernedAssetsRequest,AnalyzeOrgPolicyGovernedAssetsResponse>
analyzeOrgPolicyGovernedAssetsCallable()
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope.com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPolicyGovernedAssetsRequest,AssetServiceClient.AnalyzeOrgPolicyGovernedAssetsPagedResponse>
analyzeOrgPolicyGovernedAssetsPagedCallable()
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope.AssetServiceClient.AnalyzeOrgPolicyGovernedContainersPagedResponse
analyzeOrgPolicyGovernedContainers(AnalyzeOrgPolicyGovernedContainersRequest request)
Analyzes organization policies governed containers (projects, folders or organization) under a scope.AssetServiceClient.AnalyzeOrgPolicyGovernedContainersPagedResponse
analyzeOrgPolicyGovernedContainers(String scope, String constraint, String filter)
Analyzes organization policies governed containers (projects, folders or organization) under a scope.com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPolicyGovernedContainersRequest,AnalyzeOrgPolicyGovernedContainersResponse>
analyzeOrgPolicyGovernedContainersCallable()
Analyzes organization policies governed containers (projects, folders or organization) under a scope.com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPolicyGovernedContainersRequest,AssetServiceClient.AnalyzeOrgPolicyGovernedContainersPagedResponse>
analyzeOrgPolicyGovernedContainersPagedCallable()
Analyzes organization policies governed containers (projects, folders or organization) under a scope.boolean
awaitTermination(long duration, TimeUnit unit)
BatchGetAssetsHistoryResponse
batchGetAssetsHistory(BatchGetAssetsHistoryRequest request)
Batch gets the update history of assets that overlap a time window.com.google.api.gax.rpc.UnaryCallable<BatchGetAssetsHistoryRequest,BatchGetAssetsHistoryResponse>
batchGetAssetsHistoryCallable()
Batch gets the update history of assets that overlap a time window.BatchGetEffectiveIamPoliciesResponse
batchGetEffectiveIamPolicies(BatchGetEffectiveIamPoliciesRequest request)
Gets effective IAM policies for a batch of resources.com.google.api.gax.rpc.UnaryCallable<BatchGetEffectiveIamPoliciesRequest,BatchGetEffectiveIamPoliciesResponse>
batchGetEffectiveIamPoliciesCallable()
Gets effective IAM policies for a batch of resources.void
close()
static AssetServiceClient
create()
Constructs an instance of AssetServiceClient with default settings.static AssetServiceClient
create(AssetServiceSettings settings)
Constructs an instance of AssetServiceClient, using the given settings.static AssetServiceClient
create(AssetServiceStub stub)
Constructs an instance of AssetServiceClient, using the given stub for making calls.Feed
createFeed(CreateFeedRequest request)
Creates a feed in a parent project/folder/organization to listen to its asset updates.Feed
createFeed(String parent)
Creates a feed in a parent project/folder/organization to listen to its asset updates.com.google.api.gax.rpc.UnaryCallable<CreateFeedRequest,Feed>
createFeedCallable()
Creates a feed in a parent project/folder/organization to listen to its asset updates.SavedQuery
createSavedQuery(CreateSavedQueryRequest request)
Creates a saved query in a parent project/folder/organization.SavedQuery
createSavedQuery(FolderName parent, SavedQuery savedQuery, String savedQueryId)
Creates a saved query in a parent project/folder/organization.SavedQuery
createSavedQuery(OrganizationName parent, SavedQuery savedQuery, String savedQueryId)
Creates a saved query in a parent project/folder/organization.SavedQuery
createSavedQuery(ProjectName parent, SavedQuery savedQuery, String savedQueryId)
Creates a saved query in a parent project/folder/organization.SavedQuery
createSavedQuery(String parent, SavedQuery savedQuery, String savedQueryId)
Creates a saved query in a parent project/folder/organization.com.google.api.gax.rpc.UnaryCallable<CreateSavedQueryRequest,SavedQuery>
createSavedQueryCallable()
Creates a saved query in a parent project/folder/organization.void
deleteFeed(DeleteFeedRequest request)
Deletes an asset feed.void
deleteFeed(FeedName name)
Deletes an asset feed.void
deleteFeed(String name)
Deletes an asset feed.com.google.api.gax.rpc.UnaryCallable<DeleteFeedRequest,com.google.protobuf.Empty>
deleteFeedCallable()
Deletes an asset feed.void
deleteSavedQuery(DeleteSavedQueryRequest request)
Deletes a saved query.void
deleteSavedQuery(SavedQueryName name)
Deletes a saved query.void
deleteSavedQuery(String name)
Deletes a saved query.com.google.api.gax.rpc.UnaryCallable<DeleteSavedQueryRequest,com.google.protobuf.Empty>
deleteSavedQueryCallable()
Deletes a saved query.com.google.api.gax.longrunning.OperationFuture<ExportAssetsResponse,ExportAssetsRequest>
exportAssetsAsync(ExportAssetsRequest request)
Exports assets with time and resource types to a given Cloud Storage location/BigQuery table.com.google.api.gax.rpc.UnaryCallable<ExportAssetsRequest,com.google.longrunning.Operation>
exportAssetsCallable()
Exports assets with time and resource types to a given Cloud Storage location/BigQuery table.com.google.api.gax.rpc.OperationCallable<ExportAssetsRequest,ExportAssetsResponse,ExportAssetsRequest>
exportAssetsOperationCallable()
Exports assets with time and resource types to a given Cloud Storage location/BigQuery table.Feed
getFeed(FeedName name)
Gets details about an asset feed.Feed
getFeed(GetFeedRequest request)
Gets details about an asset feed.Feed
getFeed(String name)
Gets details about an asset feed.com.google.api.gax.rpc.UnaryCallable<GetFeedRequest,Feed>
getFeedCallable()
Gets details about an asset feed.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.SavedQuery
getSavedQuery(GetSavedQueryRequest request)
Gets details about a saved query.SavedQuery
getSavedQuery(SavedQueryName name)
Gets details about a saved query.SavedQuery
getSavedQuery(String name)
Gets details about a saved query.com.google.api.gax.rpc.UnaryCallable<GetSavedQueryRequest,SavedQuery>
getSavedQueryCallable()
Gets details about a saved query.AssetServiceSettings
getSettings()
AssetServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
AssetServiceClient.ListAssetsPagedResponse
listAssets(com.google.api.resourcenames.ResourceName parent)
Lists assets with time and resource types and returns paged results in response.AssetServiceClient.ListAssetsPagedResponse
listAssets(ListAssetsRequest request)
Lists assets with time and resource types and returns paged results in response.AssetServiceClient.ListAssetsPagedResponse
listAssets(String parent)
Lists assets with time and resource types and returns paged results in response.com.google.api.gax.rpc.UnaryCallable<ListAssetsRequest,ListAssetsResponse>
listAssetsCallable()
Lists assets with time and resource types and returns paged results in response.com.google.api.gax.rpc.UnaryCallable<ListAssetsRequest,AssetServiceClient.ListAssetsPagedResponse>
listAssetsPagedCallable()
Lists assets with time and resource types and returns paged results in response.ListFeedsResponse
listFeeds(ListFeedsRequest request)
Lists all asset feeds in a parent project/folder/organization.ListFeedsResponse
listFeeds(String parent)
Lists all asset feeds in a parent project/folder/organization.com.google.api.gax.rpc.UnaryCallable<ListFeedsRequest,ListFeedsResponse>
listFeedsCallable()
Lists all asset feeds in a parent project/folder/organization.AssetServiceClient.ListSavedQueriesPagedResponse
listSavedQueries(FolderName parent)
Lists all saved queries in a parent project/folder/organization.AssetServiceClient.ListSavedQueriesPagedResponse
listSavedQueries(ListSavedQueriesRequest request)
Lists all saved queries in a parent project/folder/organization.AssetServiceClient.ListSavedQueriesPagedResponse
listSavedQueries(OrganizationName parent)
Lists all saved queries in a parent project/folder/organization.AssetServiceClient.ListSavedQueriesPagedResponse
listSavedQueries(ProjectName parent)
Lists all saved queries in a parent project/folder/organization.AssetServiceClient.ListSavedQueriesPagedResponse
listSavedQueries(String parent)
Lists all saved queries in a parent project/folder/organization.com.google.api.gax.rpc.UnaryCallable<ListSavedQueriesRequest,ListSavedQueriesResponse>
listSavedQueriesCallable()
Lists all saved queries in a parent project/folder/organization.com.google.api.gax.rpc.UnaryCallable<ListSavedQueriesRequest,AssetServiceClient.ListSavedQueriesPagedResponse>
listSavedQueriesPagedCallable()
Lists all saved queries in a parent project/folder/organization.QueryAssetsResponse
queryAssets(QueryAssetsRequest request)
Issue a job that queries assets using a SQL statement compatible with [BigQuery Standard SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).com.google.api.gax.rpc.UnaryCallable<QueryAssetsRequest,QueryAssetsResponse>
queryAssetsCallable()
Issue a job that queries assets using a SQL statement compatible with [BigQuery Standard SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).AssetServiceClient.SearchAllIamPoliciesPagedResponse
searchAllIamPolicies(SearchAllIamPoliciesRequest request)
Searches all IAM policies within the specified scope, such as a project, folder, or organization.AssetServiceClient.SearchAllIamPoliciesPagedResponse
searchAllIamPolicies(String scope, String query)
Searches all IAM policies within the specified scope, such as a project, folder, or organization.com.google.api.gax.rpc.UnaryCallable<SearchAllIamPoliciesRequest,SearchAllIamPoliciesResponse>
searchAllIamPoliciesCallable()
Searches all IAM policies within the specified scope, such as a project, folder, or organization.com.google.api.gax.rpc.UnaryCallable<SearchAllIamPoliciesRequest,AssetServiceClient.SearchAllIamPoliciesPagedResponse>
searchAllIamPoliciesPagedCallable()
Searches all IAM policies within the specified scope, such as a project, folder, or organization.AssetServiceClient.SearchAllResourcesPagedResponse
searchAllResources(SearchAllResourcesRequest request)
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization.AssetServiceClient.SearchAllResourcesPagedResponse
searchAllResources(String scope, String query, List<String> assetTypes)
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization.com.google.api.gax.rpc.UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesResponse>
searchAllResourcesCallable()
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization.com.google.api.gax.rpc.UnaryCallable<SearchAllResourcesRequest,AssetServiceClient.SearchAllResourcesPagedResponse>
searchAllResourcesPagedCallable()
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization.void
shutdown()
void
shutdownNow()
Feed
updateFeed(Feed feed)
Updates an asset feed configuration.Feed
updateFeed(UpdateFeedRequest request)
Updates an asset feed configuration.com.google.api.gax.rpc.UnaryCallable<UpdateFeedRequest,Feed>
updateFeedCallable()
Updates an asset feed configuration.SavedQuery
updateSavedQuery(SavedQuery savedQuery, com.google.protobuf.FieldMask updateMask)
Updates a saved query.SavedQuery
updateSavedQuery(UpdateSavedQueryRequest request)
Updates a saved query.com.google.api.gax.rpc.UnaryCallable<UpdateSavedQueryRequest,SavedQuery>
updateSavedQueryCallable()
Updates a saved query.
-
-
-
Constructor Detail
-
AssetServiceClient
protected AssetServiceClient(AssetServiceSettings settings) throws IOException
Constructs an instance of AssetServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.- Throws:
IOException
-
AssetServiceClient
protected AssetServiceClient(AssetServiceStub stub)
-
-
Method Detail
-
create
public static final AssetServiceClient create() throws IOException
Constructs an instance of AssetServiceClient with default settings.- Throws:
IOException
-
create
public static final AssetServiceClient create(AssetServiceSettings settings) throws IOException
Constructs an instance of AssetServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final AssetServiceClient create(AssetServiceStub stub)
Constructs an instance of AssetServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AssetServiceSettings).
-
getSettings
public final AssetServiceSettings getSettings()
-
getStub
public AssetServiceStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
exportAssetsAsync
public final com.google.api.gax.longrunning.OperationFuture<ExportAssetsResponse,ExportAssetsRequest> exportAssetsAsync(ExportAssetsRequest request)
Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.Sample code:
// 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(FolderName.of("[FOLDER]").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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
exportAssetsOperationCallable
public final com.google.api.gax.rpc.OperationCallable<ExportAssetsRequest,ExportAssetsResponse,ExportAssetsRequest> exportAssetsOperationCallable()
Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.Sample code:
// 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(FolderName.of("[FOLDER]").toString()) .setReadTime(Timestamp.newBuilder().build()) .addAllAssetTypes(new ArrayList<String>()) .setContentType(ContentType.forNumber(0)) .setOutputConfig(OutputConfig.newBuilder().build()) .addAllRelationshipTypes(new ArrayList<String>()) .build(); OperationFuture<ExportAssetsResponse, ExportAssetsRequest> future = assetServiceClient.exportAssetsOperationCallable().futureCall(request); // Do something. ExportAssetsResponse response = future.get(); }
-
exportAssetsCallable
public final com.google.api.gax.rpc.UnaryCallable<ExportAssetsRequest,com.google.longrunning.Operation> exportAssetsCallable()
Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.Sample code:
// 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(FolderName.of("[FOLDER]").toString()) .setReadTime(Timestamp.newBuilder().build()) .addAllAssetTypes(new ArrayList<String>()) .setContentType(ContentType.forNumber(0)) .setOutputConfig(OutputConfig.newBuilder().build()) .addAllRelationshipTypes(new ArrayList<String>()) .build(); ApiFuture<Operation> future = assetServiceClient.exportAssetsCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
listAssets
public final AssetServiceClient.ListAssetsPagedResponse listAssets(com.google.api.resourcenames.ResourceName parent)
Lists assets with time and resource types and returns paged results in response.Sample code:
// 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 = FolderName.of("[FOLDER]"); for (Asset element : assetServiceClient.listAssets(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. Name of the organization, folder, or project the assets belong to. Format: "organizations/[organization-number]" (such as "organizations/123"), "projects/[project-id]" (such as "projects/my-project-id"), "projects/[project-number]" (such as "projects/12345"), or "folders/[folder-number]" (such as "folders/12345").- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAssets
public final AssetServiceClient.ListAssetsPagedResponse listAssets(String parent)
Lists assets with time and resource types and returns paged results in response.Sample code:
// 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 = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString(); for (Asset element : assetServiceClient.listAssets(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. Name of the organization, folder, or project the assets belong to. Format: "organizations/[organization-number]" (such as "organizations/123"), "projects/[project-id]" (such as "projects/my-project-id"), "projects/[project-number]" (such as "projects/12345"), or "folders/[folder-number]" (such as "folders/12345").- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAssets
public final AssetServiceClient.ListAssetsPagedResponse listAssets(ListAssetsRequest request)
Lists assets with time and resource types and returns paged results in response.Sample code:
// 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()) { ListAssetsRequest request = ListAssetsRequest.newBuilder() .setParent(FolderName.of("[FOLDER]").toString()) .setReadTime(Timestamp.newBuilder().build()) .addAllAssetTypes(new ArrayList<String>()) .setContentType(ContentType.forNumber(0)) .setPageSize(883849137) .setPageToken("pageToken873572522") .addAllRelationshipTypes(new ArrayList<String>()) .build(); for (Asset element : assetServiceClient.listAssets(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAssetsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListAssetsRequest,AssetServiceClient.ListAssetsPagedResponse> listAssetsPagedCallable()
Lists assets with time and resource types and returns paged results in response.Sample code:
// 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()) { ListAssetsRequest request = ListAssetsRequest.newBuilder() .setParent(FolderName.of("[FOLDER]").toString()) .setReadTime(Timestamp.newBuilder().build()) .addAllAssetTypes(new ArrayList<String>()) .setContentType(ContentType.forNumber(0)) .setPageSize(883849137) .setPageToken("pageToken873572522") .addAllRelationshipTypes(new ArrayList<String>()) .build(); ApiFuture<Asset> future = assetServiceClient.listAssetsPagedCallable().futureCall(request); // Do something. for (Asset element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listAssetsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListAssetsRequest,ListAssetsResponse> listAssetsCallable()
Lists assets with time and resource types and returns paged results in response.Sample code:
// 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()) { ListAssetsRequest request = ListAssetsRequest.newBuilder() .setParent(FolderName.of("[FOLDER]").toString()) .setReadTime(Timestamp.newBuilder().build()) .addAllAssetTypes(new ArrayList<String>()) .setContentType(ContentType.forNumber(0)) .setPageSize(883849137) .setPageToken("pageToken873572522") .addAllRelationshipTypes(new ArrayList<String>()) .build(); while (true) { ListAssetsResponse response = assetServiceClient.listAssetsCallable().call(request); for (Asset element : response.getAssetsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
batchGetAssetsHistory
public final BatchGetAssetsHistoryResponse batchGetAssetsHistory(BatchGetAssetsHistoryRequest request)
Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.Sample code:
// 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()) { BatchGetAssetsHistoryRequest request = BatchGetAssetsHistoryRequest.newBuilder() .setParent(FolderName.of("[FOLDER]").toString()) .addAllAssetNames(new ArrayList<String>()) .setContentType(ContentType.forNumber(0)) .setReadTimeWindow(TimeWindow.newBuilder().build()) .addAllRelationshipTypes(new ArrayList<String>()) .build(); BatchGetAssetsHistoryResponse response = assetServiceClient.batchGetAssetsHistory(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
batchGetAssetsHistoryCallable
public final com.google.api.gax.rpc.UnaryCallable<BatchGetAssetsHistoryRequest,BatchGetAssetsHistoryResponse> batchGetAssetsHistoryCallable()
Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.Sample code:
// 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()) { BatchGetAssetsHistoryRequest request = BatchGetAssetsHistoryRequest.newBuilder() .setParent(FolderName.of("[FOLDER]").toString()) .addAllAssetNames(new ArrayList<String>()) .setContentType(ContentType.forNumber(0)) .setReadTimeWindow(TimeWindow.newBuilder().build()) .addAllRelationshipTypes(new ArrayList<String>()) .build(); ApiFuture<BatchGetAssetsHistoryResponse> future = assetServiceClient.batchGetAssetsHistoryCallable().futureCall(request); // Do something. BatchGetAssetsHistoryResponse response = future.get(); }
-
createFeed
public final Feed createFeed(String parent)
Creates a feed in a parent project/folder/organization to listen to its asset updates.Sample code:
// 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); }
- Parameters:
parent
- Required. The name of the project/folder/organization where this feed should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createFeed
public final Feed createFeed(CreateFeedRequest request)
Creates a feed in a parent project/folder/organization to listen to its asset updates.Sample code:
// 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()) { CreateFeedRequest request = CreateFeedRequest.newBuilder() .setParent("parent-995424086") .setFeedId("feedId-1278410919") .setFeed(Feed.newBuilder().build()) .build(); Feed response = assetServiceClient.createFeed(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createFeedCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateFeedRequest,Feed> createFeedCallable()
Creates a feed in a parent project/folder/organization to listen to its asset updates.Sample code:
// 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()) { CreateFeedRequest request = CreateFeedRequest.newBuilder() .setParent("parent-995424086") .setFeedId("feedId-1278410919") .setFeed(Feed.newBuilder().build()) .build(); ApiFuture<Feed> future = assetServiceClient.createFeedCallable().futureCall(request); // Do something. Feed response = future.get(); }
-
getFeed
public final Feed getFeed(FeedName name)
Gets details about an asset feed.Sample code:
// 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()) { FeedName name = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]"); Feed response = assetServiceClient.getFeed(name); }
- Parameters:
name
- Required. The name of the Feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getFeed
public final Feed getFeed(String name)
Gets details about an asset feed.Sample code:
// 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 name = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString(); Feed response = assetServiceClient.getFeed(name); }
- Parameters:
name
- Required. The name of the Feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getFeed
public final Feed getFeed(GetFeedRequest request)
Gets details about an asset feed.Sample code:
// 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()) { GetFeedRequest request = GetFeedRequest.newBuilder() .setName(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString()) .build(); Feed response = assetServiceClient.getFeed(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getFeedCallable
public final com.google.api.gax.rpc.UnaryCallable<GetFeedRequest,Feed> getFeedCallable()
Gets details about an asset feed.Sample code:
// 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()) { GetFeedRequest request = GetFeedRequest.newBuilder() .setName(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString()) .build(); ApiFuture<Feed> future = assetServiceClient.getFeedCallable().futureCall(request); // Do something. Feed response = future.get(); }
-
listFeeds
public final ListFeedsResponse listFeeds(String parent)
Lists all asset feeds in a parent project/folder/organization.Sample code:
// 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"; ListFeedsResponse response = assetServiceClient.listFeeds(parent); }
- Parameters:
parent
- Required. The parent project/folder/organization whose feeds are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id").- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFeeds
public final ListFeedsResponse listFeeds(ListFeedsRequest request)
Lists all asset feeds in a parent project/folder/organization.Sample code:
// 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()) { ListFeedsRequest request = ListFeedsRequest.newBuilder().setParent("parent-995424086").build(); ListFeedsResponse response = assetServiceClient.listFeeds(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listFeedsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListFeedsRequest,ListFeedsResponse> listFeedsCallable()
Lists all asset feeds in a parent project/folder/organization.Sample code:
// 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()) { ListFeedsRequest request = ListFeedsRequest.newBuilder().setParent("parent-995424086").build(); ApiFuture<ListFeedsResponse> future = assetServiceClient.listFeedsCallable().futureCall(request); // Do something. ListFeedsResponse response = future.get(); }
-
updateFeed
public final Feed updateFeed(Feed feed)
Updates an asset feed configuration.Sample code:
// 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()) { Feed feed = Feed.newBuilder().build(); Feed response = assetServiceClient.updateFeed(feed); }
- Parameters:
feed
- Required. The new values of feed details. It must match an existing feed and the field `name` must be in the format of: projects/project_number/feeds/feed_id or folders/folder_number/feeds/feed_id or organizations/organization_number/feeds/feed_id.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateFeed
public final Feed updateFeed(UpdateFeedRequest request)
Updates an asset feed configuration.Sample code:
// 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()) { UpdateFeedRequest request = UpdateFeedRequest.newBuilder() .setFeed(Feed.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Feed response = assetServiceClient.updateFeed(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateFeedCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateFeedRequest,Feed> updateFeedCallable()
Updates an asset feed configuration.Sample code:
// 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()) { UpdateFeedRequest request = UpdateFeedRequest.newBuilder() .setFeed(Feed.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Feed> future = assetServiceClient.updateFeedCallable().futureCall(request); // Do something. Feed response = future.get(); }
-
deleteFeed
public final void deleteFeed(FeedName name)
Deletes an asset feed.Sample code:
// 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()) { FeedName name = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]"); assetServiceClient.deleteFeed(name); }
- Parameters:
name
- Required. The name of the feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteFeed
public final void deleteFeed(String name)
Deletes an asset feed.Sample code:
// 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 name = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString(); assetServiceClient.deleteFeed(name); }
- Parameters:
name
- Required. The name of the feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteFeed
public final void deleteFeed(DeleteFeedRequest request)
Deletes an asset feed.Sample code:
// 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()) { DeleteFeedRequest request = DeleteFeedRequest.newBuilder() .setName(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString()) .build(); assetServiceClient.deleteFeed(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteFeedCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteFeedRequest,com.google.protobuf.Empty> deleteFeedCallable()
Deletes an asset feed.Sample code:
// 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()) { DeleteFeedRequest request = DeleteFeedRequest.newBuilder() .setName(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString()) .build(); ApiFuture<Empty> future = assetServiceClient.deleteFeedCallable().futureCall(request); // Do something. future.get(); }
-
searchAllResources
public final AssetServiceClient.SearchAllResourcesPagedResponse searchAllResources(String scope, String query, List<String> assetTypes)
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission on the desired scope, otherwise the request will be rejected.Sample code:
// 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 (ResourceSearchResult element : assetServiceClient.searchAllResources(scope, query, assetTypes).iterateAll()) { // doThingsWith(element); } }
- Parameters:
scope
- Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the `scope`. The caller must be granted the [`cloudasset.assets.searchAllResources`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions) permission on the desired scope.The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
query
- Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`.Examples:
- `name:Important` to find Google Cloud resources whose name contains "Important" as a word.
- `name=Important` to find the Google Cloud resource whose name is exactly "Important".
- `displayName:Impor*` to find Google Cloud resources whose display name contains "Impor" as a prefix of any word in the field.
- `location:us-west*` to find Google Cloud resources whose location contains both "us" and "west" as prefixes.
- `labels:prod` to find Google Cloud resources whose labels contain "prod" as a key or value.
- `labels.env:prod` to find Google Cloud resources that have a label "env" and its value is "prod".
- `labels.env:*` to find Google Cloud resources that have a label "env".
- `kmsKey:key` to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains "key" as a word. This field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS key information.
- `kmsKeys:key` to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word "key".
- `relationships:instance-group-1` to find Google Cloud resources that have relationships with "instance-group-1" in the related resource name.
- `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".
- `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find Compute Engine instances that have relationships with "instance-group-1" in the Compute Engine instance group resource name, for relationship type "INSTANCE_TO_INSTANCEGROUP".
- `state:ACTIVE` to find Google Cloud resources whose state contains "ACTIVE" as a word.
- `NOT state:ACTIVE` to find Google Cloud resources whose state doesn't contain "ACTIVE" as a word.
- `createTime<1609459200` to find Google Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.
- `updateTime>1609459200` to find Google Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.
- `Important` to find Google Cloud resources that contain "Important" as a word in any of the searchable fields.
- `Impor*` to find Google Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields.
- `Important location:(us-west1 OR global)` to find Google Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
assetTypes
- Optional. A list of asset types that this request searches for. If empty, it will search all the [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".*Instance.*" snapshots resources whose asset type contains "Instance".
See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
searchAllResources
public final AssetServiceClient.SearchAllResourcesPagedResponse searchAllResources(SearchAllResourcesRequest request)
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission on the desired scope, otherwise the request will be rejected.Sample code:
// 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()) { SearchAllResourcesRequest request = SearchAllResourcesRequest.newBuilder() .setScope("scope109264468") .setQuery("query107944136") .addAllAssetTypes(new ArrayList<String>()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setReadMask(FieldMask.newBuilder().build()) .build(); for (ResourceSearchResult element : assetServiceClient.searchAllResources(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
searchAllResourcesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<SearchAllResourcesRequest,AssetServiceClient.SearchAllResourcesPagedResponse> searchAllResourcesPagedCallable()
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission on the desired scope, otherwise the request will be rejected.Sample code:
// 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()) { SearchAllResourcesRequest request = SearchAllResourcesRequest.newBuilder() .setScope("scope109264468") .setQuery("query107944136") .addAllAssetTypes(new ArrayList<String>()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setReadMask(FieldMask.newBuilder().build()) .build(); ApiFuture<ResourceSearchResult> future = assetServiceClient.searchAllResourcesPagedCallable().futureCall(request); // Do something. for (ResourceSearchResult element : future.get().iterateAll()) { // doThingsWith(element); } }
-
searchAllResourcesCallable
public final com.google.api.gax.rpc.UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesResponse> searchAllResourcesCallable()
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission on the desired scope, otherwise the request will be rejected.Sample code:
// 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()) { SearchAllResourcesRequest request = SearchAllResourcesRequest.newBuilder() .setScope("scope109264468") .setQuery("query107944136") .addAllAssetTypes(new ArrayList<String>()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setReadMask(FieldMask.newBuilder().build()) .build(); while (true) { SearchAllResourcesResponse response = assetServiceClient.searchAllResourcesCallable().call(request); for (ResourceSearchResult element : response.getResultsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
searchAllIamPolicies
public final AssetServiceClient.SearchAllIamPoliciesPagedResponse searchAllIamPolicies(String scope, String query)
Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllIamPolicies` permission on the desired scope, otherwise the request will be rejected.Sample code:
// 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"; for (IamPolicySearchResult element : assetServiceClient.searchAllIamPolicies(scope, query).iterateAll()) { // doThingsWith(element); } }
- Parameters:
scope
- Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the `scope`. The caller must be granted the [`cloudasset.assets.searchAllIamPolicies`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions) permission on the desired scope.The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
query
- Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-iam-policies#how_to_construct_a_query) for more information. If not specified or empty, it will search all the IAM policies within the specified `scope`. Note that the query string is compared against each IAM policy binding, including its principals, roles, and IAM conditions. The returned IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the [IAM policy documentation](https://cloud.google.com/iam/help/allow-policies/structure).Examples:
- `policy:amy@gmail.com` to find IAM policy bindings that specify user "amy@gmail.com".
- `policy:roles/compute.admin` to find IAM policy bindings that specify the Compute Admin role.
- `policy:comp*` to find IAM policy bindings that contain "comp" as a prefix of any word in the binding.
- `policy.role.permissions:storage.buckets.update` to find IAM policy bindings that specify a role containing "storage.buckets.update" permission. Note that if callers don't have `iam.roles.get` access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.
- `policy.role.permissions:upd*` to find IAM policy bindings that specify a role containing "upd" as a prefix of any word in the role permission. Note that if callers don't have `iam.roles.get` access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.
- `resource:organizations/123456` to find IAM policy bindings that are set on "organizations/123456".
- `resource=//cloudresourcemanager.googleapis.com/projects/myproject` to find IAM policy bindings that are set on the project named "myproject".
- `Important` to find IAM policy bindings that contain "Important" as a word in any of the searchable fields (except for the included permissions).
- `resource:(instance1 OR instance2) policy:amy` to find IAM policy bindings that are set on resources "instance1" or "instance2" and also specify user "amy".
- `roles:roles/compute.admin` to find IAM policy bindings that specify the Compute Admin role.
- `memberTypes:user` to find IAM policy bindings that contain the principal type "user".
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
searchAllIamPolicies
public final AssetServiceClient.SearchAllIamPoliciesPagedResponse searchAllIamPolicies(SearchAllIamPoliciesRequest request)
Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllIamPolicies` permission on the desired scope, otherwise the request will be rejected.Sample code:
// 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()) { SearchAllIamPoliciesRequest request = SearchAllIamPoliciesRequest.newBuilder() .setScope("scope109264468") .setQuery("query107944136") .setPageSize(883849137) .setPageToken("pageToken873572522") .addAllAssetTypes(new ArrayList<String>()) .setOrderBy("orderBy-1207110587") .build(); for (IamPolicySearchResult element : assetServiceClient.searchAllIamPolicies(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
searchAllIamPoliciesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<SearchAllIamPoliciesRequest,AssetServiceClient.SearchAllIamPoliciesPagedResponse> searchAllIamPoliciesPagedCallable()
Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllIamPolicies` permission on the desired scope, otherwise the request will be rejected.Sample code:
// 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()) { SearchAllIamPoliciesRequest request = SearchAllIamPoliciesRequest.newBuilder() .setScope("scope109264468") .setQuery("query107944136") .setPageSize(883849137) .setPageToken("pageToken873572522") .addAllAssetTypes(new ArrayList<String>()) .setOrderBy("orderBy-1207110587") .build(); ApiFuture<IamPolicySearchResult> future = assetServiceClient.searchAllIamPoliciesPagedCallable().futureCall(request); // Do something. for (IamPolicySearchResult element : future.get().iterateAll()) { // doThingsWith(element); } }
-
searchAllIamPoliciesCallable
public final com.google.api.gax.rpc.UnaryCallable<SearchAllIamPoliciesRequest,SearchAllIamPoliciesResponse> searchAllIamPoliciesCallable()
Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllIamPolicies` permission on the desired scope, otherwise the request will be rejected.Sample code:
// 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()) { SearchAllIamPoliciesRequest request = SearchAllIamPoliciesRequest.newBuilder() .setScope("scope109264468") .setQuery("query107944136") .setPageSize(883849137) .setPageToken("pageToken873572522") .addAllAssetTypes(new ArrayList<String>()) .setOrderBy("orderBy-1207110587") .build(); while (true) { SearchAllIamPoliciesResponse response = assetServiceClient.searchAllIamPoliciesCallable().call(request); for (IamPolicySearchResult element : response.getResultsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
analyzeIamPolicy
public final AnalyzeIamPolicyResponse analyzeIamPolicy(AnalyzeIamPolicyRequest request)
Analyzes IAM policies to answer which identities have what accesses on which resources.Sample code:
// 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()) { AnalyzeIamPolicyRequest request = AnalyzeIamPolicyRequest.newBuilder() .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build()) .setSavedAnalysisQuery("savedAnalysisQuery376058885") .setExecutionTimeout(Duration.newBuilder().build()) .build(); AnalyzeIamPolicyResponse response = assetServiceClient.analyzeIamPolicy(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeIamPolicyRequest,AnalyzeIamPolicyResponse> analyzeIamPolicyCallable()
Analyzes IAM policies to answer which identities have what accesses on which resources.Sample code:
// 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()) { AnalyzeIamPolicyRequest request = AnalyzeIamPolicyRequest.newBuilder() .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build()) .setSavedAnalysisQuery("savedAnalysisQuery376058885") .setExecutionTimeout(Duration.newBuilder().build()) .build(); ApiFuture<AnalyzeIamPolicyResponse> future = assetServiceClient.analyzeIamPolicyCallable().futureCall(request); // Do something. AnalyzeIamPolicyResponse response = future.get(); }
-
analyzeIamPolicyLongrunningAsync
public final com.google.api.gax.longrunning.OperationFuture<AnalyzeIamPolicyLongrunningResponse,AnalyzeIamPolicyLongrunningMetadata> analyzeIamPolicyLongrunningAsync(AnalyzeIamPolicyLongrunningRequest request)
Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a [AnalyzeIamPolicyResponse][google.cloud.asset.v1.AnalyzeIamPolicyResponse]. This method implements the [google.longrunning.Operation][google.longrunning.Operation], which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.Sample code:
// 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()) { AnalyzeIamPolicyLongrunningRequest request = AnalyzeIamPolicyLongrunningRequest.newBuilder() .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build()) .setSavedAnalysisQuery("savedAnalysisQuery376058885") .setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build()) .build(); AnalyzeIamPolicyLongrunningResponse response = assetServiceClient.analyzeIamPolicyLongrunningAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeIamPolicyLongrunningOperationCallable
public final com.google.api.gax.rpc.OperationCallable<AnalyzeIamPolicyLongrunningRequest,AnalyzeIamPolicyLongrunningResponse,AnalyzeIamPolicyLongrunningMetadata> analyzeIamPolicyLongrunningOperationCallable()
Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a [AnalyzeIamPolicyResponse][google.cloud.asset.v1.AnalyzeIamPolicyResponse]. This method implements the [google.longrunning.Operation][google.longrunning.Operation], which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.Sample code:
// 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()) { AnalyzeIamPolicyLongrunningRequest request = AnalyzeIamPolicyLongrunningRequest.newBuilder() .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build()) .setSavedAnalysisQuery("savedAnalysisQuery376058885") .setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build()) .build(); OperationFuture<AnalyzeIamPolicyLongrunningResponse, AnalyzeIamPolicyLongrunningMetadata> future = assetServiceClient.analyzeIamPolicyLongrunningOperationCallable().futureCall(request); // Do something. AnalyzeIamPolicyLongrunningResponse response = future.get(); }
-
analyzeIamPolicyLongrunningCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeIamPolicyLongrunningRequest,com.google.longrunning.Operation> analyzeIamPolicyLongrunningCallable()
Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a [AnalyzeIamPolicyResponse][google.cloud.asset.v1.AnalyzeIamPolicyResponse]. This method implements the [google.longrunning.Operation][google.longrunning.Operation], which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.Sample code:
// 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()) { AnalyzeIamPolicyLongrunningRequest request = AnalyzeIamPolicyLongrunningRequest.newBuilder() .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build()) .setSavedAnalysisQuery("savedAnalysisQuery376058885") .setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = assetServiceClient.analyzeIamPolicyLongrunningCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
analyzeMove
public final AnalyzeMoveResponse analyzeMove(AnalyzeMoveRequest request)
Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.Sample code:
// 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()) { AnalyzeMoveRequest request = AnalyzeMoveRequest.newBuilder() .setResource("resource-341064690") .setDestinationParent("destinationParent-1733659048") .build(); AnalyzeMoveResponse response = assetServiceClient.analyzeMove(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeMoveCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeMoveRequest,AnalyzeMoveResponse> analyzeMoveCallable()
Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.Sample code:
// 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()) { AnalyzeMoveRequest request = AnalyzeMoveRequest.newBuilder() .setResource("resource-341064690") .setDestinationParent("destinationParent-1733659048") .build(); ApiFuture<AnalyzeMoveResponse> future = assetServiceClient.analyzeMoveCallable().futureCall(request); // Do something. AnalyzeMoveResponse response = future.get(); }
-
queryAssets
public final QueryAssetsResponse queryAssets(QueryAssetsRequest request)
Issue a job that queries assets using a SQL statement compatible with [BigQuery Standard SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).If the query execution finishes within timeout and there's no pagination, the full query results will be returned in the `QueryAssetsResponse`.
Otherwise, full query results can be obtained by issuing extra requests with the `job_reference` from the a previous `QueryAssets` call.
Note, the query result has approximately 10 GB limitation enforced by BigQuery https://cloud.google.com/bigquery/docs/best-practices-performance-output, queries return larger results will result in errors.
Sample code:
// 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()) { QueryAssetsRequest request = QueryAssetsRequest.newBuilder() .setParent(FolderName.of("[FOLDER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setTimeout(Duration.newBuilder().build()) .setOutputConfig(QueryAssetsOutputConfig.newBuilder().build()) .build(); QueryAssetsResponse response = assetServiceClient.queryAssets(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
queryAssetsCallable
public final com.google.api.gax.rpc.UnaryCallable<QueryAssetsRequest,QueryAssetsResponse> queryAssetsCallable()
Issue a job that queries assets using a SQL statement compatible with [BigQuery Standard SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).If the query execution finishes within timeout and there's no pagination, the full query results will be returned in the `QueryAssetsResponse`.
Otherwise, full query results can be obtained by issuing extra requests with the `job_reference` from the a previous `QueryAssets` call.
Note, the query result has approximately 10 GB limitation enforced by BigQuery https://cloud.google.com/bigquery/docs/best-practices-performance-output, queries return larger results will result in errors.
Sample code:
// 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()) { QueryAssetsRequest request = QueryAssetsRequest.newBuilder() .setParent(FolderName.of("[FOLDER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setTimeout(Duration.newBuilder().build()) .setOutputConfig(QueryAssetsOutputConfig.newBuilder().build()) .build(); ApiFuture<QueryAssetsResponse> future = assetServiceClient.queryAssetsCallable().futureCall(request); // Do something. QueryAssetsResponse response = future.get(); }
-
createSavedQuery
public final SavedQuery createSavedQuery(FolderName parent, SavedQuery savedQuery, String savedQueryId)
Creates a saved query in a parent project/folder/organization.Sample code:
// 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()) { FolderName parent = FolderName.of("[FOLDER]"); SavedQuery savedQuery = SavedQuery.newBuilder().build(); String savedQueryId = "savedQueryId378086268"; SavedQuery response = assetServiceClient.createSavedQuery(parent, savedQuery, savedQueryId); }
- Parameters:
parent
- Required. The name of the project/folder/organization where this saved_query should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").savedQuery
- Required. The saved_query details. The `name` field must be empty as it will be generated based on the parent and saved_query_id.savedQueryId
- Required. The ID to use for the saved query, which must be unique in the specified parent. It will become the final component of the saved query's resource name.This value should be 4-63 characters, and valid characters are `[a-z][0-9]-`.
Notice that this field is required in the saved query creation, and the `name` field of the `saved_query` will be ignored.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createSavedQuery
public final SavedQuery createSavedQuery(OrganizationName parent, SavedQuery savedQuery, String savedQueryId)
Creates a saved query in a parent project/folder/organization.Sample code:
// 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()) { OrganizationName parent = OrganizationName.of("[ORGANIZATION]"); SavedQuery savedQuery = SavedQuery.newBuilder().build(); String savedQueryId = "savedQueryId378086268"; SavedQuery response = assetServiceClient.createSavedQuery(parent, savedQuery, savedQueryId); }
- Parameters:
parent
- Required. The name of the project/folder/organization where this saved_query should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").savedQuery
- Required. The saved_query details. The `name` field must be empty as it will be generated based on the parent and saved_query_id.savedQueryId
- Required. The ID to use for the saved query, which must be unique in the specified parent. It will become the final component of the saved query's resource name.This value should be 4-63 characters, and valid characters are `[a-z][0-9]-`.
Notice that this field is required in the saved query creation, and the `name` field of the `saved_query` will be ignored.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createSavedQuery
public final SavedQuery createSavedQuery(ProjectName parent, SavedQuery savedQuery, String savedQueryId)
Creates a saved query in a parent project/folder/organization.Sample code:
// 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()) { ProjectName parent = ProjectName.of("[PROJECT]"); SavedQuery savedQuery = SavedQuery.newBuilder().build(); String savedQueryId = "savedQueryId378086268"; SavedQuery response = assetServiceClient.createSavedQuery(parent, savedQuery, savedQueryId); }
- Parameters:
parent
- Required. The name of the project/folder/organization where this saved_query should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").savedQuery
- Required. The saved_query details. The `name` field must be empty as it will be generated based on the parent and saved_query_id.savedQueryId
- Required. The ID to use for the saved query, which must be unique in the specified parent. It will become the final component of the saved query's resource name.This value should be 4-63 characters, and valid characters are `[a-z][0-9]-`.
Notice that this field is required in the saved query creation, and the `name` field of the `saved_query` will be ignored.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createSavedQuery
public final SavedQuery createSavedQuery(String parent, SavedQuery savedQuery, String savedQueryId)
Creates a saved query in a parent project/folder/organization.Sample code:
// 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 = ProjectName.of("[PROJECT]").toString(); SavedQuery savedQuery = SavedQuery.newBuilder().build(); String savedQueryId = "savedQueryId378086268"; SavedQuery response = assetServiceClient.createSavedQuery(parent, savedQuery, savedQueryId); }
- Parameters:
parent
- Required. The name of the project/folder/organization where this saved_query should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").savedQuery
- Required. The saved_query details. The `name` field must be empty as it will be generated based on the parent and saved_query_id.savedQueryId
- Required. The ID to use for the saved query, which must be unique in the specified parent. It will become the final component of the saved query's resource name.This value should be 4-63 characters, and valid characters are `[a-z][0-9]-`.
Notice that this field is required in the saved query creation, and the `name` field of the `saved_query` will be ignored.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createSavedQuery
public final SavedQuery createSavedQuery(CreateSavedQueryRequest request)
Creates a saved query in a parent project/folder/organization.Sample code:
// 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()) { CreateSavedQueryRequest request = CreateSavedQueryRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setSavedQuery(SavedQuery.newBuilder().build()) .setSavedQueryId("savedQueryId378086268") .build(); SavedQuery response = assetServiceClient.createSavedQuery(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createSavedQueryCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateSavedQueryRequest,SavedQuery> createSavedQueryCallable()
Creates a saved query in a parent project/folder/organization.Sample code:
// 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()) { CreateSavedQueryRequest request = CreateSavedQueryRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setSavedQuery(SavedQuery.newBuilder().build()) .setSavedQueryId("savedQueryId378086268") .build(); ApiFuture<SavedQuery> future = assetServiceClient.createSavedQueryCallable().futureCall(request); // Do something. SavedQuery response = future.get(); }
-
getSavedQuery
public final SavedQuery getSavedQuery(SavedQueryName name)
Gets details about a saved query.Sample code:
// 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()) { SavedQueryName name = SavedQueryName.ofProjectSavedQueryName("[PROJECT]", "[SAVED_QUERY]"); SavedQuery response = assetServiceClient.getSavedQuery(name); }
- Parameters:
name
- Required. The name of the saved query and it must be in the format of:- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getSavedQuery
public final SavedQuery getSavedQuery(String name)
Gets details about a saved query.Sample code:
// 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 name = SavedQueryName.ofProjectSavedQueryName("[PROJECT]", "[SAVED_QUERY]").toString(); SavedQuery response = assetServiceClient.getSavedQuery(name); }
- Parameters:
name
- Required. The name of the saved query and it must be in the format of:- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getSavedQuery
public final SavedQuery getSavedQuery(GetSavedQueryRequest request)
Gets details about a saved query.Sample code:
// 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()) { GetSavedQueryRequest request = GetSavedQueryRequest.newBuilder() .setName( SavedQueryName.ofProjectSavedQueryName("[PROJECT]", "[SAVED_QUERY]").toString()) .build(); SavedQuery response = assetServiceClient.getSavedQuery(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getSavedQueryCallable
public final com.google.api.gax.rpc.UnaryCallable<GetSavedQueryRequest,SavedQuery> getSavedQueryCallable()
Gets details about a saved query.Sample code:
// 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()) { GetSavedQueryRequest request = GetSavedQueryRequest.newBuilder() .setName( SavedQueryName.ofProjectSavedQueryName("[PROJECT]", "[SAVED_QUERY]").toString()) .build(); ApiFuture<SavedQuery> future = assetServiceClient.getSavedQueryCallable().futureCall(request); // Do something. SavedQuery response = future.get(); }
-
listSavedQueries
public final AssetServiceClient.ListSavedQueriesPagedResponse listSavedQueries(FolderName parent)
Lists all saved queries in a parent project/folder/organization.Sample code:
// 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()) { FolderName parent = FolderName.of("[FOLDER]"); for (SavedQuery element : assetServiceClient.listSavedQueries(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The parent project/folder/organization whose savedQueries are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id").- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSavedQueries
public final AssetServiceClient.ListSavedQueriesPagedResponse listSavedQueries(OrganizationName parent)
Lists all saved queries in a parent project/folder/organization.Sample code:
// 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()) { OrganizationName parent = OrganizationName.of("[ORGANIZATION]"); for (SavedQuery element : assetServiceClient.listSavedQueries(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The parent project/folder/organization whose savedQueries are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id").- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSavedQueries
public final AssetServiceClient.ListSavedQueriesPagedResponse listSavedQueries(ProjectName parent)
Lists all saved queries in a parent project/folder/organization.Sample code:
// 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()) { ProjectName parent = ProjectName.of("[PROJECT]"); for (SavedQuery element : assetServiceClient.listSavedQueries(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The parent project/folder/organization whose savedQueries are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id").- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSavedQueries
public final AssetServiceClient.ListSavedQueriesPagedResponse listSavedQueries(String parent)
Lists all saved queries in a parent project/folder/organization.Sample code:
// 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 = ProjectName.of("[PROJECT]").toString(); for (SavedQuery element : assetServiceClient.listSavedQueries(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The parent project/folder/organization whose savedQueries are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id").- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSavedQueries
public final AssetServiceClient.ListSavedQueriesPagedResponse listSavedQueries(ListSavedQueriesRequest request)
Lists all saved queries in a parent project/folder/organization.Sample code:
// 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()) { ListSavedQueriesRequest request = ListSavedQueriesRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (SavedQuery element : assetServiceClient.listSavedQueries(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSavedQueriesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListSavedQueriesRequest,AssetServiceClient.ListSavedQueriesPagedResponse> listSavedQueriesPagedCallable()
Lists all saved queries in a parent project/folder/organization.Sample code:
// 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()) { ListSavedQueriesRequest request = ListSavedQueriesRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<SavedQuery> future = assetServiceClient.listSavedQueriesPagedCallable().futureCall(request); // Do something. for (SavedQuery element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listSavedQueriesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListSavedQueriesRequest,ListSavedQueriesResponse> listSavedQueriesCallable()
Lists all saved queries in a parent project/folder/organization.Sample code:
// 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()) { ListSavedQueriesRequest request = ListSavedQueriesRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListSavedQueriesResponse response = assetServiceClient.listSavedQueriesCallable().call(request); for (SavedQuery element : response.getSavedQueriesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
updateSavedQuery
public final SavedQuery updateSavedQuery(SavedQuery savedQuery, com.google.protobuf.FieldMask updateMask)
Updates a saved query.Sample code:
// 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()) { SavedQuery savedQuery = SavedQuery.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); SavedQuery response = assetServiceClient.updateSavedQuery(savedQuery, updateMask); }
- Parameters:
savedQuery
- Required. The saved query to update.The saved query's `name` field is used to identify the one to update, which has format as below:
- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
updateMask
- Required. The list of fields to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateSavedQuery
public final SavedQuery updateSavedQuery(UpdateSavedQueryRequest request)
Updates a saved query.Sample code:
// 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()) { UpdateSavedQueryRequest request = UpdateSavedQueryRequest.newBuilder() .setSavedQuery(SavedQuery.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); SavedQuery response = assetServiceClient.updateSavedQuery(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateSavedQueryCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateSavedQueryRequest,SavedQuery> updateSavedQueryCallable()
Updates a saved query.Sample code:
// 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()) { UpdateSavedQueryRequest request = UpdateSavedQueryRequest.newBuilder() .setSavedQuery(SavedQuery.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<SavedQuery> future = assetServiceClient.updateSavedQueryCallable().futureCall(request); // Do something. SavedQuery response = future.get(); }
-
deleteSavedQuery
public final void deleteSavedQuery(SavedQueryName name)
Deletes a saved query.Sample code:
// 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()) { SavedQueryName name = SavedQueryName.ofProjectSavedQueryName("[PROJECT]", "[SAVED_QUERY]"); assetServiceClient.deleteSavedQuery(name); }
- Parameters:
name
- Required. The name of the saved query to delete. It must be in the format of:- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteSavedQuery
public final void deleteSavedQuery(String name)
Deletes a saved query.Sample code:
// 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 name = SavedQueryName.ofProjectSavedQueryName("[PROJECT]", "[SAVED_QUERY]").toString(); assetServiceClient.deleteSavedQuery(name); }
- Parameters:
name
- Required. The name of the saved query to delete. It must be in the format of:- projects/project_number/savedQueries/saved_query_id
- folders/folder_number/savedQueries/saved_query_id
- organizations/organization_number/savedQueries/saved_query_id
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteSavedQuery
public final void deleteSavedQuery(DeleteSavedQueryRequest request)
Deletes a saved query.Sample code:
// 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()) { DeleteSavedQueryRequest request = DeleteSavedQueryRequest.newBuilder() .setName( SavedQueryName.ofProjectSavedQueryName("[PROJECT]", "[SAVED_QUERY]").toString()) .build(); assetServiceClient.deleteSavedQuery(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteSavedQueryCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteSavedQueryRequest,com.google.protobuf.Empty> deleteSavedQueryCallable()
Deletes a saved query.Sample code:
// 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()) { DeleteSavedQueryRequest request = DeleteSavedQueryRequest.newBuilder() .setName( SavedQueryName.ofProjectSavedQueryName("[PROJECT]", "[SAVED_QUERY]").toString()) .build(); ApiFuture<Empty> future = assetServiceClient.deleteSavedQueryCallable().futureCall(request); // Do something. future.get(); }
-
batchGetEffectiveIamPolicies
public final BatchGetEffectiveIamPoliciesResponse batchGetEffectiveIamPolicies(BatchGetEffectiveIamPoliciesRequest request)
Gets effective IAM policies for a batch of resources.Sample code:
// 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()) { BatchGetEffectiveIamPoliciesRequest request = BatchGetEffectiveIamPoliciesRequest.newBuilder() .setScope(FolderName.of("[FOLDER]").toString()) .addAllNames(new ArrayList<String>()) .build(); BatchGetEffectiveIamPoliciesResponse response = assetServiceClient.batchGetEffectiveIamPolicies(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
batchGetEffectiveIamPoliciesCallable
public final com.google.api.gax.rpc.UnaryCallable<BatchGetEffectiveIamPoliciesRequest,BatchGetEffectiveIamPoliciesResponse> batchGetEffectiveIamPoliciesCallable()
Gets effective IAM policies for a batch of resources.Sample code:
// 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()) { BatchGetEffectiveIamPoliciesRequest request = BatchGetEffectiveIamPoliciesRequest.newBuilder() .setScope(FolderName.of("[FOLDER]").toString()) .addAllNames(new ArrayList<String>()) .build(); ApiFuture<BatchGetEffectiveIamPoliciesResponse> future = assetServiceClient.batchGetEffectiveIamPoliciesCallable().futureCall(request); // Do something. BatchGetEffectiveIamPoliciesResponse response = future.get(); }
-
analyzeOrgPolicies
public final AssetServiceClient.AnalyzeOrgPoliciesPagedResponse analyzeOrgPolicies(String scope, String constraint, String filter)
Analyzes organization policies under a scope.Sample code:
// 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 constraint = "constraint-190376483"; String filter = "filter-1274492040"; for (AnalyzeOrgPoliciesResponse.OrgPolicyResult element : assetServiceClient.analyzeOrgPolicies(scope, constraint, filter).iterateAll()) { // doThingsWith(element); } }
- Parameters:
scope
- Required. The organization to scope the request. Only organization policies within the scope will be analyzed.- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
constraint
- Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.filter
- The expression to filter [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results]. The only supported field is `consolidated_policy.attached_resource`, and the only supported operator is `=`.Example: consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return the org policy results of"folders/001".
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeOrgPolicies
public final AssetServiceClient.AnalyzeOrgPoliciesPagedResponse analyzeOrgPolicies(AnalyzeOrgPoliciesRequest request)
Analyzes organization policies under a scope.Sample code:
// 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()) { AnalyzeOrgPoliciesRequest request = AnalyzeOrgPoliciesRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (AnalyzeOrgPoliciesResponse.OrgPolicyResult element : assetServiceClient.analyzeOrgPolicies(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeOrgPoliciesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPoliciesRequest,AssetServiceClient.AnalyzeOrgPoliciesPagedResponse> analyzeOrgPoliciesPagedCallable()
Analyzes organization policies under a scope.Sample code:
// 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()) { AnalyzeOrgPoliciesRequest request = AnalyzeOrgPoliciesRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<AnalyzeOrgPoliciesResponse.OrgPolicyResult> future = assetServiceClient.analyzeOrgPoliciesPagedCallable().futureCall(request); // Do something. for (AnalyzeOrgPoliciesResponse.OrgPolicyResult element : future.get().iterateAll()) { // doThingsWith(element); } }
-
analyzeOrgPoliciesCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPoliciesRequest,AnalyzeOrgPoliciesResponse> analyzeOrgPoliciesCallable()
Analyzes organization policies under a scope.Sample code:
// 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()) { AnalyzeOrgPoliciesRequest request = AnalyzeOrgPoliciesRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { AnalyzeOrgPoliciesResponse response = assetServiceClient.analyzeOrgPoliciesCallable().call(request); for (AnalyzeOrgPoliciesResponse.OrgPolicyResult element : response.getOrgPolicyResultsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
analyzeOrgPolicyGovernedContainers
public final AssetServiceClient.AnalyzeOrgPolicyGovernedContainersPagedResponse analyzeOrgPolicyGovernedContainers(String scope, String constraint, String filter)
Analyzes organization policies governed containers (projects, folders or organization) under a scope.Sample code:
// 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 constraint = "constraint-190376483"; String filter = "filter-1274492040"; for (AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer element : assetServiceClient .analyzeOrgPolicyGovernedContainers(scope, constraint, filter) .iterateAll()) { // doThingsWith(element); } }
- Parameters:
scope
- Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output containers will also be limited to the ones governed by those in-scope organization policies.- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
constraint
- Required. The name of the constraint to analyze governed containers for. The analysis only contains organization policies for the provided constraint.filter
- The expression to filter the governed containers in result. The only supported field is `parent`, and the only supported operator is `=`.Example: parent="//cloudresourcemanager.googleapis.com/folders/001" will return all containers under "folders/001".
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeOrgPolicyGovernedContainers
public final AssetServiceClient.AnalyzeOrgPolicyGovernedContainersPagedResponse analyzeOrgPolicyGovernedContainers(AnalyzeOrgPolicyGovernedContainersRequest request)
Analyzes organization policies governed containers (projects, folders or organization) under a scope.Sample code:
// 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()) { AnalyzeOrgPolicyGovernedContainersRequest request = AnalyzeOrgPolicyGovernedContainersRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer element : assetServiceClient.analyzeOrgPolicyGovernedContainers(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeOrgPolicyGovernedContainersPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPolicyGovernedContainersRequest,AssetServiceClient.AnalyzeOrgPolicyGovernedContainersPagedResponse> analyzeOrgPolicyGovernedContainersPagedCallable()
Analyzes organization policies governed containers (projects, folders or organization) under a scope.Sample code:
// 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()) { AnalyzeOrgPolicyGovernedContainersRequest request = AnalyzeOrgPolicyGovernedContainersRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer> future = assetServiceClient.analyzeOrgPolicyGovernedContainersPagedCallable().futureCall(request); // Do something. for (AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer element : future.get().iterateAll()) { // doThingsWith(element); } }
-
analyzeOrgPolicyGovernedContainersCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPolicyGovernedContainersRequest,AnalyzeOrgPolicyGovernedContainersResponse> analyzeOrgPolicyGovernedContainersCallable()
Analyzes organization policies governed containers (projects, folders or organization) under a scope.Sample code:
// 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()) { AnalyzeOrgPolicyGovernedContainersRequest request = AnalyzeOrgPolicyGovernedContainersRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { AnalyzeOrgPolicyGovernedContainersResponse response = assetServiceClient.analyzeOrgPolicyGovernedContainersCallable().call(request); for (AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer element : response.getGovernedContainersList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
analyzeOrgPolicyGovernedAssets
public final AssetServiceClient.AnalyzeOrgPolicyGovernedAssetsPagedResponse analyzeOrgPolicyGovernedAssets(String scope, String constraint, String filter)
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following 10 canned constraints:- storage.uniformBucketLevelAccess
- iam.disableServiceAccountKeyCreation
- iam.allowedPolicyMemberDomains
- compute.vmExternalIpAccess
- appengine.enforceServiceAccountActAsCheck
- gcp.resourceLocations
- compute.trustedImageProjects
- compute.skipDefaultNetworkCreation
- compute.requireOsLogin
- compute.disableNestedVirtualization
This RPC only returns either resources of types supported by [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types), or IAM policies.
Sample code:
// 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 constraint = "constraint-190376483"; String filter = "filter-1274492040"; for (AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset element : assetServiceClient .analyzeOrgPolicyGovernedAssets(scope, constraint, filter) .iterateAll()) { // doThingsWith(element); } }
- Parameters:
scope
- Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output assets will also be limited to the ones governed by those in-scope organization policies.- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
constraint
- Required. The name of the constraint to analyze governed assets for. The analysis only contains analyzed organization policies for the provided constraint.filter
- The expression to filter the governed assets in result. The only supported fields for governed resources are `governed_resource.project` and `governed_resource.folders`. The only supported fields for governed iam policies are `governed_iam_policy.project` and `governed_iam_policy.folders`. The only supported operator is `=`.Example 1: governed_resource.project="projects/12345678" filter will return all governed resources under projects/12345678 including the project ifself, if applicable.
Example 2: governed_iam_policy.folders="folders/12345678" filter will return all governed iam policies under folders/12345678, if applicable.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeOrgPolicyGovernedAssets
public final AssetServiceClient.AnalyzeOrgPolicyGovernedAssetsPagedResponse analyzeOrgPolicyGovernedAssets(AnalyzeOrgPolicyGovernedAssetsRequest request)
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following 10 canned constraints:- storage.uniformBucketLevelAccess
- iam.disableServiceAccountKeyCreation
- iam.allowedPolicyMemberDomains
- compute.vmExternalIpAccess
- appengine.enforceServiceAccountActAsCheck
- gcp.resourceLocations
- compute.trustedImageProjects
- compute.skipDefaultNetworkCreation
- compute.requireOsLogin
- compute.disableNestedVirtualization
This RPC only returns either resources of types supported by [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types), or IAM policies.
Sample code:
// 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()) { AnalyzeOrgPolicyGovernedAssetsRequest request = AnalyzeOrgPolicyGovernedAssetsRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset element : assetServiceClient.analyzeOrgPolicyGovernedAssets(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
analyzeOrgPolicyGovernedAssetsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPolicyGovernedAssetsRequest,AssetServiceClient.AnalyzeOrgPolicyGovernedAssetsPagedResponse> analyzeOrgPolicyGovernedAssetsPagedCallable()
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following 10 canned constraints:- storage.uniformBucketLevelAccess
- iam.disableServiceAccountKeyCreation
- iam.allowedPolicyMemberDomains
- compute.vmExternalIpAccess
- appengine.enforceServiceAccountActAsCheck
- gcp.resourceLocations
- compute.trustedImageProjects
- compute.skipDefaultNetworkCreation
- compute.requireOsLogin
- compute.disableNestedVirtualization
This RPC only returns either resources of types supported by [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types), or IAM policies.
Sample code:
// 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()) { AnalyzeOrgPolicyGovernedAssetsRequest request = AnalyzeOrgPolicyGovernedAssetsRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset> future = assetServiceClient.analyzeOrgPolicyGovernedAssetsPagedCallable().futureCall(request); // Do something. for (AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset element : future.get().iterateAll()) { // doThingsWith(element); } }
-
analyzeOrgPolicyGovernedAssetsCallable
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeOrgPolicyGovernedAssetsRequest,AnalyzeOrgPolicyGovernedAssetsResponse> analyzeOrgPolicyGovernedAssetsCallable()
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following 10 canned constraints:- storage.uniformBucketLevelAccess
- iam.disableServiceAccountKeyCreation
- iam.allowedPolicyMemberDomains
- compute.vmExternalIpAccess
- appengine.enforceServiceAccountActAsCheck
- gcp.resourceLocations
- compute.trustedImageProjects
- compute.skipDefaultNetworkCreation
- compute.requireOsLogin
- compute.disableNestedVirtualization
This RPC only returns either resources of types supported by [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types), or IAM policies.
Sample code:
// 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()) { AnalyzeOrgPolicyGovernedAssetsRequest request = AnalyzeOrgPolicyGovernedAssetsRequest.newBuilder() .setScope("scope109264468") .setConstraint("constraint-190376483") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { AnalyzeOrgPolicyGovernedAssetsResponse response = assetServiceClient.analyzeOrgPolicyGovernedAssetsCallable().call(request); for (AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset element : response.getGovernedAssetsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-