Class v1.CloudQuotasClient (0.1.0)

Package

Constructors

(constructor)(opts, gaxInstance)

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

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

cloudQuotasStub

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

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;

warn

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

Methods

close()

close(): Promise<void>;

createQuotaPreference(request, options)

createQuotaPreference(request?: protos.google.api.cloudquotas.v1.ICreateQuotaPreferenceRequest, options?: CallOptions): Promise<[
        protos.google.api.cloudquotas.v1.IQuotaPreference,
        (protos.google.api.cloudquotas.v1.ICreateQuotaPreferenceRequest | 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.
   */
  /**
   *  Required. Value for parent.
   *  Example:
   *  `projects/123/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  Optional. Id of the requesting object, must be unique under its parent.
   *  If client does not set this field, the service will generate one.
   */
  // const quotaPreferenceId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const quotaPreference = {}
  /**
   *  The list of quota safety checks to be ignored.
   */
  // const ignoreSafetyChecks = [1,2,3,4]

  // Imports the Cloudquotas library
  const {CloudQuotasClient} = require('@google-cloud/cloudquotas').v1;

  // Instantiates a client
  const cloudquotasClient = new CloudQuotasClient();

  async function callCreateQuotaPreference() {
    // Construct request
    const request = {
      parent,
      quotaPreference,
    };

    // Run request
    const response = await cloudquotasClient.createQuotaPreference(request);
    console.log(response);
  }

  callCreateQuotaPreference();

createQuotaPreference(request, options, callback)

createQuotaPreference(request: protos.google.api.cloudquotas.v1.ICreateQuotaPreferenceRequest, options: CallOptions, callback: Callback<protos.google.api.cloudquotas.v1.IQuotaPreference, protos.google.api.cloudquotas.v1.ICreateQuotaPreferenceRequest | null | undefined, {} | null | undefined>): void;

createQuotaPreference(request, callback)

createQuotaPreference(request: protos.google.api.cloudquotas.v1.ICreateQuotaPreferenceRequest, callback: Callback<protos.google.api.cloudquotas.v1.IQuotaPreference, protos.google.api.cloudquotas.v1.ICreateQuotaPreferenceRequest | null | undefined, {} | null | undefined>): void;

folderLocationQuotaPreferencePath(folder, location, quotaPreference)

folderLocationQuotaPreferencePath(folder: string, location: string, quotaPreference: string): string;

folderLocationServiceQuotaInfoPath(folder, location, service, quotaInfo)

folderLocationServiceQuotaInfoPath(folder: string, location: string, service: string, quotaInfo: string): string;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

getQuotaInfo(request, options)

getQuotaInfo(request?: protos.google.api.cloudquotas.v1.IGetQuotaInfoRequest, options?: CallOptions): Promise<[
        protos.google.api.cloudquotas.v1.IQuotaInfo,
        protos.google.api.cloudquotas.v1.IGetQuotaInfoRequest | 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.
   */
  /**
   *  Required. The resource name of the quota info.
   *  An example name:
   *  `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`
   */
  // const name = 'abc123'

  // Imports the Cloudquotas library
  const {CloudQuotasClient} = require('@google-cloud/cloudquotas').v1;

  // Instantiates a client
  const cloudquotasClient = new CloudQuotasClient();

  async function callGetQuotaInfo() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await cloudquotasClient.getQuotaInfo(request);
    console.log(response);
  }

  callGetQuotaInfo();

getQuotaInfo(request, options, callback)

getQuotaInfo(request: protos.google.api.cloudquotas.v1.IGetQuotaInfoRequest, options: CallOptions, callback: Callback<protos.google.api.cloudquotas.v1.IQuotaInfo, protos.google.api.cloudquotas.v1.IGetQuotaInfoRequest | null | undefined, {} | null | undefined>): void;

getQuotaInfo(request, callback)

getQuotaInfo(request: protos.google.api.cloudquotas.v1.IGetQuotaInfoRequest, callback: Callback<protos.google.api.cloudquotas.v1.IQuotaInfo, protos.google.api.cloudquotas.v1.IGetQuotaInfoRequest | null | undefined, {} | null | undefined>): void;

getQuotaPreference(request, options)

getQuotaPreference(request?: protos.google.api.cloudquotas.v1.IGetQuotaPreferenceRequest, options?: CallOptions): Promise<[
        protos.google.api.cloudquotas.v1.IQuotaPreference,
        protos.google.api.cloudquotas.v1.IGetQuotaPreferenceRequest | 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.
   */
  /**
   *  Required. Name of the resource
   *  Example name:
   *  `projects/123/locations/global/quota_preferences/my-config-for-us-east1`
   */
  // const name = 'abc123'

  // Imports the Cloudquotas library
  const {CloudQuotasClient} = require('@google-cloud/cloudquotas').v1;

  // Instantiates a client
  const cloudquotasClient = new CloudQuotasClient();

  async function callGetQuotaPreference() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await cloudquotasClient.getQuotaPreference(request);
    console.log(response);
  }

  callGetQuotaPreference();

getQuotaPreference(request, options, callback)

getQuotaPreference(request: protos.google.api.cloudquotas.v1.IGetQuotaPreferenceRequest, options: CallOptions, callback: Callback<protos.google.api.cloudquotas.v1.IQuotaPreference, protos.google.api.cloudquotas.v1.IGetQuotaPreferenceRequest | null | undefined, {} | null | undefined>): void;

getQuotaPreference(request, callback)

getQuotaPreference(request: protos.google.api.cloudquotas.v1.IGetQuotaPreferenceRequest, callback: Callback<protos.google.api.cloudquotas.v1.IQuotaPreference, protos.google.api.cloudquotas.v1.IGetQuotaPreferenceRequest | null | undefined, {} | null | undefined>): void;

initialize()

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

listQuotaInfos(request, options)

listQuotaInfos(request?: protos.google.api.cloudquotas.v1.IListQuotaInfosRequest, options?: CallOptions): Promise<[
        protos.google.api.cloudquotas.v1.IQuotaInfo[],
        protos.google.api.cloudquotas.v1.IListQuotaInfosRequest | null,
        protos.google.api.cloudquotas.v1.IListQuotaInfosResponse
    ]>;

listQuotaInfos(request, options, callback)

listQuotaInfos(request: protos.google.api.cloudquotas.v1.IListQuotaInfosRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.cloudquotas.v1.IListQuotaInfosRequest, protos.google.api.cloudquotas.v1.IListQuotaInfosResponse | null | undefined, protos.google.api.cloudquotas.v1.IQuotaInfo>): void;

listQuotaInfos(request, callback)

listQuotaInfos(request: protos.google.api.cloudquotas.v1.IListQuotaInfosRequest, callback: PaginationCallback<protos.google.api.cloudquotas.v1.IListQuotaInfosRequest, protos.google.api.cloudquotas.v1.IListQuotaInfosResponse | null | undefined, protos.google.api.cloudquotas.v1.IQuotaInfo>): void;

listQuotaInfosAsync(request, options)

listQuotaInfosAsync(request?: protos.google.api.cloudquotas.v1.IListQuotaInfosRequest, options?: CallOptions): AsyncIterable<protos.google.api.cloudquotas.v1.IQuotaInfo>;

  /**
   * 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.
   */
  /**
   *  Required. Parent value of QuotaInfo resources.
   *  Listing across different resource containers (such as 'projects/-') is not
   *  allowed.
   *  Example names:
   *  `projects/123/locations/global/services/compute.googleapis.com`
   *  `folders/234/locations/global/services/compute.googleapis.com`
   *  `organizations/345/locations/global/services/compute.googleapis.com`
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. Server may return fewer items than
   *  requested. If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Cloudquotas library
  const {CloudQuotasClient} = require('@google-cloud/cloudquotas').v1;

  // Instantiates a client
  const cloudquotasClient = new CloudQuotasClient();

  async function callListQuotaInfos() {
    // Construct request
    const request = {
      parent,
    };

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

  callListQuotaInfos();

listQuotaInfosStream(request, options)

listQuotaInfosStream(request?: protos.google.api.cloudquotas.v1.IListQuotaInfosRequest, options?: CallOptions): Transform;

listQuotaPreferences(request, options)

listQuotaPreferences(request?: protos.google.api.cloudquotas.v1.IListQuotaPreferencesRequest, options?: CallOptions): Promise<[
        protos.google.api.cloudquotas.v1.IQuotaPreference[],
        protos.google.api.cloudquotas.v1.IListQuotaPreferencesRequest | null,
        protos.google.api.cloudquotas.v1.IListQuotaPreferencesResponse
    ]>;

listQuotaPreferences(request, options, callback)

listQuotaPreferences(request: protos.google.api.cloudquotas.v1.IListQuotaPreferencesRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.cloudquotas.v1.IListQuotaPreferencesRequest, protos.google.api.cloudquotas.v1.IListQuotaPreferencesResponse | null | undefined, protos.google.api.cloudquotas.v1.IQuotaPreference>): void;

listQuotaPreferences(request, callback)

listQuotaPreferences(request: protos.google.api.cloudquotas.v1.IListQuotaPreferencesRequest, callback: PaginationCallback<protos.google.api.cloudquotas.v1.IListQuotaPreferencesRequest, protos.google.api.cloudquotas.v1.IListQuotaPreferencesResponse | null | undefined, protos.google.api.cloudquotas.v1.IQuotaPreference>): void;

listQuotaPreferencesAsync(request, options)

listQuotaPreferencesAsync(request?: protos.google.api.cloudquotas.v1.IListQuotaPreferencesRequest, options?: CallOptions): AsyncIterable<protos.google.api.cloudquotas.v1.IQuotaPreference>;

  /**
   * 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.
   */
  /**
   *  Required. Parent value of QuotaPreference resources.
   *  Listing across different resource containers (such as 'projects/-') is not
   *  allowed.
   *  When the value starts with 'folders' or 'organizations', it lists the
   *  QuotaPreferences for org quotas in the container. It does not list the
   *  QuotaPreferences in the descendant projects of the container.
   *  Example parents:
   *  `projects/123/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. Server may return fewer items than
   *  requested. If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter result QuotaPreferences by their state, type,
   *  create/update time range.
   *  Example filters:
   *  `state=PENDING OR state=PENDING_PARTIALLY_GRANTED`
   *  `state=PENDING OR state=PENDING_PARTIALLY_GRANTED AND
   *   creation_time>2022-12-03T10:30:00`
   *  If no filter is provided, returns all pending quota preferences.
   */
  // const filter = 'abc123'
  /**
   *  Optional. How to order of the results. By default, the results are ordered
   *  by create time.
   *  Example orders:
   *  `type`
   *  `state, create_time`
   */
  // const orderBy = 'abc123'

  // Imports the Cloudquotas library
  const {CloudQuotasClient} = require('@google-cloud/cloudquotas').v1;

  // Instantiates a client
  const cloudquotasClient = new CloudQuotasClient();

  async function callListQuotaPreferences() {
    // Construct request
    const request = {
      parent,
    };

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

  callListQuotaPreferences();

listQuotaPreferencesStream(request, options)

listQuotaPreferencesStream(request?: protos.google.api.cloudquotas.v1.IListQuotaPreferencesRequest, options?: CallOptions): Transform;

matchFolderFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName)

matchFolderFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName: string): string | number;

matchFolderFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName)

matchFolderFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName: string): string | number;

matchLocationFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName)

matchLocationFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName: string): string | number;

matchLocationFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName)

matchLocationFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName: string): string | number;

matchLocationFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName)

matchLocationFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName: string): string | number;

matchLocationFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName)

matchLocationFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName: string): string | number;

matchLocationFromProjectLocationName(projectLocationName)

matchLocationFromProjectLocationName(projectLocationName: string): string | number;

matchLocationFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName)

matchLocationFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName: string): string | number;

matchLocationFromProjectLocationServiceName(projectLocationServiceName)

matchLocationFromProjectLocationServiceName(projectLocationServiceName: string): string | number;

matchLocationFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName)

matchLocationFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName: string): string | number;

matchOrganizationFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName)

matchOrganizationFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName: string): string | number;

matchOrganizationFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName)

matchOrganizationFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName: string): string | number;

matchProjectFromProjectLocationName(projectLocationName)

matchProjectFromProjectLocationName(projectLocationName: string): string | number;

matchProjectFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName)

matchProjectFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName: string): string | number;

matchProjectFromProjectLocationServiceName(projectLocationServiceName)

matchProjectFromProjectLocationServiceName(projectLocationServiceName: string): string | number;

matchProjectFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName)

matchProjectFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName: string): string | number;

matchQuotaInfoFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName)

matchQuotaInfoFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName: string): string | number;

matchQuotaInfoFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName)

matchQuotaInfoFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName: string): string | number;

matchQuotaInfoFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName)

matchQuotaInfoFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName: string): string | number;

matchQuotaPreferenceFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName)

matchQuotaPreferenceFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName: string): string | number;

matchQuotaPreferenceFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName)

matchQuotaPreferenceFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName: string): string | number;

matchQuotaPreferenceFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName)

matchQuotaPreferenceFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName: string): string | number;

matchServiceFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName)

matchServiceFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName: string): string | number;

matchServiceFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName)

matchServiceFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName: string): string | number;

matchServiceFromProjectLocationServiceName(projectLocationServiceName)

matchServiceFromProjectLocationServiceName(projectLocationServiceName: string): string | number;

matchServiceFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName)

matchServiceFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName: string): string | number;

organizationLocationQuotaPreferencePath(organization, location, quotaPreference)

organizationLocationQuotaPreferencePath(organization: string, location: string, quotaPreference: string): string;

organizationLocationServiceQuotaInfoPath(organization, location, service, quotaInfo)

organizationLocationServiceQuotaInfoPath(organization: string, location: string, service: string, quotaInfo: string): string;

