Class v3.PolicyTroubleshooterClient (0.6.1)

IAM Policy Troubleshooter service.

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

Package

@google-cloud/policy-troubleshooter-iam

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of PolicyTroubleshooterClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new PolicyTroubleshooterClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

policyTroubleshooterStub

policyTroubleshooterStub?: Promise<{
        [name: string]: Function;
    }>;

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

troubleshootIamPolicy(request, options)

troubleshootIamPolicy(request?: protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyResponse,
        (protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest | undefined),
        {} | undefined
    ]>;

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

Parameters
Name Description
request ITroubleshootIamPolicyRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyResponse, (protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The information to use for checking whether a principal has a permission
   *  for a resource.
   */
  // const accessTuple = {}

  // Imports the Iam library
  const {PolicyTroubleshooterClient} = require('@google-cloud/iam').v3;

  // Instantiates a client
  const iamClient = new PolicyTroubleshooterClient();

  async function callTroubleshootIamPolicy() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await iamClient.troubleshootIamPolicy(request);
    console.log(response);
  }

  callTroubleshootIamPolicy();

troubleshootIamPolicy(request, options, callback)

troubleshootIamPolicy(request: protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyResponse, protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ITroubleshootIamPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyResponse, protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

troubleshootIamPolicy(request, callback)

troubleshootIamPolicy(request: protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest, callback: Callback<protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyResponse, protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ITroubleshootIamPolicyRequest
callback Callback<protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyResponse, protos.google.cloud.policytroubleshooter.iam.v3.ITroubleshootIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void