com.google.cloud.asset.v1p2beta1

Class AssetServiceClient

java.lang.Object

com.google.cloud.asset.v1p2beta1.AssetServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
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:

 
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   BatchGetAssetsHistoryResponse response = assetServiceClient.batchGetAssetsHistory(parent);
 }
 
 

Note: close() needs to be called on the assetServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AssetServiceSettings to create(). For example:

To customize credentials:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetServiceClient(AssetServiceSettings settings) Constructs an instance of AssetServiceClient, using the given settings.
protected	AssetServiceClient(AssetServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
BatchGetAssetsHistoryResponse	batchGetAssetsHistory(BatchGetAssetsHistoryRequest request) Batch gets the update history of assets that overlap a time window.
BatchGetAssetsHistoryResponse	batchGetAssetsHistory(String parent) 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(String name) Deletes an asset feed.
com.google.api.gax.rpc.UnaryCallable<DeleteFeedRequest,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.
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.
com.google.api.gax.rpc.OperationCallable<ExportAssetsRequest,ExportAssetsResponse,ExportAssetsRequest>	exportAssetsOperationCallable() Exports assets with time and resource types to a given Cloud Storage location.
static String	formatFeedName(String project, String feed) Deprecated. Use the FeedName class instead.
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()
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.
static String	parseFeedFromFeedName(String feedName) Deprecated. Use the FeedName class instead.
static String	parseProjectFromFeedName(String feedName) Deprecated. Use the FeedName class instead.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected AssetServiceClient(AssetServiceStub stub)

Method Detail

formatFeedName

@Deprecated
public static final String formatFeedName(String project,
                                                      String feed)

Deprecated. Use the FeedName class instead.

Formats a string containing the fully-qualified path to represent a feed resource.

parseProjectFromFeedName

@Deprecated
public static final String parseProjectFromFeedName(String feedName)

Deprecated. Use the FeedName class instead.

Parses the project from the given fully-qualified path which represents a feed resource.

parseFeedFromFeedName

@Deprecated
public static final String parseFeedFromFeedName(String feedName)

Deprecated. Use the FeedName class instead.

Parses the feed from the given fully-qualified path which represents a feed resource.

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use AssetServiceSettings}.

getSettings

public final AssetServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public AssetServiceStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

exportAssetsAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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. The output format is newline-delimited JSON. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportAssetsRequest request = ExportAssetsRequest.newBuilder()
     .setParent(parent)
     .setOutputConfig(outputConfig)
     .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

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
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. The output format is newline-delimited JSON. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportAssetsRequest request = ExportAssetsRequest.newBuilder()
     .setParent(parent)
     .setOutputConfig(outputConfig)
     .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. The output format is newline-delimited JSON. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportAssetsRequest request = ExportAssetsRequest.newBuilder()
     .setParent(parent)
     .setOutputConfig(outputConfig)
     .build();
   ApiFuture<Operation> future = assetServiceClient.exportAssetsCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

batchGetAssetsHistory

public final BatchGetAssetsHistoryResponse batchGetAssetsHistory(String parent)

Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. 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.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   BatchGetAssetsHistoryResponse response = assetServiceClient.batchGetAssetsHistory(parent);
 }
 

Parameters:

parent - Required. The relative name of the root asset. It can only be an organization number (such as "organizations/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

batchGetAssetsHistory

public final BatchGetAssetsHistoryResponse batchGetAssetsHistory(BatchGetAssetsHistoryRequest request)

Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. 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.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   List<String> assetNames = new ArrayList<>();
   ContentType contentType = ContentType.CONTENT_TYPE_UNSPECIFIED;
   BatchGetAssetsHistoryRequest request = BatchGetAssetsHistoryRequest.newBuilder()
     .setParent(parent)
     .addAllAssetNames(assetNames)
     .setContentType(contentType)
     .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 RESOURCE content, this API outputs history with asset in both non-delete or deleted status. 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.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   List<String> assetNames = new ArrayList<>();
   ContentType contentType = ContentType.CONTENT_TYPE_UNSPECIFIED;
   BatchGetAssetsHistoryRequest request = BatchGetAssetsHistoryRequest.newBuilder()
     .setParent(parent)
     .addAllAssetNames(assetNames)
     .setContentType(contentType)
     .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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   String feedId = "";
   Feed feed = Feed.newBuilder().build();
   CreateFeedRequest request = CreateFeedRequest.newBuilder()
     .setParent(parent)
     .setFeedId(feedId)
     .setFeed(feed)
     .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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   String feedId = "";
   Feed feed = Feed.newBuilder().build();
   CreateFeedRequest request = CreateFeedRequest.newBuilder()
     .setParent(parent)
     .setFeedId(feedId)
     .setFeed(feed)
     .build();
   ApiFuture<Feed> future = assetServiceClient.createFeedCallable().futureCall(request);
   // Do something
   Feed response = future.get();
 }
 

getFeed

public final Feed getFeed(String name)

Gets details about an asset feed.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String formattedName = AssetServiceClient.formatFeedName("[PROJECT]", "[FEED]");
   Feed response = assetServiceClient.getFeed(formattedName);
 }
 

Parameters:

name - 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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String formattedName = AssetServiceClient.formatFeedName("[PROJECT]", "[FEED]");
   GetFeedRequest request = GetFeedRequest.newBuilder()
     .setName(formattedName)
     .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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String formattedName = AssetServiceClient.formatFeedName("[PROJECT]", "[FEED]");
   GetFeedRequest request = GetFeedRequest.newBuilder()
     .setName(formattedName)
     .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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   ListFeedsRequest request = ListFeedsRequest.newBuilder()
     .setParent(parent)
     .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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "";
   ListFeedsRequest request = ListFeedsRequest.newBuilder()
     .setParent(parent)
     .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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   Feed feed = Feed.newBuilder().build();
   Feed response = assetServiceClient.updateFeed(feed);
 }
 

Parameters:

feed - 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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   Feed feed = Feed.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateFeedRequest request = UpdateFeedRequest.newBuilder()
     .setFeed(feed)
     .setUpdateMask(updateMask)
     .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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   Feed feed = Feed.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateFeedRequest request = UpdateFeedRequest.newBuilder()
     .setFeed(feed)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<Feed> future = assetServiceClient.updateFeedCallable().futureCall(request);
   // Do something
   Feed response = future.get();
 }
 

deleteFeed

public final void deleteFeed(String name)

Deletes an asset feed.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String formattedName = AssetServiceClient.formatFeedName("[PROJECT]", "[FEED]");
   assetServiceClient.deleteFeed(formattedName);
 }
 

Parameters:

name - 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:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String formattedName = AssetServiceClient.formatFeedName("[PROJECT]", "[FEED]");
   DeleteFeedRequest request = DeleteFeedRequest.newBuilder()
     .setName(formattedName)
     .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,Empty> deleteFeedCallable()

Deletes an asset feed.

Sample code:

 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String formattedName = AssetServiceClient.formatFeedName("[PROJECT]", "[FEED]");
   DeleteFeedRequest request = DeleteFeedRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = assetServiceClient.deleteFeedCallable().futureCall(request);
   // Do something
   future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException