Class v1.AccessApprovalClient (3.2.0)

Package

Constructors

(constructor)(opts, gaxInstance)

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

Properties

accessApprovalStub

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

apiEndpoint

get apiEndpoint(): string;

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

universeDomain

get universeDomain(): string;

warn

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

Methods

approveApprovalRequest(request, options)

approveApprovalRequest(request?: protos.google.cloud.accessapproval.v1.IApproveApprovalRequestMessage, options?: CallOptions): Promise<[
        protos.google.cloud.accessapproval.v1.IApprovalRequest,
        (protos.google.cloud.accessapproval.v1.IApproveApprovalRequestMessage | undefined),
        {} | undefined
    ]>;

  /**
   * 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.
   */
  /**
   *  Name of the approval request to approve.
   */
  // const name = 'abc123'
  /**
   *  The expiration time of this approval.
   */
  // const expireTime = {}

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const response = await accessapprovalClient.approveApprovalRequest(request);
    console.log(response);
  }

  callApproveApprovalRequest();

approveApprovalRequest(request, options, callback)

approveApprovalRequest(request: protos.google.cloud.accessapproval.v1.IApproveApprovalRequestMessage, options: CallOptions, callback: Callback<protos.google.cloud.accessapproval.v1.IApprovalRequest, protos.google.cloud.accessapproval.v1.IApproveApprovalRequestMessage | null | undefined, {} | null | undefined>): void;

approveApprovalRequest(request, callback)

approveApprovalRequest(request: protos.google.cloud.accessapproval.v1.IApproveApprovalRequestMessage, callback: Callback<protos.google.cloud.accessapproval.v1.IApprovalRequest, protos.google.cloud.accessapproval.v1.IApproveApprovalRequestMessage | null | undefined, {} | null | undefined>): void;

close()

close(): Promise<void>;

deleteAccessApprovalSettings(request, options)

deleteAccessApprovalSettings(request?: protos.google.cloud.accessapproval.v1.IDeleteAccessApprovalSettingsMessage, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.accessapproval.v1.IDeleteAccessApprovalSettingsMessage | undefined),
        {} | undefined
    ]>;

  /**
   * 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.
   */
  /**
   *  Name of the AccessApprovalSettings to delete.
   */
  // const name = 'abc123'

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const response = await accessapprovalClient.deleteAccessApprovalSettings(request);
    console.log(response);
  }

  callDeleteAccessApprovalSettings();

deleteAccessApprovalSettings(request, options, callback)

deleteAccessApprovalSettings(request: protos.google.cloud.accessapproval.v1.IDeleteAccessApprovalSettingsMessage, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.accessapproval.v1.IDeleteAccessApprovalSettingsMessage | null | undefined, {} | null | undefined>): void;

deleteAccessApprovalSettings(request, callback)

deleteAccessApprovalSettings(request: protos.google.cloud.accessapproval.v1.IDeleteAccessApprovalSettingsMessage, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.accessapproval.v1.IDeleteAccessApprovalSettingsMessage | null | undefined, {} | null | undefined>): void;

dismissApprovalRequest(request, options)

dismissApprovalRequest(request?: protos.google.cloud.accessapproval.v1.IDismissApprovalRequestMessage, options?: CallOptions): Promise<[
        protos.google.cloud.accessapproval.v1.IApprovalRequest,
        (protos.google.cloud.accessapproval.v1.IDismissApprovalRequestMessage | undefined),
        {} | undefined
    ]>;

  /**
   * 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.
   */
  /**
   *  Name of the ApprovalRequest to dismiss.
   */
  // const name = 'abc123'

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const response = await accessapprovalClient.dismissApprovalRequest(request);
    console.log(response);
  }

  callDismissApprovalRequest();

dismissApprovalRequest(request, options, callback)

dismissApprovalRequest(request: protos.google.cloud.accessapproval.v1.IDismissApprovalRequestMessage, options: CallOptions, callback: Callback<protos.google.cloud.accessapproval.v1.IApprovalRequest, protos.google.cloud.accessapproval.v1.IDismissApprovalRequestMessage | null | undefined, {} | null | undefined>): void;

dismissApprovalRequest(request, callback)

dismissApprovalRequest(request: protos.google.cloud.accessapproval.v1.IDismissApprovalRequestMessage, callback: Callback<protos.google.cloud.accessapproval.v1.IApprovalRequest, protos.google.cloud.accessapproval.v1.IDismissApprovalRequestMessage | null | undefined, {} | null | undefined>): void;

folderAccessApprovalSettingsPath(folder)

folderAccessApprovalSettingsPath(folder: string): string;

folderApprovalRequestPath(folder, approvalRequest)

folderApprovalRequestPath(folder: string, approvalRequest: string): string;

