Class AssetServiceClient (3.49.0)

Version 3.49.0

• 3.55.0 (latest)
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.2-SNAPSHOT
• 3.6.0
• 3.4.1
• 3.3.1
• 3.2.17

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

Service Description: Asset service definition.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String parent = "parent-995424086";
   Feed response = assetServiceClient.createFeed(parent);
 }
 

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

Methods

Method	Description	Method Variants
CreateFeed	Creates a feed in a parent project/folder/organization to listen to its asset updates.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createFeed(CreateFeedRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createFeed(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createFeedCallable()
GetFeed	Gets details about an asset feed.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getFeed(GetFeedRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getFeed(FeedName name) getFeed(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getFeedCallable()
ListFeeds	Lists all asset feeds in a parent project/folder/organization.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listFeeds(ListFeedsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listFeeds(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listFeedsCallable()
UpdateFeed	Updates an asset feed configuration.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateFeed(UpdateFeedRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateFeed(Feed feed) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateFeedCallable()
DeleteFeed	Deletes an asset feed.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteFeed(DeleteFeedRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteFeed(FeedName name) deleteFeed(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteFeedCallable()

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.

Inheritance

java.lang.Object > AssetServiceClient

Static Methods

create()

public static final AssetServiceClient create()

Constructs an instance of AssetServiceClient with default settings.

Returns
Type	Description
AssetServiceClient

Exceptions
Type	Description
IOException

create(AssetServiceSettings settings)

public static final AssetServiceClient create(AssetServiceSettings settings)

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.

Parameter
Name	Description
settings	AssetServiceSettings

Returns
Type	Description
AssetServiceClient

Exceptions
Type	Description
IOException

create(AssetServiceStub stub)

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

Parameter
Name	Description
stub	AssetServiceStub

Returns
Type	Description
AssetServiceClient

Constructors

AssetServiceClient(AssetServiceSettings settings)

protected AssetServiceClient(AssetServiceSettings settings)

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.

Parameter
Name	Description
settings	AssetServiceSettings

AssetServiceClient(AssetServiceStub stub)

protected AssetServiceClient(AssetServiceStub stub)

Parameter
Name	Description
stub	AssetServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

createFeed(CreateFeedRequest request)

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

Parameter
Name	Description
request	CreateFeedRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Feed

createFeed(String parent)

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

Parameter
Name	Description
parent	String 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").

Returns
Type	Description
Feed

createFeedCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<CreateFeedRequest,Feed>

deleteFeed(DeleteFeedRequest request)

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

Parameter
Name	Description
request	DeleteFeedRequest The request object containing all of the parameters for the API call.

deleteFeed(FeedName name)

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

Parameter
Name	Description
name	FeedName 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

deleteFeed(String name)

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

Parameter
Name	Description
name	String 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

deleteFeedCallable()

public final UnaryCallable<DeleteFeedRequest,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();
 }
 

Returns
Type	Description
UnaryCallable<DeleteFeedRequest,Empty>

getFeed(FeedName name)

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

Parameter
Name	Description
name	FeedName 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

Returns
Type	Description
Feed

getFeed(GetFeedRequest request)

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

Parameter
Name	Description
request	GetFeedRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Feed

getFeed(String name)

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

Parameter
Name	Description
name	String 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

Returns
Type	Description
Feed

getFeedCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<GetFeedRequest,Feed>

getSettings()

public final AssetServiceSettings getSettings()

Returns
Type	Description
AssetServiceSettings

getStub()

public AssetServiceStub getStub()

Returns
Type	Description
AssetServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listFeeds(ListFeedsRequest request)

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

Parameter
Name	Description
request	ListFeedsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ListFeedsResponse

listFeeds(String parent)

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

Parameter
Name	Description
parent	String 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").

Returns
Type	Description
ListFeedsResponse

listFeedsCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<ListFeedsRequest,ListFeedsResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateFeed(Feed feed)

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

Parameter
Name	Description
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.

Returns
Type	Description
Feed

updateFeed(UpdateFeedRequest request)

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

Parameter
Name	Description
request	UpdateFeedRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Feed

updateFeedCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<UpdateFeedRequest,Feed>