@Generated(value="by gapic-generator-java") public class AssetServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
BatchGetAssetsHistoryRequest request =
BatchGetAssetsHistoryRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString())
.addAllAssetNames(new ArrayList<String>())
.setContentType(ContentType.forNumber(0))
.setReadTimeWindow(TimeWindow.newBuilder().build())
.addAllRelationshipTypes(new ArrayList<String>())
.build();
BatchGetAssetsHistoryResponse response = assetServiceClient.batchGetAssetsHistory(request);
}
Note: close() needs to be called on the AssetServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AssetServiceSettings to create(). For example:
To customize credentials:
AssetServiceSettings assetServiceSettings =
AssetServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
To customize the endpoint:
AssetServiceSettings assetServiceSettings =
AssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Modifier and Type | Class and Description |
---|---|
static class |
AssetServiceClient.ListAssetsFixedSizeCollection |
static class |
AssetServiceClient.ListAssetsPage |
static class |
AssetServiceClient.ListAssetsPagedResponse |
static class |
AssetServiceClient.SearchAllIamPoliciesFixedSizeCollection |
static class |
AssetServiceClient.SearchAllIamPoliciesPage |
static class |
AssetServiceClient.SearchAllIamPoliciesPagedResponse |
static class |
AssetServiceClient.SearchAllResourcesFixedSizeCollection |
static class |
AssetServiceClient.SearchAllResourcesPage |
static class |
AssetServiceClient.SearchAllResourcesPagedResponse |
Modifier | Constructor and Description |
---|---|
protected |
AssetServiceClient(AssetServiceSettings settings)
Constructs an instance of AssetServiceClient, using the given settings.
|
protected |
AssetServiceClient(AssetServiceStub stub) |
Modifier and Type | Method and 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.
|
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.
|
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.
|
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.
|
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.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.
|
AssetServiceSettings |
getSettings() |
AssetServiceStub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
AssetServiceClient.ListAssetsPagedResponse |
listAssets(ListAssetsRequest request)
Lists assets with time and resource types and returns paged results in response.
|
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(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.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 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 Cloud resources within the specified scope, such as a project, folder, or
organization.
|
com.google.api.gax.rpc.UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesResponse> |
searchAllResourcesCallable()
Searches all 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 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.
|
protected AssetServiceClient(AssetServiceSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") protected AssetServiceClient(AssetServiceStub stub)
public static final AssetServiceClient create() throws IOException
IOException
public static final AssetServiceClient create(AssetServiceSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public static final AssetServiceClient create(AssetServiceStub stub)
public final AssetServiceSettings getSettings()
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public AssetServiceStub getStub()
public final com.google.longrunning.OperationsClient getOperationsClient()
public final com.google.api.gax.longrunning.OperationFuture<ExportAssetsResponse,ExportAssetsRequest> exportAssetsAsync(ExportAssetsRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ExportAssetsRequest request =
ExportAssetsRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").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();
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<ExportAssetsRequest,ExportAssetsResponse,ExportAssetsRequest> exportAssetsOperationCallable()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ExportAssetsRequest request =
ExportAssetsRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").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();
}
public final com.google.api.gax.rpc.UnaryCallable<ExportAssetsRequest,com.google.longrunning.Operation> exportAssetsCallable()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ExportAssetsRequest request =
ExportAssetsRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").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();
}
public final AssetServiceClient.ListAssetsPagedResponse listAssets(com.google.api.resourcenames.ResourceName parent)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ResourceName parent = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]");
for (Asset element : assetServiceClient.listAssets(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent
- Required. Name of the organization or project the assets belong to. Format:
"organizations/[organization-number]" (such as "organizations/123"),
"projects/[project-id]" (such as "projects/my-project-id"), or "projects/[project-number]"
(such as "projects/12345").com.google.api.gax.rpc.ApiException
- if the remote call failspublic final AssetServiceClient.ListAssetsPagedResponse listAssets(String parent)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
String parent = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString();
for (Asset element : assetServiceClient.listAssets(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent
- Required. Name of the organization or project the assets belong to. Format:
"organizations/[organization-number]" (such as "organizations/123"),
"projects/[project-id]" (such as "projects/my-project-id"), or "projects/[project-number]"
(such as "projects/12345").com.google.api.gax.rpc.ApiException
- if the remote call failspublic final AssetServiceClient.ListAssetsPagedResponse listAssets(ListAssetsRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ListAssetsRequest request =
ListAssetsRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").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);
}
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListAssetsRequest,AssetServiceClient.ListAssetsPagedResponse> listAssetsPagedCallable()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ListAssetsRequest request =
ListAssetsRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListAssetsRequest,ListAssetsResponse> listAssetsCallable()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ListAssetsRequest request =
ListAssetsRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final BatchGetAssetsHistoryResponse batchGetAssetsHistory(BatchGetAssetsHistoryRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
BatchGetAssetsHistoryRequest request =
BatchGetAssetsHistoryRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString())
.addAllAssetNames(new ArrayList<String>())
.setContentType(ContentType.forNumber(0))
.setReadTimeWindow(TimeWindow.newBuilder().build())
.addAllRelationshipTypes(new ArrayList<String>())
.build();
BatchGetAssetsHistoryResponse response = assetServiceClient.batchGetAssetsHistory(request);
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<BatchGetAssetsHistoryRequest,BatchGetAssetsHistoryResponse> batchGetAssetsHistoryCallable()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
BatchGetAssetsHistoryRequest request =
BatchGetAssetsHistoryRequest.newBuilder()
.setParent(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString())
.addAllAssetNames(new ArrayList<String>())
.setContentType(ContentType.forNumber(0))
.setReadTimeWindow(TimeWindow.newBuilder().build())
.addAllRelationshipTypes(new ArrayList<String>())
.build();
ApiFuture<BatchGetAssetsHistoryResponse> future =
assetServiceClient.batchGetAssetsHistoryCallable().futureCall(request);
// Do something.
BatchGetAssetsHistoryResponse response = future.get();
}
public final Feed createFeed(String parent)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
String parent = "parent-995424086";
Feed response = assetServiceClient.createFeed(parent);
}
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").com.google.api.gax.rpc.ApiException
- if the remote call failspublic final Feed createFeed(CreateFeedRequest request)
Sample code:
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);
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateFeedRequest,Feed> createFeedCallable()
Sample code:
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();
}
public final Feed getFeed(FeedName name)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
FeedName name = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]");
Feed response = assetServiceClient.getFeed(name);
}
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_idcom.google.api.gax.rpc.ApiException
- if the remote call failspublic final Feed getFeed(String name)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
String name = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString();
Feed response = assetServiceClient.getFeed(name);
}
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_idcom.google.api.gax.rpc.ApiException
- if the remote call failspublic final Feed getFeed(GetFeedRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
GetFeedRequest request =
GetFeedRequest.newBuilder()
.setName(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString())
.build();
Feed response = assetServiceClient.getFeed(request);
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetFeedRequest,Feed> getFeedCallable()
Sample code:
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();
}
public final ListFeedsResponse listFeeds(String parent)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
String parent = "parent-995424086";
ListFeedsResponse response = assetServiceClient.listFeeds(parent);
}
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").com.google.api.gax.rpc.ApiException
- if the remote call failspublic final ListFeedsResponse listFeeds(ListFeedsRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ListFeedsRequest request =
ListFeedsRequest.newBuilder().setParent("parent-995424086").build();
ListFeedsResponse response = assetServiceClient.listFeeds(request);
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListFeedsRequest,ListFeedsResponse> listFeedsCallable()
Sample code:
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();
}
public final Feed updateFeed(Feed feed)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
Feed feed = Feed.newBuilder().build();
Feed response = assetServiceClient.updateFeed(feed);
}
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.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final Feed updateFeed(UpdateFeedRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
UpdateFeedRequest request =
UpdateFeedRequest.newBuilder()
.setFeed(Feed.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Feed response = assetServiceClient.updateFeed(request);
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateFeedRequest,Feed> updateFeedCallable()
Sample code:
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();
}
public final void deleteFeed(FeedName name)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
FeedName name = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]");
assetServiceClient.deleteFeed(name);
}
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_idcom.google.api.gax.rpc.ApiException
- if the remote call failspublic final void deleteFeed(String name)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
String name = FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString();
assetServiceClient.deleteFeed(name);
}
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_idcom.google.api.gax.rpc.ApiException
- if the remote call failspublic final void deleteFeed(DeleteFeedRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
DeleteFeedRequest request =
DeleteFeedRequest.newBuilder()
.setName(FeedName.ofProjectFeedName("[PROJECT]", "[FEED]").toString())
.build();
assetServiceClient.deleteFeed(request);
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteFeedRequest,com.google.protobuf.Empty> deleteFeedCallable()
Sample code:
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();
}
public final AssetServiceClient.SearchAllResourcesPagedResponse searchAllResources(String scope, String query, List<String> assetTypes)
Sample code:
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);
}
}
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:
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:
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:
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.
com.google.api.gax.rpc.ApiException
- if the remote call failspublic final AssetServiceClient.SearchAllResourcesPagedResponse searchAllResources(SearchAllResourcesRequest request)
Sample code:
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);
}
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<SearchAllResourcesRequest,AssetServiceClient.SearchAllResourcesPagedResponse> searchAllResourcesPagedCallable()
Sample code:
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesResponse> searchAllResourcesCallable()
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final AssetServiceClient.SearchAllIamPoliciesPagedResponse searchAllIamPolicies(String scope, String query)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
String scope = "scope109264468";
String query = "query107944136";
for (IamPolicySearchResult element :
assetServiceClient.searchAllIamPolicies(scope, query).iterateAll()) {
// doThingsWith(element);
}
}
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:
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 Cloud IAM policy
binding, including its members, roles, and Cloud IAM conditions. The returned Cloud IAM
policies will only contain the bindings that match your query. To learn more about the IAM
policy structure, see [IAM policy
doc](https://cloud.google.com/iam/docs/policies#structure).
Examples:
com.google.api.gax.rpc.ApiException
- if the remote call failspublic final AssetServiceClient.SearchAllIamPoliciesPagedResponse searchAllIamPolicies(SearchAllIamPoliciesRequest request)
Sample code:
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);
}
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<SearchAllIamPoliciesRequest,AssetServiceClient.SearchAllIamPoliciesPagedResponse> searchAllIamPoliciesPagedCallable()
Sample code:
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<SearchAllIamPoliciesRequest,SearchAllIamPoliciesResponse> searchAllIamPoliciesCallable()
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final AnalyzeIamPolicyResponse analyzeIamPolicy(AnalyzeIamPolicyRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
AnalyzeIamPolicyRequest request =
AnalyzeIamPolicyRequest.newBuilder()
.setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
.setExecutionTimeout(Duration.newBuilder().build())
.build();
AnalyzeIamPolicyResponse response = assetServiceClient.analyzeIamPolicy(request);
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<AnalyzeIamPolicyRequest,AnalyzeIamPolicyResponse> analyzeIamPolicyCallable()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
AnalyzeIamPolicyRequest request =
AnalyzeIamPolicyRequest.newBuilder()
.setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
.setExecutionTimeout(Duration.newBuilder().build())
.build();
ApiFuture<AnalyzeIamPolicyResponse> future =
assetServiceClient.analyzeIamPolicyCallable().futureCall(request);
// Do something.
AnalyzeIamPolicyResponse response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<AnalyzeIamPolicyLongrunningResponse,AnalyzeIamPolicyLongrunningMetadata> analyzeIamPolicyLongrunningAsync(AnalyzeIamPolicyLongrunningRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
AnalyzeIamPolicyLongrunningRequest request =
AnalyzeIamPolicyLongrunningRequest.newBuilder()
.setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
.setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build())
.build();
AnalyzeIamPolicyLongrunningResponse response =
assetServiceClient.analyzeIamPolicyLongrunningAsync(request).get();
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<AnalyzeIamPolicyLongrunningRequest,AnalyzeIamPolicyLongrunningResponse,AnalyzeIamPolicyLongrunningMetadata> analyzeIamPolicyLongrunningOperationCallable()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
AnalyzeIamPolicyLongrunningRequest request =
AnalyzeIamPolicyLongrunningRequest.newBuilder()
.setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
.setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build())
.build();
OperationFuture<AnalyzeIamPolicyLongrunningResponse, AnalyzeIamPolicyLongrunningMetadata>
future =
assetServiceClient.analyzeIamPolicyLongrunningOperationCallable().futureCall(request);
// Do something.
AnalyzeIamPolicyLongrunningResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<AnalyzeIamPolicyLongrunningRequest,com.google.longrunning.Operation> analyzeIamPolicyLongrunningCallable()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
AnalyzeIamPolicyLongrunningRequest request =
AnalyzeIamPolicyLongrunningRequest.newBuilder()
.setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
.setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build())
.build();
ApiFuture<Operation> future =
assetServiceClient.analyzeIamPolicyLongrunningCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final AnalyzeMoveResponse analyzeMove(AnalyzeMoveRequest request)
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
AnalyzeMoveRequest request =
AnalyzeMoveRequest.newBuilder()
.setResource("resource-341064690")
.setDestinationParent("destinationParent-1733659048")
.build();
AnalyzeMoveResponse response = assetServiceClient.analyzeMove(request);
}
request
- The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException
- if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<AnalyzeMoveRequest,AnalyzeMoveResponse> analyzeMoveCallable()
Sample code:
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();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface com.google.api.gax.core.BackgroundResource
public boolean isShutdown()
isShutdown
in interface com.google.api.gax.core.BackgroundResource
public boolean isTerminated()
isTerminated
in interface com.google.api.gax.core.BackgroundResource
public void shutdownNow()
shutdownNow
in interface com.google.api.gax.core.BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface com.google.api.gax.core.BackgroundResource
InterruptedException
Copyright © 2021 Google LLC. All rights reserved.