Skip to main content

BindBillableObject

Binds billable object to the specified billing account.

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const BillableObjectBinding =
  cloudApi.billing.billable_object.BillableObjectBinding;
const BindBillableObjectRequest =
  cloudApi.billing.billing_account_service.BindBillableObjectRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.BillingAccountServiceClient);

  const operation = await client.bindBillableObject(
    BindBillableObjectRequest.fromPartial({
      billingAccountId: "billingAccountId",
      // billableObject: {
      // id: "id",
      // type: "type"
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof BillableObjectBinding>(
      finishedOp.response
    );
    console.log(result);
  }
})();

BindBillableObjectRequest​

billingAccountId : string​

ID of the billing account to bind billable object. To get the billing account ID, use BillingAccountService.List request.

billableObject : BillableObject​

yandex.cloud.billing.v1.BillableObject to bind with billing account.

BillableObject​

Represents a link to an object in other service. This object is being billed in the scope of a billing account.

id : string​

ID of the object in other service.

type : string​

Billable object type. Can be one of the following:

  • cloud

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any​

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result​

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any​
    The normal response of the operation in case of success.

    If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.