folderServiceAccountPath(folder)

folderServiceAccountPath(folder: string): string;

getAccessApprovalServiceAccount(request, options)

getAccessApprovalServiceAccount(request?: protos.google.cloud.accessapproval.v1.IGetAccessApprovalServiceAccountMessage, options?: CallOptions): Promise<[
        protos.google.cloud.accessapproval.v1.IAccessApprovalServiceAccount,
        (protos.google.cloud.accessapproval.v1.IGetAccessApprovalServiceAccountMessage | undefined),
        {} | undefined
    ]>;

  /**
   * 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.
   */
  /**
   *  Name of the AccessApprovalServiceAccount to retrieve.
   */
  // const name = 'abc123'

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const response = await accessapprovalClient.getAccessApprovalServiceAccount(request);
    console.log(response);
  }

  callGetAccessApprovalServiceAccount();

getAccessApprovalServiceAccount(request, options, callback)

getAccessApprovalServiceAccount(request: protos.google.cloud.accessapproval.v1.IGetAccessApprovalServiceAccountMessage, options: CallOptions, callback: Callback<protos.google.cloud.accessapproval.v1.IAccessApprovalServiceAccount, protos.google.cloud.accessapproval.v1.IGetAccessApprovalServiceAccountMessage | null | undefined, {} | null | undefined>): void;

getAccessApprovalServiceAccount(request, callback)

getAccessApprovalServiceAccount(request: protos.google.cloud.accessapproval.v1.IGetAccessApprovalServiceAccountMessage, callback: Callback<protos.google.cloud.accessapproval.v1.IAccessApprovalServiceAccount, protos.google.cloud.accessapproval.v1.IGetAccessApprovalServiceAccountMessage | null | undefined, {} | null | undefined>): void;

getAccessApprovalSettings(request, options)

getAccessApprovalSettings(request?: protos.google.cloud.accessapproval.v1.IGetAccessApprovalSettingsMessage, options?: CallOptions): Promise<[
        protos.google.cloud.accessapproval.v1.IAccessApprovalSettings,
        (protos.google.cloud.accessapproval.v1.IGetAccessApprovalSettingsMessage | undefined),
        {} | undefined
    ]>;

  /**
   * 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 name of the AccessApprovalSettings to retrieve.
   *  Format: "{projects|folders|organizations}/{id}/accessApprovalSettings"
   */
  // const name = 'abc123'

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const response = await accessapprovalClient.getAccessApprovalSettings(request);
    console.log(response);
  }

  callGetAccessApprovalSettings();

getAccessApprovalSettings(request, options, callback)

getAccessApprovalSettings(request: protos.google.cloud.accessapproval.v1.IGetAccessApprovalSettingsMessage, options: CallOptions, callback: Callback<protos.google.cloud.accessapproval.v1.IAccessApprovalSettings, protos.google.cloud.accessapproval.v1.IGetAccessApprovalSettingsMessage | null | undefined, {} | null | undefined>): void;

getAccessApprovalSettings(request, callback)

getAccessApprovalSettings(request: protos.google.cloud.accessapproval.v1.IGetAccessApprovalSettingsMessage, callback: Callback<protos.google.cloud.accessapproval.v1.IAccessApprovalSettings, protos.google.cloud.accessapproval.v1.IGetAccessApprovalSettingsMessage | null | undefined, {} | null | undefined>): void;

getApprovalRequest(request, options)

getApprovalRequest(request?: protos.google.cloud.accessapproval.v1.IGetApprovalRequestMessage, options?: CallOptions): Promise<[
        protos.google.cloud.accessapproval.v1.IApprovalRequest,
        (protos.google.cloud.accessapproval.v1.IGetApprovalRequestMessage | undefined),
        {} | undefined
    ]>;

  /**
   * 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 name of the approval request to retrieve.
   *  Format:
   *  "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"
   */
  // const name = 'abc123'

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const response = await accessapprovalClient.getApprovalRequest(request);
    console.log(response);
  }

  callGetApprovalRequest();

getApprovalRequest(request, options, callback)

getApprovalRequest(request: protos.google.cloud.accessapproval.v1.IGetApprovalRequestMessage, options: CallOptions, callback: Callback<protos.google.cloud.accessapproval.v1.IApprovalRequest, protos.google.cloud.accessapproval.v1.IGetApprovalRequestMessage | null | undefined, {} | null | undefined>): void;

getApprovalRequest(request, callback)

