Class v1.ReservationServiceClient

This API allows users to manage their flat-rate BigQuery reservations.

A reservation provides computational resource guarantees, in the form of [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a unit of computational power in BigQuery, and serves as the basic unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. A reservation resource exists as a child resource of the admin project and location, e.g.: projects/myproject/locations/US/reservations/reservationName.

A capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. A capacity commitment resource exists as a child resource of the admin project and location, e.g.: projects/myproject/locations/US/capacityCommitments/id. v1

Package

@google-cloud/bigquery-reservation!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ReservationServiceClient.

Parameter
TypeNameDescription
ClientOptionsopts

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
TypeDescription
{ [name: string]: Function; }

pathTemplates

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

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

reservationServiceStub

reservationServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

warn

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

Methods

assignmentPath(project, location, reservation, assignment)

assignmentPath(project: string, location: string, reservation: string, assignment: string): string;

Return a fully-qualified assignment resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringreservation
stringassignment
Returns
TypeDescription
string

{string} Resource name string.

biReservationPath(project, location)

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

Return a fully-qualified biReservation resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
Returns
TypeDescription
string

{string} Resource name string.

capacityCommitmentPath(project, location, capacityCommitment)

capacityCommitmentPath(project: string, location: string, capacityCommitment: string): string;

Return a fully-qualified capacityCommitment resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringcapacityCommitment
Returns
TypeDescription
string

{string} Resource name string.

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createAssignment(request, options)

createAssignment(request?: protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment, (protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment, (protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest | undefined), {} | undefined]>

createAssignment(request, options, callback)

createAssignment(request: protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

createAssignment(request, callback)

createAssignment(request: protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

createCapacityCommitment(request, options)

createCapacityCommitment(request?: protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, (protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, (protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest | undefined), {} | undefined]>

createCapacityCommitment(request, options, callback)

createCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

createCapacityCommitment(request, callback)

createCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

createReservation(request, options)

createReservation(request?: protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IReservation, (protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IReservation, (protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest | undefined), {} | undefined]>

createReservation(request, options, callback)

createReservation(request: protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

createReservation(request, callback)

createReservation(request: protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

deleteAssignment(request, options)

deleteAssignment(request?: protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest | undefined), {} | undefined]>

deleteAssignment(request, options, callback)

deleteAssignment(request: protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequestrequest
CallOptionsoptions
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

deleteAssignment(request, callback)

deleteAssignment(request: protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequestrequest
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

deleteCapacityCommitment(request, options)

deleteCapacityCommitment(request?: protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest | undefined), {} | undefined]>

deleteCapacityCommitment(request, options, callback)

deleteCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequestrequest
CallOptionsoptions
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

deleteCapacityCommitment(request, callback)

deleteCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequestrequest
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

deleteReservation(request, options)

deleteReservation(request?: protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest | undefined), {} | undefined]>

deleteReservation(request, options, callback)

deleteReservation(request: protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequestrequest
CallOptionsoptions
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

deleteReservation(request, callback)

deleteReservation(request: protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequestrequest
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

getBiReservation(request, options)

getBiReservation(request?: protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IBiReservation, (protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IBiReservation, (protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest | undefined), {} | undefined]>

getBiReservation(request, options, callback)

getBiReservation(request: protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

getBiReservation(request, callback)

getBiReservation(request: protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

getCapacityCommitment(request, options)

getCapacityCommitment(request?: protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, (protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, (protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest | undefined), {} | undefined]>

getCapacityCommitment(request, options, callback)

getCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

getCapacityCommitment(request, callback)

getCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
TypeNameDescription
Callback<string, undefined, undefined>callback
Returns
TypeDescription
void

getReservation(request, options)

getReservation(request?: protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IReservation, (protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetReservationRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IReservation, (protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest | undefined), {} | undefined]>

getReservation(request, options, callback)

getReservation(request: protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetReservationRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

getReservation(request, callback)

getReservation(request: protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IGetReservationRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listAssignments(request, options)

listAssignments(request?: protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment[], protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest | null, protos.google.cloud.bigquery.reservation.v1.IListAssignmentsResponse]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment[], protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest | null, protos.google.cloud.bigquery.reservation.v1.IListAssignmentsResponse]>

listAssignments(request, options, callback)

listAssignments(request: protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.IListAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequestrequest
CallOptionsoptions
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.IListAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>callback
Returns
TypeDescription
void

listAssignments(request, callback)

listAssignments(request: protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.IListAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequestrequest
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.IListAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>callback
Returns
TypeDescription
void

listAssignmentsAsync(request, options)

listAssignmentsAsync(request?: protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.bigquery.reservation.v1.IAssignment>;

Equivalent to listAssignments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.bigquery.reservation.v1.IAssignment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Assignment]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAssignmentsStream(request, options)

listAssignmentsStream(request?: protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Assignment] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAssignmentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCapacityCommitments(request, options)

listCapacityCommitments(request?: protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment[], protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest | null, protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsResponse]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment[], protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest | null, protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsResponse]>

listCapacityCommitments(request, options, callback)

listCapacityCommitments(request: protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequestrequest
CallOptionsoptions
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment>callback
Returns
TypeDescription
void

listCapacityCommitments(request, callback)

listCapacityCommitments(request: protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequestrequest
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment>callback
Returns
TypeDescription
void

listCapacityCommitmentsAsync(request, options)

listCapacityCommitmentsAsync(request?: protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment>;

Equivalent to listCapacityCommitments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [CapacityCommitment]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCapacityCommitmentsStream(request, options)

listCapacityCommitmentsStream(request?: protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [CapacityCommitment] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCapacityCommitmentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listReservations(request, options)

listReservations(request?: protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IReservation[], protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest | null, protos.google.cloud.bigquery.reservation.v1.IListReservationsResponse]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IReservation[], protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest | null, protos.google.cloud.bigquery.reservation.v1.IListReservationsResponse]>

listReservations(request, options, callback)

listReservations(request: protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, protos.google.cloud.bigquery.reservation.v1.IListReservationsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IReservation>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequestrequest
CallOptionsoptions
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, protos.google.cloud.bigquery.reservation.v1.IListReservationsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IReservation>callback
Returns
TypeDescription
void

listReservations(request, callback)

listReservations(request: protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, protos.google.cloud.bigquery.reservation.v1.IListReservationsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IReservation>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequestrequest
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, protos.google.cloud.bigquery.reservation.v1.IListReservationsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IReservation>callback
Returns
TypeDescription
void

listReservationsAsync(request, options)

listReservationsAsync(request?: protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.bigquery.reservation.v1.IReservation>;

Equivalent to listReservations, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.bigquery.reservation.v1.IReservation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Reservation]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listReservationsStream(request, options)

listReservationsStream(request?: protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Reservation] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listReservationsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
Returns
TypeDescription
string

{string} Resource name string.

matchAssignmentFromAssignmentName(assignmentName)

matchAssignmentFromAssignmentName(assignmentName: string): string | number;

Parse the assignment from Assignment resource.

Parameter
TypeNameDescription
stringassignmentName

A fully-qualified path representing Assignment resource.

Returns
TypeDescription
string | number

{string} A string representing the assignment.

matchCapacityCommitmentFromCapacityCommitmentName(capacityCommitmentName)

matchCapacityCommitmentFromCapacityCommitmentName(capacityCommitmentName: string): string | number;

Parse the capacity_commitment from CapacityCommitment resource.

Parameter
TypeNameDescription
stringcapacityCommitmentName

A fully-qualified path representing CapacityCommitment resource.

Returns
TypeDescription
string | number

{string} A string representing the capacity_commitment.

matchLocationFromAssignmentName(assignmentName)

matchLocationFromAssignmentName(assignmentName: string): string | number;

Parse the location from Assignment resource.

Parameter
TypeNameDescription
stringassignmentName

A fully-qualified path representing Assignment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromBiReservationName(biReservationName)

matchLocationFromBiReservationName(biReservationName: string): string | number;

Parse the location from BiReservation resource.

Parameter
TypeNameDescription
stringbiReservationName

A fully-qualified path representing BiReservation resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCapacityCommitmentName(capacityCommitmentName)

matchLocationFromCapacityCommitmentName(capacityCommitmentName: string): string | number;

Parse the location from CapacityCommitment resource.

Parameter
TypeNameDescription
stringcapacityCommitmentName

A fully-qualified path representing CapacityCommitment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
TypeNameDescription
stringlocationName

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromReservationName(reservationName)

matchLocationFromReservationName(reservationName: string): string | number;

Parse the location from Reservation resource.

Parameter
TypeNameDescription
stringreservationName

A fully-qualified path representing Reservation resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromAssignmentName(assignmentName)

matchProjectFromAssignmentName(assignmentName: string): string | number;

Parse the project from Assignment resource.

Parameter
TypeNameDescription
stringassignmentName

A fully-qualified path representing Assignment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromBiReservationName(biReservationName)

matchProjectFromBiReservationName(biReservationName: string): string | number;

Parse the project from BiReservation resource.

Parameter
TypeNameDescription
stringbiReservationName

A fully-qualified path representing BiReservation resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCapacityCommitmentName(capacityCommitmentName)

matchProjectFromCapacityCommitmentName(capacityCommitmentName: string): string | number;

Parse the project from CapacityCommitment resource.

Parameter
TypeNameDescription
stringcapacityCommitmentName

A fully-qualified path representing CapacityCommitment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
TypeNameDescription
stringlocationName

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
TypeNameDescription
stringprojectName

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromReservationName(reservationName)

matchProjectFromReservationName(reservationName: string): string | number;

Parse the project from Reservation resource.

Parameter
TypeNameDescription
stringreservationName

A fully-qualified path representing Reservation resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchReservationFromAssignmentName(assignmentName)

matchReservationFromAssignmentName(assignmentName: string): string | number;

Parse the reservation from Assignment resource.

Parameter
TypeNameDescription
stringassignmentName

A fully-qualified path representing Assignment resource.

Returns
TypeDescription
string | number

{string} A string representing the reservation.

matchReservationFromReservationName(reservationName)

matchReservationFromReservationName(reservationName: string): string | number;

Parse the reservation from Reservation resource.

Parameter
TypeNameDescription
stringreservationName

A fully-qualified path representing Reservation resource.

Returns
TypeDescription
string | number

{string} A string representing the reservation.

mergeCapacityCommitments(request, options)

mergeCapacityCommitments(request?: protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, (protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, (protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest | undefined), {} | undefined]>

mergeCapacityCommitments(request, options, callback)

mergeCapacityCommitments(request: protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

mergeCapacityCommitments(request, callback)

mergeCapacityCommitments(request: protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

moveAssignment(request, options)

moveAssignment(request?: protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment, (protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment, (protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest | undefined), {} | undefined]>

moveAssignment(request, options, callback)

moveAssignment(request: protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

moveAssignment(request, callback)

moveAssignment(request: protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
TypeNameDescription
stringproject
Returns
TypeDescription
string

{string} Resource name string.

reservationPath(project, location, reservation)

reservationPath(project: string, location: string, reservation: string): string;

Return a fully-qualified reservation resource name string.

Parameters
TypeNameDescription
stringproject
stringlocation
stringreservation
Returns
TypeDescription
string

{string} Resource name string.

searchAllAssignments(request, options)

searchAllAssignments(request?: protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment[], protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest | null, protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsResponse]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment[], protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest | null, protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsResponse]>

searchAllAssignments(request, options, callback)

searchAllAssignments(request: protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequestrequest
CallOptionsoptions
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>callback
Returns
TypeDescription
void

searchAllAssignments(request, callback)

searchAllAssignments(request: protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequestrequest
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>callback
Returns
TypeDescription
void

searchAllAssignmentsAsync(request, options)

searchAllAssignmentsAsync(request?: protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.bigquery.reservation.v1.IAssignment>;

Equivalent to searchAllAssignments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.bigquery.reservation.v1.IAssignment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Assignment]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchAllAssignmentsStream(request, options)

searchAllAssignmentsStream(request?: protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Assignment] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using searchAllAssignmentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchAssignments(request, options)

searchAssignments(request?: protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment[], protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest | null, protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsResponse]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IAssignment[], protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest | null, protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsResponse]>

searchAssignments(request, options, callback)

searchAssignments(request: protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequestrequest
CallOptionsoptions
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>callback
Returns
TypeDescription
void

searchAssignments(request, callback)

searchAssignments(request: protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, callback: PaginationCallback<protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequestrequest
PaginationCallback<protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsResponse | null | undefined, protos.google.cloud.bigquery.reservation.v1.IAssignment>callback
Returns
TypeDescription
void

searchAssignmentsAsync(request, options)

searchAssignmentsAsync(request?: protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.bigquery.reservation.v1.IAssignment>;

Equivalent to searchAssignments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.bigquery.reservation.v1.IAssignment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Assignment]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchAssignmentsStream(request, options)

searchAssignmentsStream(request?: protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequestrequest

The request object that will be sent.

CallOptionsoptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Assignment] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using searchAssignmentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

splitCapacityCommitment(request, options)

splitCapacityCommitment(request?: protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentResponse, (protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentResponse, (protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest | undefined), {} | undefined]>

splitCapacityCommitment(request, options, callback)

splitCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentResponse, protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentResponse, protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

splitCapacityCommitment(request, callback)

splitCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentResponse, protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentResponse, protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

updateBiReservation(request, options)

updateBiReservation(request?: protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IBiReservation, (protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IBiReservation, (protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest | undefined), {} | undefined]>

updateBiReservation(request, options, callback)

updateBiReservation(request: protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

updateBiReservation(request, callback)

updateBiReservation(request: protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

updateCapacityCommitment(request, options)

updateCapacityCommitment(request?: protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, (protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, (protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest | undefined), {} | undefined]>

updateCapacityCommitment(request, options, callback)

updateCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

updateCapacityCommitment(request, callback)

updateCapacityCommitment(request: protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

updateReservation(request, options)

updateReservation(request?: protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest, options?: CallOptions): Promise<[protos.google.cloud.bigquery.reservation.v1.IReservation, (protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest | undefined), {} | undefined]>;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[protos.google.cloud.bigquery.reservation.v1.IReservation, (protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest | undefined), {} | undefined]>

updateReservation(request, options, callback)

updateReservation(request: protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequestrequest
CallOptionsoptions
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

updateReservation(request, callback)

updateReservation(request: protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest, callback: Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequestrequest
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void