Class v1beta.QuotaAdjusterSettingsManagerClient (1.0.0)

The Quotas Adjuster Settings API is an infrastructure service for Google Cloud that lets service consumers view and update their quota adjuster settings.

  • Update quota adjuster settings. - Get the name of the configurations. v1beta

Package

@google-cloud/cloudquotas

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of QuotaAdjusterSettingsManagerClient.

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 QuotaAdjusterSettingsManagerClient({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;
    };

pathTemplates

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

port

static get port(): number;

The port for this API service.

quotaAdjusterSettingsManagerStub

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

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.

folderLocationQuotaPreferencePath(folder, location, quotaPreference)

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

Return a fully-qualified folderLocationQuotaPreference resource name string.

Parameters
Name Description
folder string
location string
quotaPreference string
Returns
Type Description
string

{string} Resource name string.

folderLocationServiceQuotaInfoPath(folder, location, service, quotaInfo)

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

Return a fully-qualified folderLocationServiceQuotaInfo resource name string.

Parameters
Name Description
folder string
location string
service string
quotaInfo string
Returns
Type Description
string

{string} Resource name string.

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

getQuotaAdjusterSettings(request, options)

getQuotaAdjusterSettings(request?: protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest, options?: CallOptions): Promise<[
        protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings,
        (protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest | undefined),
        {} | undefined
    ]>;

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
request IGetQuotaAdjusterSettingsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, (protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest | 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.
   */
  /**
   *  Required. Name of the config. Required to be “settings”, as only a single
   *  setting per container will be supported initially.
   */
  // const name = 'abc123'

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

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

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

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

  callGetQuotaAdjusterSettings();

getQuotaAdjusterSettings(request, options, callback)

getQuotaAdjusterSettings(request: protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest, options: CallOptions, callback: Callback<protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetQuotaAdjusterSettingsRequest
options CallOptions
callback Callback<protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getQuotaAdjusterSettings(request, callback)

getQuotaAdjusterSettings(request: protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest, callback: Callback<protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetQuotaAdjusterSettingsRequest
callback Callback<protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, protos.google.api.cloudquotas.v1beta.IGetQuotaAdjusterSettingsRequest | null | undefined, {} | null | 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.

matchFolderFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName)

matchFolderFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName: string): string | number;

Parse the folder from FolderLocationQuotaPreference resource.

Parameter
Name Description
folderLocationQuotaPreferenceName string

A fully-qualified path representing folder_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName)

matchFolderFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName: string): string | number;

Parse the folder from FolderLocationServiceQuotaInfo resource.

Parameter
Name Description
folderLocationServiceQuotaInfoName string

A fully-qualified path representing folder_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchLocationFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName)

matchLocationFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName: string): string | number;

Parse the location from FolderLocationQuotaPreference resource.

Parameter
Name Description
folderLocationQuotaPreferenceName string

A fully-qualified path representing folder_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName)

matchLocationFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName: string): string | number;

Parse the location from FolderLocationServiceQuotaInfo resource.

Parameter
Name Description
folderLocationServiceQuotaInfoName string

A fully-qualified path representing folder_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName)

matchLocationFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName: string): string | number;

Parse the location from OrganizationLocationQuotaPreference resource.

Parameter
Name Description
organizationLocationQuotaPreferenceName string

A fully-qualified path representing organization_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName)

matchLocationFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName: string): string | number;

Parse the location from OrganizationLocationServiceQuotaInfo resource.

Parameter
Name Description
organizationLocationServiceQuotaInfoName string

A fully-qualified path representing organization_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName)

matchLocationFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName: string): string | number;

Parse the location from ProjectLocationQuotaPreference resource.

Parameter
Name Description
projectLocationQuotaPreferenceName string

A fully-qualified path representing project_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName)

matchLocationFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName: string): string | number;

Parse the location from ProjectLocationServiceQuotaInfo resource.

Parameter
Name Description
projectLocationServiceQuotaInfoName string

A fully-qualified path representing project_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromQuotaAdjusterSettingsName(quotaAdjusterSettingsName)

matchLocationFromQuotaAdjusterSettingsName(quotaAdjusterSettingsName: string): string | number;

Parse the location from QuotaAdjusterSettings resource.

Parameter
Name Description
quotaAdjusterSettingsName string

A fully-qualified path representing QuotaAdjusterSettings resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchOrganizationFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName)

matchOrganizationFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName: string): string | number;

Parse the organization from OrganizationLocationQuotaPreference resource.

Parameter
Name Description
organizationLocationQuotaPreferenceName string

A fully-qualified path representing organization_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName)

matchOrganizationFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName: string): string | number;

Parse the organization from OrganizationLocationServiceQuotaInfo resource.

Parameter
Name Description
organizationLocationServiceQuotaInfoName string

A fully-qualified path representing organization_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchProjectFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName)

matchProjectFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName: string): string | number;

Parse the project from ProjectLocationQuotaPreference resource.

Parameter
Name Description
projectLocationQuotaPreferenceName string

A fully-qualified path representing project_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName)

matchProjectFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName: string): string | number;

Parse the project from ProjectLocationServiceQuotaInfo resource.

Parameter
Name Description
projectLocationServiceQuotaInfoName string

A fully-qualified path representing project_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromQuotaAdjusterSettingsName(quotaAdjusterSettingsName)

matchProjectFromQuotaAdjusterSettingsName(quotaAdjusterSettingsName: string): string | number;

Parse the project from QuotaAdjusterSettings resource.

Parameter
Name Description
quotaAdjusterSettingsName string

A fully-qualified path representing QuotaAdjusterSettings resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchQuotaInfoFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName)

matchQuotaInfoFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName: string): string | number;

Parse the quota_info from FolderLocationServiceQuotaInfo resource.

Parameter
Name Description
folderLocationServiceQuotaInfoName string

A fully-qualified path representing folder_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the quota_info.

matchQuotaInfoFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName)

matchQuotaInfoFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName: string): string | number;

Parse the quota_info from OrganizationLocationServiceQuotaInfo resource.

Parameter
Name Description
organizationLocationServiceQuotaInfoName string

A fully-qualified path representing organization_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the quota_info.

matchQuotaInfoFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName)

matchQuotaInfoFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName: string): string | number;

Parse the quota_info from ProjectLocationServiceQuotaInfo resource.

Parameter
Name Description
projectLocationServiceQuotaInfoName string

A fully-qualified path representing project_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the quota_info.

matchQuotaPreferenceFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName)

matchQuotaPreferenceFromFolderLocationQuotaPreferenceName(folderLocationQuotaPreferenceName: string): string | number;

Parse the quota_preference from FolderLocationQuotaPreference resource.

Parameter
Name Description
folderLocationQuotaPreferenceName string

A fully-qualified path representing folder_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the quota_preference.

matchQuotaPreferenceFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName)

matchQuotaPreferenceFromOrganizationLocationQuotaPreferenceName(organizationLocationQuotaPreferenceName: string): string | number;

Parse the quota_preference from OrganizationLocationQuotaPreference resource.

Parameter
Name Description
organizationLocationQuotaPreferenceName string

A fully-qualified path representing organization_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the quota_preference.

matchQuotaPreferenceFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName)

matchQuotaPreferenceFromProjectLocationQuotaPreferenceName(projectLocationQuotaPreferenceName: string): string | number;

Parse the quota_preference from ProjectLocationQuotaPreference resource.

Parameter
Name Description
projectLocationQuotaPreferenceName string

A fully-qualified path representing project_location_quota_preference resource.
Returns
Type Description
string | number

{string} A string representing the quota_preference.

matchServiceFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName)

matchServiceFromFolderLocationServiceQuotaInfoName(folderLocationServiceQuotaInfoName: string): string | number;

Parse the service from FolderLocationServiceQuotaInfo resource.

Parameter
Name Description
folderLocationServiceQuotaInfoName string

A fully-qualified path representing folder_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the service.

matchServiceFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName)

matchServiceFromOrganizationLocationServiceQuotaInfoName(organizationLocationServiceQuotaInfoName: string): string | number;

Parse the service from OrganizationLocationServiceQuotaInfo resource.

Parameter
Name Description
organizationLocationServiceQuotaInfoName string

A fully-qualified path representing organization_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the service.

matchServiceFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName)

matchServiceFromProjectLocationServiceQuotaInfoName(projectLocationServiceQuotaInfoName: string): string | number;

Parse the service from ProjectLocationServiceQuotaInfo resource.

Parameter
Name Description
projectLocationServiceQuotaInfoName string

A fully-qualified path representing project_location_service_quota_info resource.
Returns
Type Description
string | number

{string} A string representing the service.

organizationLocationQuotaPreferencePath(organization, location, quotaPreference)

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

Return a fully-qualified organizationLocationQuotaPreference resource name string.

Parameters
Name Description
organization string
location string
quotaPreference string
Returns
Type Description
string

{string} Resource name string.

organizationLocationServiceQuotaInfoPath(organization, location, service, quotaInfo)

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

Return a fully-qualified organizationLocationServiceQuotaInfo resource name string.

Parameters
Name Description
organization string
location string
service string
quotaInfo string
Returns
Type Description
string

{string} Resource name string.

projectLocationQuotaPreferencePath(project, location, quotaPreference)

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

Return a fully-qualified projectLocationQuotaPreference resource name string.

Parameters
Name Description
project string
location string
quotaPreference string
Returns
Type Description
string

{string} Resource name string.

projectLocationServiceQuotaInfoPath(project, location, service, quotaInfo)

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

Return a fully-qualified projectLocationServiceQuotaInfo resource name string.

Parameters
Name Description
project string
location string
service string
quotaInfo string
Returns
Type Description
string

{string} Resource name string.

quotaAdjusterSettingsPath(project, location)

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

Return a fully-qualified quotaAdjusterSettings resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

updateQuotaAdjusterSettings(request, options)

updateQuotaAdjusterSettings(request?: protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest, options?: CallOptions): Promise<[
        protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings,
        (protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest | undefined),
        {} | undefined
    ]>;

RPC Method for updating QuotaAdjusterSettings based on the request

Parameters
Name Description
request IUpdateQuotaAdjusterSettingsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, (protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest | 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.
   */
  /**
   *  Required. The QuotaAdjusterSettings to update.
   */
  // const quotaAdjusterSettings = {}
  /**
   *  Optional. The list of fields to update.
   */
  // const updateMask = {}
  /**
   *  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

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

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

  async function callUpdateQuotaAdjusterSettings() {
    // Construct request
    const request = {
      quotaAdjusterSettings,
    };

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

  callUpdateQuotaAdjusterSettings();

updateQuotaAdjusterSettings(request, options, callback)

updateQuotaAdjusterSettings(request: protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest, options: CallOptions, callback: Callback<protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateQuotaAdjusterSettingsRequest
options CallOptions
callback Callback<protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateQuotaAdjusterSettings(request, callback)

updateQuotaAdjusterSettings(request: protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest, callback: Callback<protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateQuotaAdjusterSettingsRequest
callback Callback<protos.google.api.cloudquotas.v1beta.IQuotaAdjusterSettings, protos.google.api.cloudquotas.v1beta.IUpdateQuotaAdjusterSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void