Class AssetServiceClient (3.3.1)

Version 3.3.1

• 3.57.0 (latest)
• 3.56.0
• 3.55.0
• 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

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()) {
   AnalyzeIamPolicyRequest request =
       AnalyzeIamPolicyRequest.newBuilder()
           .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
           .setOptions(AnalyzeIamPolicyRequest.Options.newBuilder().build())
           .build();
   AnalyzeIamPolicyResponse response = assetServiceClient.analyzeIamPolicy(request);
 }
 

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

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

Inheritance

java.lang.Object > AssetServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

analyzeIamPolicy(AnalyzeIamPolicyRequest request)

public final AnalyzeIamPolicyResponse analyzeIamPolicy(AnalyzeIamPolicyRequest request)

Analyzes IAM policies based on the specified request. Returns a list of IamPolicyAnalysisResult matching the request.

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()) {
   AnalyzeIamPolicyRequest request =
       AnalyzeIamPolicyRequest.newBuilder()
           .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
           .setOptions(AnalyzeIamPolicyRequest.Options.newBuilder().build())
           .build();
   AnalyzeIamPolicyResponse response = assetServiceClient.analyzeIamPolicy(request);
 }
 

Parameter

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

Returns

Type	Description
AnalyzeIamPolicyResponse

analyzeIamPolicyCallable()

public final UnaryCallable<AnalyzeIamPolicyRequest,AnalyzeIamPolicyResponse> analyzeIamPolicyCallable()

Analyzes IAM policies based on the specified request. Returns a list of IamPolicyAnalysisResult matching the request.

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()) {
   AnalyzeIamPolicyRequest request =
       AnalyzeIamPolicyRequest.newBuilder()
           .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
           .setOptions(AnalyzeIamPolicyRequest.Options.newBuilder().build())
           .build();
   ApiFuture<AnalyzeIamPolicyResponse> future =
       assetServiceClient.analyzeIamPolicyCallable().futureCall(request);
   // Do something.
   AnalyzeIamPolicyResponse response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<AnalyzeIamPolicyRequest,AnalyzeIamPolicyResponse>

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

exportIamPolicyAnalysisAsync(ExportIamPolicyAnalysisRequest request)

public final OperationFuture<ExportIamPolicyAnalysisResponse,ExportIamPolicyAnalysisRequest> exportIamPolicyAnalysisAsync(ExportIamPolicyAnalysisRequest request)

Exports IAM policy analysis based on the specified request. This API implements the google.longrunning.Operation API allowing you to keep track of the export. The metadata contains the request to help callers to map responses to requests.

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()) {
   ExportIamPolicyAnalysisRequest request =
       ExportIamPolicyAnalysisRequest.newBuilder()
           .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
           .setOptions(ExportIamPolicyAnalysisRequest.Options.newBuilder().build())
           .setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build())
           .build();
   ExportIamPolicyAnalysisResponse response =
       assetServiceClient.exportIamPolicyAnalysisAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<ExportIamPolicyAnalysisResponse,ExportIamPolicyAnalysisRequest>

exportIamPolicyAnalysisCallable()

public final UnaryCallable<ExportIamPolicyAnalysisRequest,Operation> exportIamPolicyAnalysisCallable()

Exports IAM policy analysis based on the specified request. This API implements the google.longrunning.Operation API allowing you to keep track of the export. The metadata contains the request to help callers to map responses to requests.

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()) {
   ExportIamPolicyAnalysisRequest request =
       ExportIamPolicyAnalysisRequest.newBuilder()
           .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
           .setOptions(ExportIamPolicyAnalysisRequest.Options.newBuilder().build())
           .setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       assetServiceClient.exportIamPolicyAnalysisCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ExportIamPolicyAnalysisRequest,Operation>

exportIamPolicyAnalysisOperationCallable()

public final OperationCallable<ExportIamPolicyAnalysisRequest,ExportIamPolicyAnalysisResponse,ExportIamPolicyAnalysisRequest> exportIamPolicyAnalysisOperationCallable()

Exports IAM policy analysis based on the specified request. This API implements the google.longrunning.Operation API allowing you to keep track of the export. The metadata contains the request to help callers to map responses to requests.

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()) {
   ExportIamPolicyAnalysisRequest request =
       ExportIamPolicyAnalysisRequest.newBuilder()
           .setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
           .setOptions(ExportIamPolicyAnalysisRequest.Options.newBuilder().build())
           .setOutputConfig(IamPolicyAnalysisOutputConfig.newBuilder().build())
           .build();
   OperationFuture<ExportIamPolicyAnalysisResponse, ExportIamPolicyAnalysisRequest> future =
       assetServiceClient.exportIamPolicyAnalysisOperationCallable().futureCall(request);
   // Do something.
   ExportIamPolicyAnalysisResponse response = future.get();
 }
 

Returns

Type	Description
OperationCallable<ExportIamPolicyAnalysisRequest,ExportIamPolicyAnalysisResponse,ExportIamPolicyAnalysisRequest>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

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

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()