Class v1beta1.BudgetServiceClient (4.2.2)

Package

Constructors

(constructor)(opts, gaxInstance)

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

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

budgetServiceStub

budgetServiceStub?: 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

billingAccountPath(billingAccount)

billingAccountPath(billingAccount: string): string;

budgetPath(billingAccount, budget)

budgetPath(billingAccount: string, budget: string): string;

close()

close(): Promise<void>;

createBudget(request, options)

createBudget(request?: protos.google.cloud.billing.budgets.v1beta1.ICreateBudgetRequest, options?: CallOptions): Promise<[
        protos.google.cloud.billing.budgets.v1beta1.IBudget,
        (protos.google.cloud.billing.budgets.v1beta1.ICreateBudgetRequest | 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 name of the billing account to create the budget in. Values
   *  are of the form `billingAccounts/{billingAccountId}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Budget to create.
   */
  // const budget = {}

  // Imports the Budgets library
  const {BudgetServiceClient} = require('@google-cloud/billing-budgets').v1beta1;

  // Instantiates a client
  const budgetsClient = new BudgetServiceClient();

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

    // Run request
    const response = await budgetsClient.createBudget(request);
    console.log(response);
  }

  callCreateBudget();

createBudget(request, options, callback)

createBudget(request: protos.google.cloud.billing.budgets.v1beta1.ICreateBudgetRequest, options: CallOptions, callback: Callback<protos.google.cloud.billing.budgets.v1beta1.IBudget, protos.google.cloud.billing.budgets.v1beta1.ICreateBudgetRequest | null | undefined, {} | null | undefined>): void;

createBudget(request, callback)

createBudget(request: protos.google.cloud.billing.budgets.v1beta1.ICreateBudgetRequest, callback: Callback<protos.google.cloud.billing.budgets.v1beta1.IBudget, protos.google.cloud.billing.budgets.v1beta1.ICreateBudgetRequest | null | undefined, {} | null | undefined>): void;

deleteBudget(request, options)

deleteBudget(request?: protos.google.cloud.billing.budgets.v1beta1.IDeleteBudgetRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.billing.budgets.v1beta1.IDeleteBudgetRequest | 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 budget to delete. Values are of the form
   *  `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
   */
  // const name = 'abc123'

  // Imports the Budgets library
  const {BudgetServiceClient} = require('@google-cloud/billing-budgets').v1beta1;

  // Instantiates a client
  const budgetsClient = new BudgetServiceClient();

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

    // Run request
    const response = await budgetsClient.deleteBudget(request);
    console.log(response);
  }

  callDeleteBudget();

deleteBudget(request, options, callback)

deleteBudget(request: protos.google.cloud.billing.budgets.v1beta1.IDeleteBudgetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.billing.budgets.v1beta1.IDeleteBudgetRequest | null | undefined, {} | null | undefined>): void;

deleteBudget(request, callback)

deleteBudget(request: protos.google.cloud.billing.budgets.v1beta1.IDeleteBudgetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.billing.budgets.v1beta1.IDeleteBudgetRequest | null | undefined, {} | null | undefined>): void;

getBudget(request, options)

getBudget(request?: protos.google.cloud.billing.budgets.v1beta1.IGetBudgetRequest, options?: CallOptions): Promise<[
        protos.google.cloud.billing.budgets.v1beta1.IBudget,
        protos.google.cloud.billing.budgets.v1beta1.IGetBudgetRequest | 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 budget to get. Values are of the form
   *  `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
   */
  // const name = 'abc123'

  // Imports the Budgets library
  const {BudgetServiceClient} = require('@google-cloud/billing-budgets').v1beta1;

  // Instantiates a client
  const budgetsClient = new BudgetServiceClient();

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

    // Run request
    const response = await budgetsClient.getBudget(request);
    console.log(response);
  }

  callGetBudget();

getBudget(request, options, callback)

getBudget(request: protos.google.cloud.billing.budgets.v1beta1.IGetBudgetRequest, options: CallOptions, callback: Callback<protos.google.cloud.billing.budgets.v1beta1.IBudget, protos.google.cloud.billing.budgets.v1beta1.IGetBudgetRequest | null | undefined, {} | null | undefined>): void;

getBudget(request, callback)

getBudget(request: protos.google.cloud.billing.budgets.v1beta1.IGetBudgetRequest, callback: Callback<protos.google.cloud.billing.budgets.v1beta1.IBudget, protos.google.cloud.billing.budgets.v1beta1.IGetBudgetRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

initialize()

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

listBudgets(request, options)

listBudgets(request?: protos.google.cloud.billing.budgets.v1beta1.IListBudgetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.billing.budgets.v1beta1.IBudget[],
        protos.google.cloud.billing.budgets.v1beta1.IListBudgetsRequest | null,
        protos.google.cloud.billing.budgets.v1beta1.IListBudgetsResponse
    ]>;

listBudgets(request, options, callback)

listBudgets(request: protos.google.cloud.billing.budgets.v1beta1.IListBudgetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.billing.budgets.v1beta1.IListBudgetsRequest, protos.google.cloud.billing.budgets.v1beta1.IListBudgetsResponse | null | undefined, protos.google.cloud.billing.budgets.v1beta1.IBudget>): void;

listBudgets(request, callback)

listBudgets(request: protos.google.cloud.billing.budgets.v1beta1.IListBudgetsRequest, callback: PaginationCallback<protos.google.cloud.billing.budgets.v1beta1.IListBudgetsRequest, protos.google.cloud.billing.budgets.v1beta1.IListBudgetsResponse | null | undefined, protos.google.cloud.billing.budgets.v1beta1.IBudget>): void;

listBudgetsAsync(request, options)

listBudgetsAsync(request?: protos.google.cloud.billing.budgets.v1beta1.IListBudgetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.billing.budgets.v1beta1.IBudget>;

  /**
   * 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 billing account to list budgets under. Values
   *  are of the form `billingAccounts/{billingAccountId}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of budgets to return per page.
   *  The default and maximum value are 100.
   */
  // const pageSize = 1234
  /**
   *  Optional. The value returned by the last `ListBudgetsResponse` which
   *  indicates that this is a continuation of a prior `ListBudgets` call,
   *  and that the system should return the next page of data.
   */
  // const pageToken = 'abc123'

  // Imports the Budgets library
  const {BudgetServiceClient} = require('@google-cloud/billing-budgets').v1beta1;

  // Instantiates a client
  const budgetsClient = new BudgetServiceClient();

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

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

  callListBudgets();

listBudgetsStream(request, options)

listBudgetsStream(request?: protos.google.cloud.billing.budgets.v1beta1.IListBudgetsRequest, options?: CallOptions): Transform;

matchBillingAccountFromBillingAccountName(billingAccountName)

matchBillingAccountFromBillingAccountName(billingAccountName: string): string | number;

matchBillingAccountFromBudgetName(budgetName)

matchBillingAccountFromBudgetName(budgetName: string): string | number;

matchBudgetFromBudgetName(budgetName)

matchBudgetFromBudgetName(budgetName: string): string | number;

updateBudget(request, options)

updateBudget(request?: protos.google.cloud.billing.budgets.v1beta1.IUpdateBudgetRequest, options?: CallOptions): Promise<[
        protos.google.cloud.billing.budgets.v1beta1.IBudget,
        (protos.google.cloud.billing.budgets.v1beta1.IUpdateBudgetRequest | 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 updated budget object.
   *  The budget to update is specified by the budget name in the budget.
   */
  // const budget = {}
  /**
   *  Optional. Indicates which fields in the provided budget to update.
   *  Read-only fields (such as `name`) cannot be changed. If this is not
   *  provided, then only fields with non-default values from the request are
   *  updated. See
   *  https://developers.google.com/protocol-buffers/docs/proto3#default for more
   *  details about default values.
   */
  // const updateMask = {}

  // Imports the Budgets library
  const {BudgetServiceClient} = require('@google-cloud/billing-budgets').v1beta1;

  // Instantiates a client
  const budgetsClient = new BudgetServiceClient();

  async function callUpdateBudget() {
    // Construct request
    const request = {
      budget,
    };

    // Run request
    const response = await budgetsClient.updateBudget(request);
    console.log(response);
  }

  callUpdateBudget();

updateBudget(request, options, callback)

updateBudget(request: protos.google.cloud.billing.budgets.v1beta1.IUpdateBudgetRequest, options: CallOptions, callback: Callback<protos.google.cloud.billing.budgets.v1beta1.IBudget, protos.google.cloud.billing.budgets.v1beta1.IUpdateBudgetRequest | null | undefined, {} | null | undefined>): void;

updateBudget(request, callback)

updateBudget(request: protos.google.cloud.billing.budgets.v1beta1.IUpdateBudgetRequest, callback: Callback<protos.google.cloud.billing.budgets.v1beta1.IBudget, protos.google.cloud.billing.budgets.v1beta1.IUpdateBudgetRequest | null | undefined, {} | null | undefined>): void;