com.google.cloud.asset.v1p5beta1.AssetServiceClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@BetaApi @Generated("by gapic-generator-java") public class AssetServiceClient extends Object 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()) {
   ResourceName parent =
       new ResourceName() {
         {@literal @}Override
         public Map<String, String> getFieldValuesMap() {
           Map<String, String> fieldValuesMap = new HashMap<>();
           fieldValuesMap.put("parent", "parent-4715/parent-4715");
           return fieldValuesMap;
         }

         {@literal @}Override
         public String getFieldValue(String fieldName) {
           return getFieldValuesMap().get(fieldName);
         }

         {@literal @}Override
         public String toString() {
           return "parent-4715/parent-4715";
         }
       };
   for (Asset element : assetServiceClient.listAssets(parent).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().

Methods
Method	Description	Method Variants
ListAssets	Lists assets with time and resource types and returns paged results in response.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAssets(ListAssetsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAssets(ResourceName parent) listAssets(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. listAssetsPagedCallable() listAssetsCallable()

See the individual methods for example code.

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

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

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AssetServiceSettings assetServiceSettings =
     AssetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AssetServiceSettings assetServiceSettings =
     AssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


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

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

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

AssetServiceClient.ListAssetsFixedSizeCollection

static class

AssetServiceClient.ListAssetsPage

static class

AssetServiceClient.ListAssetsPagedResponse
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

AssetServiceClient(AssetServiceSettings settings)

Constructs an instance of AssetServiceClient, using the given settings.

protected

AssetServiceClient(AssetServiceStub stub)
Method Summary

Modifier and Type

Method

Description

boolean

awaitTermination(long duration, TimeUnit unit)

final void

close()

static final AssetServiceClient

create()

Constructs an instance of AssetServiceClient with default settings.

static final AssetServiceClient

create(AssetServiceSettings settings)

Constructs an instance of AssetServiceClient, using the given settings.

static final AssetServiceClient

create(AssetServiceStub stub)

Constructs an instance of AssetServiceClient, using the given stub for making calls.

final AssetServiceSettings

getSettings()

AssetServiceStub

getStub()

boolean

isShutdown()

boolean

isTerminated()

final AssetServiceClient.ListAssetsPagedResponse

listAssets(ResourceName parent)

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

final AssetServiceClient.ListAssetsPagedResponse

listAssets(ListAssetsRequest request)

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

final AssetServiceClient.ListAssetsPagedResponse

listAssets(String parent)

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

final UnaryCallable<ListAssetsRequest,ListAssetsResponse>

listAssetsCallable()

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

final UnaryCallable<ListAssetsRequest,AssetServiceClient.ListAssetsPagedResponse>

listAssetsPagedCallable()

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

void

shutdown()

void

shutdownNow()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- AssetServiceClient
  
  protected AssetServiceClient(AssetServiceSettings settings) throws IOException
  
  Constructs an instance of AssetServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- AssetServiceClient
  
  protected AssetServiceClient(AssetServiceStub stub)