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

Type	Name	Description
ClientOptions	opts

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

pathTemplates

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

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

reservationServiceStub

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

Property Value

Type	Description
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

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

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

Property Value

Type	Description
(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

Type	Name	Description
string	project
string	location
string	reservation
string	assignment

Returns

Type	Description
string	{string} Resource name string.

biReservationPath(project, location)

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

Return a fully-qualified biReservation resource name string.

Parameters

Type	Name	Description
string	project
string	location

Returns

Type	Description
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

Type	Name	Description
string	project
string	location
string	capacityCommitment

Returns

Type	Description
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.ICreateReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest	request
CallOptions	options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest	request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest	request
CallOptions	options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest	request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest	request
CallOptions	options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest	request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.reservation.v1.IDeleteReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IGetBiReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

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

Parameter

Type	Name	Description
Callback<string, undefined, undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IGetReservationRequest | null | undefined, {} | null | undefined>	callback

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.

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest	request
CallOptions	options
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest	request
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListAssignmentsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest	request
CallOptions	options
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest	request
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest	request
CallOptions	options
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest	request
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IListReservationsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
string	project
string	location

Returns

Type	Description
string	{string} Resource name string.

matchAssignmentFromAssignmentName(assignmentName)

matchAssignmentFromAssignmentName(assignmentName: string): string | number;

Parse the assignment from Assignment resource.

Parameter

Type	Name	Description
string	assignmentName	A fully-qualified path representing Assignment resource.

Returns

Type	Description
string | number	{string} A string representing the assignment.

matchCapacityCommitmentFromCapacityCommitmentName(capacityCommitmentName)

matchCapacityCommitmentFromCapacityCommitmentName(capacityCommitmentName: string): string | number;

Parse the capacity_commitment from CapacityCommitment resource.

Parameter

Type	Name	Description
string	capacityCommitmentName	A fully-qualified path representing CapacityCommitment resource.

Returns

Type	Description
string | number	{string} A string representing the capacity_commitment.

matchLocationFromAssignmentName(assignmentName)

matchLocationFromAssignmentName(assignmentName: string): string | number;

Parse the location from Assignment resource.

Parameter

Type	Name	Description
string	assignmentName	A fully-qualified path representing Assignment resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromBiReservationName(biReservationName)

matchLocationFromBiReservationName(biReservationName: string): string | number;

Parse the location from BiReservation resource.

Parameter

Type	Name	Description
string	biReservationName	A fully-qualified path representing BiReservation resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromCapacityCommitmentName(capacityCommitmentName)

matchLocationFromCapacityCommitmentName(capacityCommitmentName: string): string | number;

Parse the location from CapacityCommitment resource.

Parameter

Type	Name	Description
string	capacityCommitmentName	A fully-qualified path representing CapacityCommitment resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Type	Name	Description
string	locationName	A fully-qualified path representing Location resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchLocationFromReservationName(reservationName)

matchLocationFromReservationName(reservationName: string): string | number;

Parse the location from Reservation resource.

Parameter

Type	Name	Description
string	reservationName	A fully-qualified path representing Reservation resource.

Returns

Type	Description
string | number	{string} A string representing the location.

matchProjectFromAssignmentName(assignmentName)

matchProjectFromAssignmentName(assignmentName: string): string | number;

Parse the project from Assignment resource.

Parameter

Type	Name	Description
string	assignmentName	A fully-qualified path representing Assignment resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromBiReservationName(biReservationName)

matchProjectFromBiReservationName(biReservationName: string): string | number;

Parse the project from BiReservation resource.

Parameter

Type	Name	Description
string	biReservationName	A fully-qualified path representing BiReservation resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromCapacityCommitmentName(capacityCommitmentName)

matchProjectFromCapacityCommitmentName(capacityCommitmentName: string): string | number;

Parse the project from CapacityCommitment resource.

Parameter

Type	Name	Description
string	capacityCommitmentName	A fully-qualified path representing CapacityCommitment resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Type	Name	Description
string	locationName	A fully-qualified path representing Location resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Type	Name	Description
string	projectName	A fully-qualified path representing Project resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchProjectFromReservationName(reservationName)

matchProjectFromReservationName(reservationName: string): string | number;

Parse the project from Reservation resource.

Parameter

Type	Name	Description
string	reservationName	A fully-qualified path representing Reservation resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchReservationFromAssignmentName(assignmentName)

matchReservationFromAssignmentName(assignmentName: string): string | number;

Parse the reservation from Assignment resource.

Parameter

Type	Name	Description
string	assignmentName	A fully-qualified path representing Assignment resource.

Returns

Type	Description
string | number	{string} A string representing the reservation.

matchReservationFromReservationName(reservationName)

matchReservationFromReservationName(reservationName: string): string | number;

Parse the reservation from Reservation resource.

Parameter

Type	Name	Description
string	reservationName	A fully-qualified path representing Reservation resource.

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.IAssignment, protos.google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Type	Name	Description
string	project

Returns

Type	Description
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

Type	Name	Description
string	project
string	location
string	reservation

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest	request
CallOptions	options
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest	request
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest	request
CallOptions	options
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest	request
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

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest	request	The request object that will be sent.
CallOptions	options	Call options. See CallOptions for more details.

Returns

Type

Description

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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentResponse, protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentResponse, protos.google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.IBiReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.ICapacityCommitment, protos.google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest	request
CallOptions	options

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest	request
CallOptions	options
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
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

Type	Name	Description
protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest	request
Callback<protos.google.cloud.bigquery.reservation.v1.IReservation, protos.google.cloud.bigquery.reservation.v1.IUpdateReservationRequest | null | undefined, {} | null | undefined>	callback

Returns

Type	Description
void