Class protos.google.cloud.bigquery.reservation.v1.ReservationService (3.5.0)

Represents a ReservationService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.bigquery.reservation.v1.ReservationService

Package

@google-cloud/bigquery-reservation

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ReservationService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ReservationService;

Creates new ReservationService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
ReservationService

RPC service. Useful where requests and/or responses are streamed.

createAssignment(request, callback)

public createAssignment(request: google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignmentCallback): void;

Calls CreateAssignment.

Parameters
Name Description
request ICreateAssignmentRequest

CreateAssignmentRequest message or plain object
callback CreateAssignmentCallback

Node-style callback called with the error, if any, and Assignment
Returns
Type Description
void

createAssignment(request)

public createAssignment(request: google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest): Promise<google.cloud.bigquery.reservation.v1.Assignment>;

Calls CreateAssignment.

Parameter
Name Description
request ICreateAssignmentRequest

CreateAssignmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.Assignment>

Promise

createCapacityCommitment(request, callback)

public createCapacityCommitment(request: google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitmentCallback): void;

Calls CreateCapacityCommitment.

Parameters
Name Description
request ICreateCapacityCommitmentRequest

CreateCapacityCommitmentRequest message or plain object
callback CreateCapacityCommitmentCallback

Node-style callback called with the error, if any, and CapacityCommitment
Returns
Type Description
void

createCapacityCommitment(request)

public createCapacityCommitment(request: google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest): Promise<google.cloud.bigquery.reservation.v1.CapacityCommitment>;

Calls CreateCapacityCommitment.

Parameter
Name Description
request ICreateCapacityCommitmentRequest

CreateCapacityCommitmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.CapacityCommitment>

Promise

createReservation(request, callback)

public createReservation(request: google.cloud.bigquery.reservation.v1.ICreateReservationRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationCallback): void;

Calls CreateReservation.

Parameters
Name Description
request ICreateReservationRequest

CreateReservationRequest message or plain object
callback CreateReservationCallback

Node-style callback called with the error, if any, and Reservation
Returns
Type Description
void

createReservation(request)

public createReservation(request: google.cloud.bigquery.reservation.v1.ICreateReservationRequest): Promise<google.cloud.bigquery.reservation.v1.Reservation>;

Calls CreateReservation.

Parameter
Name Description
request ICreateReservationRequest

CreateReservationRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.Reservation>

Promise

deleteAssignment(request, callback)

public deleteAssignment(request: google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignmentCallback): void;

Calls DeleteAssignment.

Parameters
Name Description
request IDeleteAssignmentRequest

DeleteAssignmentRequest message or plain object
callback DeleteAssignmentCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteAssignment(request)

public deleteAssignment(request: google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest): Promise<google.protobuf.Empty>;

Calls DeleteAssignment.

Parameter
Name Description
request IDeleteAssignmentRequest

DeleteAssignmentRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteCapacityCommitment(request, callback)

public deleteCapacityCommitment(request: google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitmentCallback): void;

Calls DeleteCapacityCommitment.

Parameters
Name Description
request IDeleteCapacityCommitmentRequest

DeleteCapacityCommitmentRequest message or plain object
callback DeleteCapacityCommitmentCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteCapacityCommitment(request)

public deleteCapacityCommitment(request: google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest): Promise<google.protobuf.Empty>;

Calls DeleteCapacityCommitment.

Parameter
Name Description
request IDeleteCapacityCommitmentRequest

DeleteCapacityCommitmentRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteReservation(request, callback)

public deleteReservation(request: google.cloud.bigquery.reservation.v1.IDeleteReservationRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationCallback): void;

Calls DeleteReservation.

Parameters
Name Description
request IDeleteReservationRequest

DeleteReservationRequest message or plain object
callback DeleteReservationCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteReservation(request)

public deleteReservation(request: google.cloud.bigquery.reservation.v1.IDeleteReservationRequest): Promise<google.protobuf.Empty>;

Calls DeleteReservation.

