ReservationService

google.cloud.bigquery.reservation.v1. ReservationService

Represents a ReservationService

Constructor

new ReservationService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new ReservationService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createAssignment(request, callback) → {undefined}

Calls CreateAssignment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest

CreateAssignmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignmentCallback

Node-style callback called with the error, if any, and Assignment

Returns:
Type Description
undefined

createAssignment(request) → {Promise.<google.cloud.bigquery.reservation.v1.Assignment>}

Calls CreateAssignment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest

CreateAssignmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.Assignment>

Promise

createCapacityCommitment(request, callback) → {undefined}

Calls CreateCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest

CreateCapacityCommitmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitmentCallback

Node-style callback called with the error, if any, and CapacityCommitment

Returns:
Type Description
undefined

createCapacityCommitment(request) → {Promise.<google.cloud.bigquery.reservation.v1.CapacityCommitment>}

Calls CreateCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ICreateCapacityCommitmentRequest

CreateCapacityCommitmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.CapacityCommitment>

Promise

createReservation(request, callback) → {undefined}

Calls CreateReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ICreateReservationRequest

CreateReservationRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationCallback

Node-style callback called with the error, if any, and Reservation

Returns:
Type Description
undefined

createReservation(request) → {Promise.<google.cloud.bigquery.reservation.v1.Reservation>}

Calls CreateReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ICreateReservationRequest

CreateReservationRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.Reservation>

Promise

deleteAssignment(request, callback) → {undefined}

Calls DeleteAssignment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest

DeleteAssignmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignmentCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteAssignment(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteAssignment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IDeleteAssignmentRequest

DeleteAssignmentRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteCapacityCommitment(request, callback) → {undefined}

Calls DeleteCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest

DeleteCapacityCommitmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitmentCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteCapacityCommitment(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IDeleteCapacityCommitmentRequest

DeleteCapacityCommitmentRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteReservation(request, callback) → {undefined}

Calls DeleteReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IDeleteReservationRequest

DeleteReservationRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteReservation(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IDeleteReservationRequest

DeleteReservationRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getBiReservation(request, callback) → {undefined}

Calls GetBiReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IGetBiReservationRequest

GetBiReservationRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservationCallback

Node-style callback called with the error, if any, and BiReservation

Returns:
Type Description
undefined

getBiReservation(request) → {Promise.<google.cloud.bigquery.reservation.v1.BiReservation>}

Calls GetBiReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IGetBiReservationRequest

GetBiReservationRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.BiReservation>

Promise

getCapacityCommitment(request, callback) → {undefined}

Calls GetCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest

GetCapacityCommitmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitmentCallback

Node-style callback called with the error, if any, and CapacityCommitment

Returns:
Type Description
undefined

getCapacityCommitment(request) → {Promise.<google.cloud.bigquery.reservation.v1.CapacityCommitment>}

Calls GetCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IGetCapacityCommitmentRequest

GetCapacityCommitmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.CapacityCommitment>

Promise

getReservation(request, callback) → {undefined}

Calls GetReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IGetReservationRequest

GetReservationRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.GetReservationCallback

Node-style callback called with the error, if any, and Reservation

Returns:
Type Description
undefined

getReservation(request) → {Promise.<google.cloud.bigquery.reservation.v1.Reservation>}

Calls GetReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IGetReservationRequest

GetReservationRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.Reservation>

Promise

listAssignments(request, callback) → {undefined}

Calls ListAssignments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IListAssignmentsRequest

ListAssignmentsRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.ListAssignmentsCallback

Node-style callback called with the error, if any, and ListAssignmentsResponse

Returns:
Type Description
undefined

listAssignments(request) → {Promise.<google.cloud.bigquery.reservation.v1.ListAssignmentsResponse>}

Calls ListAssignments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IListAssignmentsRequest

ListAssignmentsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.ListAssignmentsResponse>

Promise

listCapacityCommitments(request, callback) → {undefined}

Calls ListCapacityCommitments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest

ListCapacityCommitmentsRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitmentsCallback

Node-style callback called with the error, if any, and ListCapacityCommitmentsResponse

Returns:
Type Description
undefined

listCapacityCommitments(request) → {Promise.<google.cloud.bigquery.reservation.v1.ListCapacityCommitmentsResponse>}

Calls ListCapacityCommitments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IListCapacityCommitmentsRequest

ListCapacityCommitmentsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.ListCapacityCommitmentsResponse>

Promise

listReservations(request, callback) → {undefined}

Calls ListReservations.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IListReservationsRequest

ListReservationsRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.ListReservationsCallback

Node-style callback called with the error, if any, and ListReservationsResponse

Returns:
Type Description
undefined

listReservations(request) → {Promise.<google.cloud.bigquery.reservation.v1.ListReservationsResponse>}

Calls ListReservations.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IListReservationsRequest

ListReservationsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.ListReservationsResponse>

Promise

mergeCapacityCommitments(request, callback) → {undefined}

Calls MergeCapacityCommitments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest

MergeCapacityCommitmentsRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitmentsCallback

Node-style callback called with the error, if any, and CapacityCommitment

Returns:
Type Description
undefined

mergeCapacityCommitments(request) → {Promise.<google.cloud.bigquery.reservation.v1.CapacityCommitment>}

Calls MergeCapacityCommitments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IMergeCapacityCommitmentsRequest

MergeCapacityCommitmentsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.CapacityCommitment>

Promise

moveAssignment(request, callback) → {undefined}

Calls MoveAssignment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest

MoveAssignmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignmentCallback

Node-style callback called with the error, if any, and Assignment

Returns:
Type Description
undefined

moveAssignment(request) → {Promise.<google.cloud.bigquery.reservation.v1.Assignment>}

Calls MoveAssignment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IMoveAssignmentRequest

MoveAssignmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.Assignment>

Promise

searchAllAssignments(request, callback) → {undefined}

Calls SearchAllAssignments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest

SearchAllAssignmentsRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignmentsCallback

Node-style callback called with the error, if any, and SearchAllAssignmentsResponse

Returns:
Type Description
undefined

searchAllAssignments(request) → {Promise.<google.cloud.bigquery.reservation.v1.SearchAllAssignmentsResponse>}

Calls SearchAllAssignments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ISearchAllAssignmentsRequest

SearchAllAssignmentsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.SearchAllAssignmentsResponse>

Promise

searchAssignments(request, callback) → {undefined}

Calls SearchAssignments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest

SearchAssignmentsRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignmentsCallback

Node-style callback called with the error, if any, and SearchAssignmentsResponse

Returns:
Type Description
undefined

searchAssignments(request) → {Promise.<google.cloud.bigquery.reservation.v1.SearchAssignmentsResponse>}

Calls SearchAssignments.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ISearchAssignmentsRequest

SearchAssignmentsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.SearchAssignmentsResponse>

Promise

splitCapacityCommitment(request, callback) → {undefined}

Calls SplitCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest

SplitCapacityCommitmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitmentCallback

Node-style callback called with the error, if any, and SplitCapacityCommitmentResponse

Returns:
Type Description
undefined

splitCapacityCommitment(request) → {Promise.<google.cloud.bigquery.reservation.v1.SplitCapacityCommitmentResponse>}

Calls SplitCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.ISplitCapacityCommitmentRequest

SplitCapacityCommitmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.SplitCapacityCommitmentResponse>

Promise

updateAssignment(request, callback) → {undefined}

Calls UpdateAssignment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IUpdateAssignmentRequest

UpdateAssignmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignmentCallback

Node-style callback called with the error, if any, and Assignment

Returns:
Type Description
undefined

updateAssignment(request) → {Promise.<google.cloud.bigquery.reservation.v1.Assignment>}

Calls UpdateAssignment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IUpdateAssignmentRequest

UpdateAssignmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.Assignment>

Promise

updateBiReservation(request, callback) → {undefined}

Calls UpdateBiReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest

UpdateBiReservationRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservationCallback

Node-style callback called with the error, if any, and BiReservation

Returns:
Type Description
undefined

updateBiReservation(request) → {Promise.<google.cloud.bigquery.reservation.v1.BiReservation>}

Calls UpdateBiReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IUpdateBiReservationRequest

UpdateBiReservationRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.BiReservation>

Promise

updateCapacityCommitment(request, callback) → {undefined}

Calls UpdateCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest

UpdateCapacityCommitmentRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitmentCallback

Node-style callback called with the error, if any, and CapacityCommitment

Returns:
Type Description
undefined

updateCapacityCommitment(request) → {Promise.<google.cloud.bigquery.reservation.v1.CapacityCommitment>}

Calls UpdateCapacityCommitment.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IUpdateCapacityCommitmentRequest

UpdateCapacityCommitmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.CapacityCommitment>

Promise

updateReservation(request, callback) → {undefined}

Calls UpdateReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IUpdateReservationRequest

UpdateReservationRequest message or plain object

callback google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservationCallback

Node-style callback called with the error, if any, and Reservation

Returns:
Type Description
undefined

updateReservation(request) → {Promise.<google.cloud.bigquery.reservation.v1.Reservation>}

Calls UpdateReservation.

Parameters:
Name Type Description
request google.cloud.bigquery.reservation.v1.IUpdateReservationRequest

UpdateReservationRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.reservation.v1.Reservation>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {ReservationService}

Creates new ReservationService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
ReservationService

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

Type Definitions

CreateAssignmentCallback(error, responseopt)

Callback as used by createAssignment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.Assignment <optional>

Assignment

CreateCapacityCommitmentCallback(error, responseopt)

Callback as used by createCapacityCommitment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.CapacityCommitment <optional>

CapacityCommitment

CreateReservationCallback(error, responseopt)

Callback as used by createReservation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.Reservation <optional>

Reservation

DeleteAssignmentCallback(error, responseopt)

Callback as used by deleteAssignment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteCapacityCommitmentCallback(error, responseopt)

Callback as used by deleteCapacityCommitment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteReservationCallback(error, responseopt)

Callback as used by deleteReservation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetBiReservationCallback(error, responseopt)

Callback as used by getBiReservation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.BiReservation <optional>

BiReservation

GetCapacityCommitmentCallback(error, responseopt)

Callback as used by getCapacityCommitment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.CapacityCommitment <optional>

CapacityCommitment

GetReservationCallback(error, responseopt)

Callback as used by getReservation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.Reservation <optional>

Reservation

ListAssignmentsCallback(error, responseopt)

Callback as used by listAssignments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.ListAssignmentsResponse <optional>

ListAssignmentsResponse

ListCapacityCommitmentsCallback(error, responseopt)

Callback as used by listCapacityCommitments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.ListCapacityCommitmentsResponse <optional>

ListCapacityCommitmentsResponse

ListReservationsCallback(error, responseopt)

Callback as used by listReservations.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.ListReservationsResponse <optional>

ListReservationsResponse

MergeCapacityCommitmentsCallback(error, responseopt)

Callback as used by mergeCapacityCommitments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.CapacityCommitment <optional>

CapacityCommitment

MoveAssignmentCallback(error, responseopt)

Callback as used by moveAssignment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.Assignment <optional>

Assignment

SearchAllAssignmentsCallback(error, responseopt)

Callback as used by searchAllAssignments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.SearchAllAssignmentsResponse <optional>

SearchAllAssignmentsResponse

SearchAssignmentsCallback(error, responseopt)

Callback as used by searchAssignments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.SearchAssignmentsResponse <optional>

SearchAssignmentsResponse

SplitCapacityCommitmentCallback(error, responseopt)

Callback as used by splitCapacityCommitment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.SplitCapacityCommitmentResponse <optional>

SplitCapacityCommitmentResponse

UpdateAssignmentCallback(error, responseopt)

Callback as used by updateAssignment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.Assignment <optional>

Assignment

UpdateBiReservationCallback(error, responseopt)

Callback as used by updateBiReservation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.BiReservation <optional>

BiReservation

UpdateCapacityCommitmentCallback(error, responseopt)

Callback as used by updateCapacityCommitment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.CapacityCommitment <optional>

CapacityCommitment

UpdateReservationCallback(error, responseopt)

Callback as used by updateReservation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.reservation.v1.Reservation <optional>

Reservation