getApprovalRequest(request: protos.google.cloud.accessapproval.v1.IGetApprovalRequestMessage, callback: Callback<protos.google.cloud.accessapproval.v1.IApprovalRequest, protos.google.cloud.accessapproval.v1.IGetApprovalRequestMessage | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

initialize()

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

invalidateApprovalRequest(request, options)

invalidateApprovalRequest(request?: protos.google.cloud.accessapproval.v1.IInvalidateApprovalRequestMessage, options?: CallOptions): Promise<[
        protos.google.cloud.accessapproval.v1.IApprovalRequest,
        (protos.google.cloud.accessapproval.v1.IInvalidateApprovalRequestMessage | undefined),
        {} | undefined
    ]>;

  /**
   * 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.
   */
  /**
   *  Name of the ApprovalRequest to invalidate.
   */
  // const name = 'abc123'

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const response = await accessapprovalClient.invalidateApprovalRequest(request);
    console.log(response);
  }

  callInvalidateApprovalRequest();

invalidateApprovalRequest(request, options, callback)

invalidateApprovalRequest(request: protos.google.cloud.accessapproval.v1.IInvalidateApprovalRequestMessage, options: CallOptions, callback: Callback<protos.google.cloud.accessapproval.v1.IApprovalRequest, protos.google.cloud.accessapproval.v1.IInvalidateApprovalRequestMessage | null | undefined, {} | null | undefined>): void;

invalidateApprovalRequest(request, callback)

invalidateApprovalRequest(request: protos.google.cloud.accessapproval.v1.IInvalidateApprovalRequestMessage, callback: Callback<protos.google.cloud.accessapproval.v1.IApprovalRequest, protos.google.cloud.accessapproval.v1.IInvalidateApprovalRequestMessage | null | undefined, {} | null | undefined>): void;

listApprovalRequests(request, options)

listApprovalRequests(request?: protos.google.cloud.accessapproval.v1.IListApprovalRequestsMessage, options?: CallOptions): Promise<[
        protos.google.cloud.accessapproval.v1.IApprovalRequest[],
        protos.google.cloud.accessapproval.v1.IListApprovalRequestsMessage | null,
        protos.google.cloud.accessapproval.v1.IListApprovalRequestsResponse
    ]>;

listApprovalRequests(request, options, callback)

listApprovalRequests(request: protos.google.cloud.accessapproval.v1.IListApprovalRequestsMessage, options: CallOptions, callback: PaginationCallback<protos.google.cloud.accessapproval.v1.IListApprovalRequestsMessage, protos.google.cloud.accessapproval.v1.IListApprovalRequestsResponse | null | undefined, protos.google.cloud.accessapproval.v1.IApprovalRequest>): void;

listApprovalRequests(request, callback)

listApprovalRequests(request: protos.google.cloud.accessapproval.v1.IListApprovalRequestsMessage, callback: PaginationCallback<protos.google.cloud.accessapproval.v1.IListApprovalRequestsMessage, protos.google.cloud.accessapproval.v1.IListApprovalRequestsResponse | null | undefined, protos.google.cloud.accessapproval.v1.IApprovalRequest>): void;

listApprovalRequestsAsync(request, options)

listApprovalRequestsAsync(request?: protos.google.cloud.accessapproval.v1.IListApprovalRequestsMessage, options?: CallOptions): AsyncIterable<protos.google.cloud.accessapproval.v1.IApprovalRequest>;

  /**
   * 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 parent resource. This may be "projects/{project}",
   *  "folders/{folder}", or "organizations/{organization}".
   */
  // const parent = 'abc123'
  /**
   *  A filter on the type of approval requests to retrieve. Must be one of the
   *  following values:
   *    * not set: Requests that are pending or have active approvals.
   *    * ALL: All requests.
   *    * PENDING: Only pending requests.
   *    * ACTIVE: Only active (i.e. currently approved) requests.
   *    * DISMISSED: Only requests that have been dismissed, or requests that
   *      are not approved and past expiration.
   *    * EXPIRED: Only requests that have been approved, and the approval has
   *      expired.
   *    * HISTORY: Active, dismissed and expired requests.
   */
  // const filter = 'abc123'
  /**
   *  Requested page size.
   */
  // const pageSize = 1234
  /**
   *  A token identifying the page of results to return.
   */
  // const pageToken = 'abc123'

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const iterable = accessapprovalClient.listApprovalRequestsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListApprovalRequests();

listApprovalRequestsStream(request, options)

listApprovalRequestsStream(request?: protos.google.cloud.accessapproval.v1.IListApprovalRequestsMessage, options?: CallOptions): Transform;

matchApprovalRequestFromFolderApprovalRequestName(folderApprovalRequestName)

matchApprovalRequestFromFolderApprovalRequestName(folderApprovalRequestName: string): string | number;

matchApprovalRequestFromOrganizationApprovalRequestName(organizationApprovalRequestName)

matchApprovalRequestFromOrganizationApprovalRequestName(organizationApprovalRequestName: string): string | number;

matchApprovalRequestFromProjectApprovalRequestName(projectApprovalRequestName)