Parameter
Name Description
request IDeleteReservationRequest

DeleteReservationRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

failoverReservation(request, callback)

public failoverReservation(request: google.cloud.bigquery.reservation.v1.IFailoverReservationRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservationCallback): void;

Calls FailoverReservation.

Parameters
Name Description
request IFailoverReservationRequest

FailoverReservationRequest message or plain object
callback FailoverReservationCallback

Node-style callback called with the error, if any, and Reservation
Returns
Type Description
void

failoverReservation(request)

public failoverReservation(request: google.cloud.bigquery.reservation.v1.IFailoverReservationRequest): Promise<google.cloud.bigquery.reservation.v1.Reservation>;

Calls FailoverReservation.

Parameter
Name Description
request IFailoverReservationRequest

FailoverReservationRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.Reservation>

Promise

getBiReservation(request, callback)

public getBiReservation(request: google.cloud.bigquery.reservation.v1.IGetBiReservationRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservationCallback): void;

Calls GetBiReservation.

Parameters
Name Description
request IGetBiReservationRequest

GetBiReservationRequest message or plain object
callback GetBiReservationCallback

Node-style callback called with the error, if any, and BiReservation
Returns
Type Description
void

getBiReservation(request)

public getBiReservation(request: google.cloud.bigquery.reservation.v1.IGetBiReservationRequest): Promise<google.cloud.bigquery.reservation.v1.BiReservation>;

Calls GetBiReservation.

Parameter
Name Description
request IGetBiReservationRequest

GetBiReservationRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.BiReservation>

Promise

getCapacityCommitment(request, callback)

public getCapacityCommitment(request: google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitmentCallback): void;

Calls GetCapacityCommitment.

Parameters
Name Description
request IGetCapacityCommitmentRequest

GetCapacityCommitmentRequest message or plain object
callback GetCapacityCommitmentCallback

Node-style callback called with the error, if any, and CapacityCommitment
Returns
Type Description
void

getCapacityCommitment(request)

public getCapacityCommitment(request: google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest): Promise<google.cloud.bigquery.reservation.v1.CapacityCommitment>;

Calls GetCapacityCommitment.

Parameter
Name Description
request IGetCapacityCommitmentRequest

GetCapacityCommitmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.CapacityCommitment>

Promise

getReservation(request, callback)

public getReservation(request: google.cloud.bigquery.reservation.v1.IGetReservationRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.GetReservationCallback): void;

Calls GetReservation.

Parameters
Name Description
request IGetReservationRequest

GetReservationRequest message or plain object
callback GetReservationCallback

Node-style callback called with the error, if any, and Reservation
Returns
Type Description
void

getReservation(request)

public getReservation(request: google.cloud.bigquery.reservation.v1.IGetReservationRequest): Promise<google.cloud.bigquery.reservation.v1.Reservation>;

Calls GetReservation.

Parameter
Name Description
request IGetReservationRequest

GetReservationRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.Reservation>

Promise

listAssignments(request, callback)

public listAssignments(request: google.cloud.bigquery.reservation.v1.IListAssignmentsRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.ListAssignmentsCallback): void;

Calls ListAssignments.

Parameters
Name Description
request IListAssignmentsRequest

ListAssignmentsRequest message or plain object
callback ListAssignmentsCallback

Node-style callback called with the error, if any, and ListAssignmentsResponse
Returns
Type Description
void

listAssignments(request)

public listAssignments(request: google.cloud.bigquery.reservation.v1.IListAssignmentsRequest): Promise<google.cloud.bigquery.reservation.v1.ListAssignmentsResponse>;

Calls ListAssignments.

Parameter
Name Description
request IListAssignmentsRequest

ListAssignmentsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.ListAssignmentsResponse>

Promise

listCapacityCommitments(request, callback)

public listCapacityCommitments(request: google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitmentsCallback): void;

Calls ListCapacityCommitments.

Parameters
Name Description
request IListCapacityCommitmentsRequest

