AssetServiceClient (Google Cloud Asset Parent 3.7.1 API)

java.lang.Object
- com.google.cloud.asset.v1p1beta1.AssetServiceClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

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

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AssetServiceClient.SearchAllIamPoliciesFixedSizeCollection`
`static class`	`AssetServiceClient.SearchAllIamPoliciesPage`
`static class`	`AssetServiceClient.SearchAllIamPoliciesPagedResponse`
`static class`	`AssetServiceClient.SearchAllResourcesFixedSizeCollection`
`static class`	`AssetServiceClient.SearchAllResourcesPage`
`static class`	`AssetServiceClient.SearchAllResourcesPagedResponse`

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`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.
`AssetServiceSettings`	`getSettings()`
`AssetServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`AssetServiceClient.SearchAllIamPoliciesPagedResponse`	`searchAllIamPolicies(SearchAllIamPoliciesRequest request)` Searches all the IAM policies under a given accessible CRM scope (project/folder/organization).
`AssetServiceClient.SearchAllIamPoliciesPagedResponse`	`searchAllIamPolicies(String scope, String query)` Searches all the IAM policies under a given accessible CRM scope (project/folder/organization).
`UnaryCallable<SearchAllIamPoliciesRequest,SearchAllIamPoliciesResponse>`	`searchAllIamPoliciesCallable()` Searches all the IAM policies under a given accessible CRM scope (project/folder/organization).
`UnaryCallable<SearchAllIamPoliciesRequest,AssetServiceClient.SearchAllIamPoliciesPagedResponse>`	`searchAllIamPoliciesPagedCallable()` Searches all the IAM policies under a given accessible CRM scope (project/folder/organization).
`AssetServiceClient.SearchAllResourcesPagedResponse`	`searchAllResources(SearchAllResourcesRequest request)` Searches all the resources under a given accessible CRM scope (project/folder/organization).
`AssetServiceClient.SearchAllResourcesPagedResponse`	`searchAllResources(String scope, String query, List<String> assetTypes)` Searches all the resources under a given accessible CRM scope (project/folder/organization).
`UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesResponse>`	`searchAllResourcesCallable()` Searches all the resources under a given accessible CRM scope (project/folder/organization).
`UnaryCallable<SearchAllResourcesRequest,AssetServiceClient.SearchAllResourcesPagedResponse>`	`searchAllResourcesPagedCallable()` Searches all the resources under a given accessible CRM scope (project/folder/organization).
`void`	`shutdown()`
`void`	`shutdownNow()`

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
```
protected AssetServiceClient(AssetServiceStub stub)
```

Method Detail

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

getSettings

public final AssetServiceSettings getSettings()

getStub
```
public AssetServiceStub getStub()
```

searchAllResources

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 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 scope = "scope109264468";
   String query = "query107944136";
   List<String> assetTypes = new ArrayList<>();
   for (StandardResourceMetadata element :
       assetServiceClient.searchAllResources(scope, query, assetTypes).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

scope - 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 - Optional. The query statement.

assetTypes - Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

Throws:

ApiException - if the remote call fails

searchAllResources

public final AssetServiceClient.SearchAllResourcesPagedResponse searchAllResources(SearchAllResourcesRequest request)

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

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

searchAllResourcesPagedCallable

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

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

searchAllResourcesCallable

public final UnaryCallable<SearchAllResourcesRequest,SearchAllResourcesResponse> searchAllResourcesCallable()

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

searchAllIamPolicies

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 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 scope = "scope109264468";
   String query = "query107944136";
   for (IamPolicySearchResult element :
       assetServiceClient.searchAllIamPolicies(scope, query).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

scope - 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 - Optional. The query statement. Examples:

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

Throws:

ApiException - if the remote call fails

searchAllIamPolicies

public final AssetServiceClient.SearchAllIamPoliciesPagedResponse searchAllIamPolicies(SearchAllIamPoliciesRequest request)

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()) {
   SearchAllIamPoliciesRequest request =
       SearchAllIamPoliciesRequest.newBuilder()
           .setScope("scope109264468")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (IamPolicySearchResult element :
       assetServiceClient.searchAllIamPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

searchAllIamPoliciesPagedCallable

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

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

searchAllIamPoliciesCallable

public final UnaryCallable<SearchAllIamPoliciesRequest,SearchAllIamPoliciesResponse> searchAllIamPoliciesCallable()

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

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class AssetServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssetServiceClient

AssetServiceClient

Method Detail

create

create

create

getSettings

getStub

searchAllResources

searchAllResources

searchAllResourcesPagedCallable

searchAllResourcesCallable

searchAllIamPolicies

searchAllIamPolicies

searchAllIamPoliciesPagedCallable

searchAllIamPoliciesCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination