com.google.cloud.policytroubleshooter.iam.v3

Class PolicyTroubleshooterClient

java.lang.Object

com.google.cloud.policytroubleshooter.iam.v3.PolicyTroubleshooterClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class PolicyTroubleshooterClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PolicyTroubleshooterClient(PolicyTroubleshooterSettings settings) Constructs an instance of PolicyTroubleshooterClient, using the given settings.
protected	PolicyTroubleshooterClient(PolicyTroubleshooterStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static PolicyTroubleshooterClient	create() Constructs an instance of PolicyTroubleshooterClient with default settings.
static PolicyTroubleshooterClient	create(PolicyTroubleshooterSettings settings) Constructs an instance of PolicyTroubleshooterClient, using the given settings.
static PolicyTroubleshooterClient	create(PolicyTroubleshooterStub stub) Constructs an instance of PolicyTroubleshooterClient, using the given stub for making calls.
PolicyTroubleshooterSettings	getSettings()
PolicyTroubleshooterStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
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.
com.google.api.gax.rpc.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolicyTroubleshooterClient

protected PolicyTroubleshooterClient(PolicyTroubleshooterSettings settings)
                              throws IOException

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.

Throws:

IOException

PolicyTroubleshooterClient

protected PolicyTroubleshooterClient(PolicyTroubleshooterStub stub)

Method Detail

create

public static final PolicyTroubleshooterClient create()
                                               throws IOException

Constructs an instance of PolicyTroubleshooterClient with default settings.

Throws:

IOException

create

public static final PolicyTroubleshooterClient create(PolicyTroubleshooterSettings settings)
                                               throws IOException

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.

Throws:

IOException

create

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

getSettings

public final PolicyTroubleshooterSettings getSettings()

getStub

public PolicyTroubleshooterStub getStub()

troubleshootIamPolicy

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

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

troubleshootIamPolicyCallable

public final com.google.api.gax.rpc.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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

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

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException