Class AssetServiceClient (3.6.0)

Stay organized with collections Save and categorize content based on your preferences.
public class AssetServiceClient implements BackgroundResource

Service Description: Asset service definition.

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ListAssetsRequest request =
       ListAssetsRequest.newBuilder()
           .setParent("parent-995424086")
           .setReadTime(Timestamp.newBuilder().build())
           .addAllAssetTypes(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Asset element : assetServiceClient.listAssets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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:


 // 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.newBuilder()
         .setTransportChannelProvider(
             AssetServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
 

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

Inheritance

java.lang.Object > AssetServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final AssetServiceClient create()

Constructs an instance of AssetServiceClient with default settings.

Returns
TypeDescription
AssetServiceClient
Exceptions
TypeDescription
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
NameDescription
settingsAssetServiceSettings
Returns
TypeDescription
AssetServiceClient
Exceptions
TypeDescription
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
NameDescription
stubAssetServiceStub
Returns
TypeDescription
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
NameDescription
settingsAssetServiceSettings

AssetServiceClient(AssetServiceStub stub)

protected AssetServiceClient(AssetServiceStub stub)
Parameter
NameDescription
stubAssetServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

getSettings()

public final AssetServiceSettings getSettings()
Returns
TypeDescription
AssetServiceSettings

getStub()

public AssetServiceStub getStub()
Returns
TypeDescription
AssetServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listAssets(ListAssetsRequest request)

public final AssetServiceClient.ListAssetsPagedResponse listAssets(ListAssetsRequest request)

Lists assets with time and resource types and returns paged results in response.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ListAssetsRequest request =
       ListAssetsRequest.newBuilder()
           .setParent("parent-995424086")
           .setReadTime(Timestamp.newBuilder().build())
           .addAllAssetTypes(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Asset element : assetServiceClient.listAssets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListAssetsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AssetServiceClient.ListAssetsPagedResponse

listAssetsCallable()

public final UnaryCallable<ListAssetsRequest,ListAssetsResponse> listAssetsCallable()

Lists assets with time and resource types and returns paged results in response.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ListAssetsRequest request =
       ListAssetsRequest.newBuilder()
           .setParent("parent-995424086")
           .setReadTime(Timestamp.newBuilder().build())
           .addAllAssetTypes(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAssetsResponse response = assetServiceClient.listAssetsCallable().call(request);
     for (Asset element : response.getAssetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAssetsRequest,ListAssetsResponse>

listAssetsPagedCallable()

public final UnaryCallable<ListAssetsRequest,AssetServiceClient.ListAssetsPagedResponse> listAssetsPagedCallable()

Lists assets with time and resource types and returns paged results in response.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   ListAssetsRequest request =
       ListAssetsRequest.newBuilder()
           .setParent("parent-995424086")
           .setReadTime(Timestamp.newBuilder().build())
           .addAllAssetTypes(new ArrayList<String>())
           .setContentType(ContentType.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Asset> future = assetServiceClient.listAssetsPagedCallable().futureCall(request);
   // Do something.
   for (Asset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAssetsRequest,ListAssetsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()