ListCapacityCommitmentsRequest message or plain object
callback ListCapacityCommitmentsCallback

Node-style callback called with the error, if any, and ListCapacityCommitmentsResponse
Returns
Type Description
void

listCapacityCommitments(request)

public listCapacityCommitments(request: google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest): Promise<google.cloud.bigquery.reservation.v1.ListCapacityCommitmentsResponse>;

Calls ListCapacityCommitments.

Parameter
Name Description
request IListCapacityCommitmentsRequest

ListCapacityCommitmentsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.ListCapacityCommitmentsResponse>

Promise

listReservations(request, callback)

public listReservations(request: google.cloud.bigquery.reservation.v1.IListReservationsRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.ListReservationsCallback): void;

Calls ListReservations.

Parameters
Name Description
request IListReservationsRequest

ListReservationsRequest message or plain object
callback ListReservationsCallback

Node-style callback called with the error, if any, and ListReservationsResponse
Returns
Type Description
void

listReservations(request)

public listReservations(request: google.cloud.bigquery.reservation.v1.IListReservationsRequest): Promise<google.cloud.bigquery.reservation.v1.ListReservationsResponse>;

Calls ListReservations.

Parameter
Name Description
request IListReservationsRequest

ListReservationsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.ListReservationsResponse>

Promise

mergeCapacityCommitments(request, callback)

public mergeCapacityCommitments(request: google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitmentsCallback): void;

Calls MergeCapacityCommitments.

Parameters
Name Description
request IMergeCapacityCommitmentsRequest

MergeCapacityCommitmentsRequest message or plain object
callback MergeCapacityCommitmentsCallback

Node-style callback called with the error, if any, and CapacityCommitment
Returns
Type Description
void

mergeCapacityCommitments(request)

public mergeCapacityCommitments(request: google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest): Promise<google.cloud.bigquery.reservation.v1.CapacityCommitment>;

Calls MergeCapacityCommitments.

Parameter
Name Description
request IMergeCapacityCommitmentsRequest

MergeCapacityCommitmentsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.CapacityCommitment>

Promise

moveAssignment(request, callback)

public moveAssignment(request: google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignmentCallback): void;

Calls MoveAssignment.

Parameters
Name Description
request IMoveAssignmentRequest

MoveAssignmentRequest message or plain object
callback MoveAssignmentCallback

Node-style callback called with the error, if any, and Assignment
Returns
Type Description
void

moveAssignment(request)

public moveAssignment(request: google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest): Promise<google.cloud.bigquery.reservation.v1.Assignment>;

Calls MoveAssignment.

Parameter
Name Description
request IMoveAssignmentRequest

MoveAssignmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.Assignment>

Promise

searchAllAssignments(request, callback)

public searchAllAssignments(request: google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignmentsCallback): void;

Calls SearchAllAssignments.

Parameters
Name Description
request ISearchAllAssignmentsRequest

SearchAllAssignmentsRequest message or plain object
callback SearchAllAssignmentsCallback

Node-style callback called with the error, if any, and SearchAllAssignmentsResponse
Returns
Type Description
void

searchAllAssignments(request)

public searchAllAssignments(request: google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest): Promise<google.cloud.bigquery.reservation.v1.SearchAllAssignmentsResponse>;

Calls SearchAllAssignments.

Parameter
Name Description
request ISearchAllAssignmentsRequest

SearchAllAssignmentsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.SearchAllAssignmentsResponse>

Promise

searchAssignments(request, callback)

public searchAssignments(request: google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignmentsCallback): void;

Calls SearchAssignments.

Parameters
Name Description
request ISearchAssignmentsRequest

SearchAssignmentsRequest message or plain object
callback SearchAssignmentsCallback

Node-style callback called with the error, if any, and SearchAssignmentsResponse
Returns
Type Description
void

searchAssignments(request)

public searchAssignments(request: google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest): Promise<google.cloud.bigquery.reservation.v1.SearchAssignmentsResponse>;

Calls SearchAssignments.