matchApprovalRequestFromProjectApprovalRequestName(projectApprovalRequestName: string): string | number;

matchFolderFromFolderAccessApprovalSettingsName(folderAccessApprovalSettingsName)

matchFolderFromFolderAccessApprovalSettingsName(folderAccessApprovalSettingsName: string): string | number;

matchFolderFromFolderApprovalRequestName(folderApprovalRequestName)

matchFolderFromFolderApprovalRequestName(folderApprovalRequestName: string): string | number;

matchFolderFromFolderServiceAccountName(folderServiceAccountName)

matchFolderFromFolderServiceAccountName(folderServiceAccountName: string): string | number;

matchOrganizationFromOrganizationAccessApprovalSettingsName(organizationAccessApprovalSettingsName)

matchOrganizationFromOrganizationAccessApprovalSettingsName(organizationAccessApprovalSettingsName: string): string | number;

matchOrganizationFromOrganizationApprovalRequestName(organizationApprovalRequestName)

matchOrganizationFromOrganizationApprovalRequestName(organizationApprovalRequestName: string): string | number;

matchOrganizationFromOrganizationServiceAccountName(organizationServiceAccountName)

matchOrganizationFromOrganizationServiceAccountName(organizationServiceAccountName: string): string | number;

matchProjectFromProjectAccessApprovalSettingsName(projectAccessApprovalSettingsName)

matchProjectFromProjectAccessApprovalSettingsName(projectAccessApprovalSettingsName: string): string | number;

matchProjectFromProjectApprovalRequestName(projectApprovalRequestName)

matchProjectFromProjectApprovalRequestName(projectApprovalRequestName: string): string | number;

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

matchProjectFromProjectServiceAccountName(projectServiceAccountName)

matchProjectFromProjectServiceAccountName(projectServiceAccountName: string): string | number;

organizationAccessApprovalSettingsPath(organization)

organizationAccessApprovalSettingsPath(organization: string): string;

organizationApprovalRequestPath(organization, approvalRequest)

organizationApprovalRequestPath(organization: string, approvalRequest: string): string;

organizationServiceAccountPath(organization)

organizationServiceAccountPath(organization: string): string;

projectAccessApprovalSettingsPath(project)

projectAccessApprovalSettingsPath(project: string): string;

projectApprovalRequestPath(project, approvalRequest)

projectApprovalRequestPath(project: string, approvalRequest: string): string;

projectPath(project)

projectPath(project: string): string;

projectServiceAccountPath(project)

projectServiceAccountPath(project: string): string;

updateAccessApprovalSettings(request, options)

updateAccessApprovalSettings(request?: protos.google.cloud.accessapproval.v1.IUpdateAccessApprovalSettingsMessage, options?: CallOptions): Promise<[
        protos.google.cloud.accessapproval.v1.IAccessApprovalSettings,
        (protos.google.cloud.accessapproval.v1.IUpdateAccessApprovalSettingsMessage | undefined),
        {} | undefined
    ]>;

  /**
   * 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 new AccessApprovalSettings.
   */
  // const settings = {}
  /**
   *  The update mask applies to the settings. Only the top level fields of
   *  AccessApprovalSettings (notification_emails & enrolled_services) are
   *  supported. For each field, if it is included, the currently stored value
   *  will be entirely overwritten with the value of the field passed in this
   *  request.
   *  For the `FieldMask` definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
   *  If this field is left unset, only the notification_emails field will be
   *  updated.
   */
  // const updateMask = {}

  // Imports the Accessapproval library
  const {AccessApprovalClient} = require('@google-cloud/access-approval').v1;

  // Instantiates a client
  const accessapprovalClient = new AccessApprovalClient();

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

    // Run request
    const response = await accessapprovalClient.updateAccessApprovalSettings(request);
    console.log(response);
  }

  callUpdateAccessApprovalSettings();

updateAccessApprovalSettings(request, options, callback)

updateAccessApprovalSettings(request: protos.google.cloud.accessapproval.v1.IUpdateAccessApprovalSettingsMessage, options: CallOptions, callback: Callback<protos.google.cloud.accessapproval.v1.IAccessApprovalSettings, protos.google.cloud.accessapproval.v1.IUpdateAccessApprovalSettingsMessage | null | undefined, {} | null | undefined>): void;

updateAccessApprovalSettings(request, callback)

updateAccessApprovalSettings(request: protos.google.cloud.accessapproval.v1.IUpdateAccessApprovalSettingsMessage, callback: Callback<protos.google.cloud.accessapproval.v1.IAccessApprovalSettings, protos.google.cloud.accessapproval.v1.IUpdateAccessApprovalSettingsMessage | null | undefined, {} | null | undefined>): void;