projectLocationPath(project, location)

projectLocationPath(project: string, location: string): string;

projectLocationQuotaPreferencePath(project, location, quotaPreference)

projectLocationQuotaPreferencePath(project: string, location: string, quotaPreference: string): string;

projectLocationServicePath(project, location, service)

projectLocationServicePath(project: string, location: string, service: string): string;

projectLocationServiceQuotaInfoPath(project, location, service, quotaInfo)

projectLocationServiceQuotaInfoPath(project: string, location: string, service: string, quotaInfo: string): string;

updateQuotaPreference(request, options)

updateQuotaPreference(request?: protos.google.api.cloudquotas.v1.IUpdateQuotaPreferenceRequest, options?: CallOptions): Promise<[
        protos.google.api.cloudquotas.v1.IQuotaPreference,
        (protos.google.api.cloudquotas.v1.IUpdateQuotaPreferenceRequest | 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.
   */
  /**
   *  Optional. Field mask is used to specify the fields to be overwritten in the
   *  QuotaPreference resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated
   */
  // const quotaPreference = {}
  /**
   *  Optional. If set to true, and the quota preference is not found, a new one
   *  will be created. In this situation, `update_mask` is ignored.
   */
  // const allowMissing = true
  /**
   *  Optional. If set to true, validate the request, but do not actually update.
   *  Note that a request being valid does not mean that the request is
   *  guaranteed to be fulfilled.
   */
  // const validateOnly = true
  /**
   *  The list of quota safety checks to be ignored.
   */
  // const ignoreSafetyChecks = [1,2,3,4]

  // Imports the Cloudquotas library
  const {CloudQuotasClient} = require('@google-cloud/cloudquotas').v1;

  // Instantiates a client
  const cloudquotasClient = new CloudQuotasClient();

  async function callUpdateQuotaPreference() {
    // Construct request
    const request = {
      quotaPreference,
    };

    // Run request
    const response = await cloudquotasClient.updateQuotaPreference(request);
    console.log(response);
  }

  callUpdateQuotaPreference();

updateQuotaPreference(request, options, callback)

updateQuotaPreference(request: protos.google.api.cloudquotas.v1.IUpdateQuotaPreferenceRequest, options: CallOptions, callback: Callback<protos.google.api.cloudquotas.v1.IQuotaPreference, protos.google.api.cloudquotas.v1.IUpdateQuotaPreferenceRequest | null | undefined, {} | null | undefined>): void;

updateQuotaPreference(request, callback)

updateQuotaPreference(request: protos.google.api.cloudquotas.v1.IUpdateQuotaPreferenceRequest, callback: Callback<protos.google.api.cloudquotas.v1.IQuotaPreference, protos.google.api.cloudquotas.v1.IUpdateQuotaPreferenceRequest | null | undefined, {} | null | undefined>): void;