Parameter
Name Description
request ISearchAssignmentsRequest

SearchAssignmentsRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.SearchAssignmentsResponse>

Promise

splitCapacityCommitment(request, callback)

public splitCapacityCommitment(request: google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitmentCallback): void;

Calls SplitCapacityCommitment.

Parameters
Name Description
request ISplitCapacityCommitmentRequest

SplitCapacityCommitmentRequest message or plain object
callback SplitCapacityCommitmentCallback

Node-style callback called with the error, if any, and SplitCapacityCommitmentResponse
Returns
Type Description
void

splitCapacityCommitment(request)

public splitCapacityCommitment(request: google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest): Promise<google.cloud.bigquery.reservation.v1.SplitCapacityCommitmentResponse>;

Calls SplitCapacityCommitment.

Parameter
Name Description
request ISplitCapacityCommitmentRequest

SplitCapacityCommitmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.SplitCapacityCommitmentResponse>

Promise

updateAssignment(request, callback)

public updateAssignment(request: google.cloud.bigquery.reservation.v1.IUpdateAssignmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignmentCallback): void;

Calls UpdateAssignment.

Parameters
Name Description
request IUpdateAssignmentRequest

UpdateAssignmentRequest message or plain object
callback UpdateAssignmentCallback

Node-style callback called with the error, if any, and Assignment
Returns
Type Description
void

updateAssignment(request)

public updateAssignment(request: google.cloud.bigquery.reservation.v1.IUpdateAssignmentRequest): Promise<google.cloud.bigquery.reservation.v1.Assignment>;

Calls UpdateAssignment.

Parameter
Name Description
request IUpdateAssignmentRequest

UpdateAssignmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.Assignment>

Promise

updateBiReservation(request, callback)

public updateBiReservation(request: google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservationCallback): void;

Calls UpdateBiReservation.

Parameters
Name Description
request IUpdateBiReservationRequest

UpdateBiReservationRequest message or plain object
callback UpdateBiReservationCallback

Node-style callback called with the error, if any, and BiReservation
Returns
Type Description
void

updateBiReservation(request)

public updateBiReservation(request: google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest): Promise<google.cloud.bigquery.reservation.v1.BiReservation>;

Calls UpdateBiReservation.

Parameter
Name Description
request IUpdateBiReservationRequest

UpdateBiReservationRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.BiReservation>

Promise

updateCapacityCommitment(request, callback)

public updateCapacityCommitment(request: google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitmentCallback): void;

Calls UpdateCapacityCommitment.

Parameters
Name Description
request IUpdateCapacityCommitmentRequest

UpdateCapacityCommitmentRequest message or plain object
callback UpdateCapacityCommitmentCallback

Node-style callback called with the error, if any, and CapacityCommitment
Returns
Type Description
void

updateCapacityCommitment(request)

public updateCapacityCommitment(request: google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest): Promise<google.cloud.bigquery.reservation.v1.CapacityCommitment>;

Calls UpdateCapacityCommitment.

Parameter
Name Description
request IUpdateCapacityCommitmentRequest

UpdateCapacityCommitmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.CapacityCommitment>

Promise

updateReservation(request, callback)

public updateReservation(request: google.cloud.bigquery.reservation.v1.IUpdateReservationRequest, callback: google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservationCallback): void;

Calls UpdateReservation.

Parameters
Name Description
request IUpdateReservationRequest

UpdateReservationRequest message or plain object
callback UpdateReservationCallback

Node-style callback called with the error, if any, and Reservation
Returns
Type Description
void

updateReservation(request)

public updateReservation(request: google.cloud.bigquery.reservation.v1.IUpdateReservationRequest): Promise<google.cloud.bigquery.reservation.v1.Reservation>;

Calls UpdateReservation.

Parameter
Name Description
request IUpdateReservationRequest

UpdateReservationRequest message or plain object
Returns
Type Description
Promise<google.cloud.bigquery.reservation.v1.Reservation>

Promise