Class AssetServiceClient (3.4.1) 

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String scope = "scope109264468";
   String query = "query107944136";
   List<String> assetTypes = new ArrayList<>();
   for (StandardResourceMetadata element :
       assetServiceClient.searchAllResources(scope, query, assetTypes).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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 AssetServiceSettings assetServiceSettings =
     AssetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
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()

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

searchAllIamPolicies(SearchAllIamPoliciesRequest request)

public final AssetServiceClient.SearchAllIamPoliciesPagedResponse searchAllIamPolicies(SearchAllIamPoliciesRequest request)

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don't have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   SearchAllIamPoliciesRequest request =
       SearchAllIamPoliciesRequest.newBuilder()
           .setScope("scope109264468")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (IamPolicySearchResult element :
       assetServiceClient.searchAllIamPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request SearchAllIamPoliciesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AssetServiceClient.SearchAllIamPoliciesPagedResponse

searchAllIamPolicies(String scope, String query)

public final AssetServiceClient.SearchAllIamPoliciesPagedResponse searchAllIamPolicies(String scope, String query)

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don't have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String scope = "scope109264468";
   String query = "query107944136";
   for (IamPolicySearchResult element :
       assetServiceClient.searchAllIamPolicies(scope, query).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
scope String

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number(such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project id (such as "projects/abc")

query String

Optional. The query statement. Examples:

  • "policy:myuser@mydomain.com"
  • "policy:(myuser@mydomain.com viewer)"

Returns
Type Description
AssetServiceClient.SearchAllIamPoliciesPagedResponse

searchAllIamPoliciesCallable()

public final UnaryCallable<SearchAllIamPoliciesRequest,SearchAllIamPoliciesResponse> searchAllIamPoliciesCallable()

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don't have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   SearchAllIamPoliciesRequest request =
       SearchAllIamPoliciesRequest.newBuilder()
           .setScope("scope109264468")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchAllIamPoliciesResponse response =
         assetServiceClient.searchAllIamPoliciesCallable().call(request);
     for (IamPolicySearchResult element : response.getResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<SearchAllIamPoliciesRequest,SearchAllIamPoliciesResponse>

searchAllIamPoliciesPagedCallable()

public final UnaryCallable<SearchAllIamPoliciesRequest,AssetServiceClient.SearchAllIamPoliciesPagedResponse> searchAllIamPoliciesPagedCallable()

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don't have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   SearchAllIamPoliciesRequest request =
       SearchAllIamPoliciesRequest.newBuilder()
           .setScope("scope109264468")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<IamPolicySearchResult> future =
       assetServiceClient.searchAllIamPoliciesPagedCallable().futureCall(request);
   // Do something.
   for (IamPolicySearchResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<SearchAllIamPoliciesRequest,SearchAllIamPoliciesPagedResponse>

searchAllResources(SearchAllResourcesRequest request)

public final AssetServiceClient.SearchAllResourcesPagedResponse searchAllResources(SearchAllResourcesRequest request)

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don't have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   SearchAllResourcesRequest request =
       SearchAllResourcesRequest.newBuilder()
           .setScope("scope109264468")
           .setQuery("query107944136")
           .addAllAssetTypes(new ArrayList<String>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (StandardResourceMetadata element :
       assetServiceClient.searchAllResources(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request SearchAllResourcesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AssetServiceClient.SearchAllResourcesPagedResponse

searchAllResources(String scope, String query, List<String> assetTypes)

public final AssetServiceClient.SearchAllResourcesPagedResponse searchAllResources(String scope, String query, List<String> assetTypes)

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don't have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   String scope = "scope109264468";
   String query = "query107944136";
   List<String> assetTypes = new ArrayList<>();
   for (StandardResourceMetadata element :
       assetServiceClient.searchAllResources(scope, query, assetTypes).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
scope String

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number(such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project id (such as "projects/abc")

query String

Optional. The query statement.
assetTypes List<String>

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.
Returns
Type Description
AssetServiceClient.SearchAllResourcesPagedResponse

searchAllResourcesCallable()

public final UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesResponse> searchAllResourcesCallable()

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don't have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   SearchAllResourcesRequest request =
       SearchAllResourcesRequest.newBuilder()
           .setScope("scope109264468")
           .setQuery("query107944136")
           .addAllAssetTypes(new ArrayList<String>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     SearchAllResourcesResponse response =
         assetServiceClient.searchAllResourcesCallable().call(request);
     for (StandardResourceMetadata element : response.getResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesResponse>

searchAllResourcesPagedCallable()

public final UnaryCallable<SearchAllResourcesRequest,AssetServiceClient.SearchAllResourcesPagedResponse> searchAllResourcesPagedCallable()

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don't have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
   SearchAllResourcesRequest request =
       SearchAllResourcesRequest.newBuilder()
           .setScope("scope109264468")
           .setQuery("query107944136")
           .addAllAssetTypes(new ArrayList<String>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<StandardResourceMetadata> future =
       assetServiceClient.searchAllResourcesPagedCallable().futureCall(request);
   // Do something.
   for (StandardResourceMetadata element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()