Class PolicyTroubleshooterClient (1.43.0)

GitHub RepositoryProduct Reference

Service Description: IAM Policy Troubleshooter service.

This service helps you troubleshoot access issues for Google Cloud resources.

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 (PolicyTroubleshooterClient policyTroubleshooterClient =
     PolicyTroubleshooterClient.create()) {
   TroubleshootIamPolicyRequest request =
       TroubleshootIamPolicyRequest.newBuilder()
           .setAccessTuple(AccessTuple.newBuilder().build())
           .build();
   TroubleshootIamPolicyResponse response =
       policyTroubleshooterClient.troubleshootIamPolicy(request);
 }
 

Note: close() needs to be called on the PolicyTroubleshooterClient 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

TroubleshootIamPolicy

Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • troubleshootIamPolicy(TroubleshootIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • troubleshootIamPolicyCallable()

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 PolicyTroubleshooterSettings 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
 PolicyTroubleshooterSettings policyTroubleshooterSettings =
     PolicyTroubleshooterSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PolicyTroubleshooterClient policyTroubleshooterClient =
     PolicyTroubleshooterClient.create(policyTroubleshooterSettings);
 

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
 PolicyTroubleshooterSettings policyTroubleshooterSettings =
     PolicyTroubleshooterSettings.newBuilder().setEndpoint(myEndpoint).build();
 PolicyTroubleshooterClient policyTroubleshooterClient =
     PolicyTroubleshooterClient.create(policyTroubleshooterSettings);
 

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
 PolicyTroubleshooterSettings policyTroubleshooterSettings =
     PolicyTroubleshooterSettings.newHttpJsonBuilder().build();
 PolicyTroubleshooterClient policyTroubleshooterClient =
     PolicyTroubleshooterClient.create(policyTroubleshooterSettings);
 

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

Inheritance

java.lang.Object > PolicyTroubleshooterClient

Static Methods

create()

public static final PolicyTroubleshooterClient create()

Constructs an instance of PolicyTroubleshooterClient with default settings.

Returns
Type Description
PolicyTroubleshooterClient
Exceptions
Type Description
IOException

create(PolicyTroubleshooterSettings settings)

public static final PolicyTroubleshooterClient create(PolicyTroubleshooterSettings settings)

Constructs an instance of PolicyTroubleshooterClient, 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 PolicyTroubleshooterSettings
Returns
Type Description
PolicyTroubleshooterClient
Exceptions
Type Description
IOException

create(PolicyTroubleshooterStub stub)

public static final PolicyTroubleshooterClient create(PolicyTroubleshooterStub stub)

Constructs an instance of PolicyTroubleshooterClient, using the given stub for making calls. This is for advanced usage - prefer using create(PolicyTroubleshooterSettings).

Parameter
Name Description
stub PolicyTroubleshooterStub
Returns
Type Description
PolicyTroubleshooterClient

Constructors

PolicyTroubleshooterClient(PolicyTroubleshooterSettings settings)

protected PolicyTroubleshooterClient(PolicyTroubleshooterSettings settings)

Constructs an instance of PolicyTroubleshooterClient, 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 PolicyTroubleshooterSettings

PolicyTroubleshooterClient(PolicyTroubleshooterStub stub)

protected PolicyTroubleshooterClient(PolicyTroubleshooterStub stub)
Parameter
Name Description
stub PolicyTroubleshooterStub

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 PolicyTroubleshooterSettings getSettings()
Returns
Type Description
PolicyTroubleshooterSettings

getStub()

public PolicyTroubleshooterStub getStub()
Returns
Type Description
PolicyTroubleshooterStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

troubleshootIamPolicy(TroubleshootIamPolicyRequest request)

public final TroubleshootIamPolicyResponse troubleshootIamPolicy(TroubleshootIamPolicyRequest request)

Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.

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 (PolicyTroubleshooterClient policyTroubleshooterClient =
     PolicyTroubleshooterClient.create()) {
   TroubleshootIamPolicyRequest request =
       TroubleshootIamPolicyRequest.newBuilder()
           .setAccessTuple(AccessTuple.newBuilder().build())
           .build();
   TroubleshootIamPolicyResponse response =
       policyTroubleshooterClient.troubleshootIamPolicy(request);
 }
 
Parameter
Name Description
request TroubleshootIamPolicyRequest

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

Returns
Type Description
TroubleshootIamPolicyResponse

troubleshootIamPolicyCallable()

public final UnaryCallable<TroubleshootIamPolicyRequest,TroubleshootIamPolicyResponse> troubleshootIamPolicyCallable()

Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.

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 (PolicyTroubleshooterClient policyTroubleshooterClient =
     PolicyTroubleshooterClient.create()) {
   TroubleshootIamPolicyRequest request =
       TroubleshootIamPolicyRequest.newBuilder()
           .setAccessTuple(AccessTuple.newBuilder().build())
           .build();
   ApiFuture<TroubleshootIamPolicyResponse> future =
       policyTroubleshooterClient.troubleshootIamPolicyCallable().futureCall(request);
   // Do something.
   TroubleshootIamPolicyResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<TroubleshootIamPolicyRequest,TroubleshootIamPolicyResponse>