Returns the slotPools Resource.
create(parent, body=None, reservationId=None, x__xgafv=None)
Creates a new reservation resource. Multiple reservations are created if
createReservation(parent, body=None, reservationId=None, x__xgafv=None)
Creates a new reservation resource. Multiple reservations are created if
delete(name, force=None, x__xgafv=None)
Deletes a reservation.
Returns information about the reservation.
list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)
Lists all the reservations for the project in the specified location.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an existing reservation resource. Applicable only for child
create(parent, body=None, reservationId=None, x__xgafv=None)
Creates a new reservation resource. Multiple reservations are created if
the ancestor reservations do not exist.
Args:
parent: string, Project, location, and (optionally) reservation name. E.g.,
projects/myproject/locations/us-central1/reservations/parent (required)
body: object, The request body.
The object takes the form of:
{ # A reservation is a mechanism used to guarantee slots to users.
"slotCapacity": "A String", # Maximum slots available to this reservation and its children. A slot is a
# unit of computational power in BigQuery, and serves as the unit of
# parallelism. In a scan of a multi-partitioned table, a single slot operates
# on a single partition of the table.
#
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
"name": "A String", # The resource name of the reservation, e.g.,
# "projects/*/locations/*/reservations/dev/team/product". Reservation names
# (e.g., "dev/team/product") exceeding a depth of six will fail with
# `google.rpc.Code.INVALID_ARGUMENT`.
"useParentReservation": True or False, # If true, any query using this reservation will also be submitted to the
# parent reservation. This allows the query to share the additional slot
# capacity of the parent with other queries in the parent reservation. If the
# parent also has this field set to true, then this process will continue
# until it encounters a reservation for which this is false.
# If false, a query using this reservation will
# execute with the maximum slot capacity as specified above.
# If not specified, default value is true.
# Ignored for top-level reservation.
}
reservationId: string, The reservation ID relative to the parent, e.g., "dev". This field must
only contain alphanumeric characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A reservation is a mechanism used to guarantee slots to users.
"slotCapacity": "A String", # Maximum slots available to this reservation and its children. A slot is a
# unit of computational power in BigQuery, and serves as the unit of
# parallelism. In a scan of a multi-partitioned table, a single slot operates
# on a single partition of the table.
#
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
"name": "A String", # The resource name of the reservation, e.g.,
# "projects/*/locations/*/reservations/dev/team/product". Reservation names
# (e.g., "dev/team/product") exceeding a depth of six will fail with
# `google.rpc.Code.INVALID_ARGUMENT`.
"useParentReservation": True or False, # If true, any query using this reservation will also be submitted to the
# parent reservation. This allows the query to share the additional slot
# capacity of the parent with other queries in the parent reservation. If the
# parent also has this field set to true, then this process will continue
# until it encounters a reservation for which this is false.
# If false, a query using this reservation will
# execute with the maximum slot capacity as specified above.
# If not specified, default value is true.
# Ignored for top-level reservation.
}
createReservation(parent, body=None, reservationId=None, x__xgafv=None)
Creates a new reservation resource. Multiple reservations are created if
the ancestor reservations do not exist.
Args:
parent: string, Project, location, and (optionally) reservation name. E.g.,
projects/myproject/locations/us-central1/reservations/parent (required)
body: object, The request body.
The object takes the form of:
{ # A reservation is a mechanism used to guarantee slots to users.
"slotCapacity": "A String", # Maximum slots available to this reservation and its children. A slot is a
# unit of computational power in BigQuery, and serves as the unit of
# parallelism. In a scan of a multi-partitioned table, a single slot operates
# on a single partition of the table.
#
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
"name": "A String", # The resource name of the reservation, e.g.,
# "projects/*/locations/*/reservations/dev/team/product". Reservation names
# (e.g., "dev/team/product") exceeding a depth of six will fail with
# `google.rpc.Code.INVALID_ARGUMENT`.
"useParentReservation": True or False, # If true, any query using this reservation will also be submitted to the
# parent reservation. This allows the query to share the additional slot
# capacity of the parent with other queries in the parent reservation. If the
# parent also has this field set to true, then this process will continue
# until it encounters a reservation for which this is false.
# If false, a query using this reservation will
# execute with the maximum slot capacity as specified above.
# If not specified, default value is true.
# Ignored for top-level reservation.
}
reservationId: string, The reservation ID relative to the parent, e.g., "dev". This field must
only contain alphanumeric characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A reservation is a mechanism used to guarantee slots to users.
"slotCapacity": "A String", # Maximum slots available to this reservation and its children. A slot is a
# unit of computational power in BigQuery, and serves as the unit of
# parallelism. In a scan of a multi-partitioned table, a single slot operates
# on a single partition of the table.
#
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
"name": "A String", # The resource name of the reservation, e.g.,
# "projects/*/locations/*/reservations/dev/team/product". Reservation names
# (e.g., "dev/team/product") exceeding a depth of six will fail with
# `google.rpc.Code.INVALID_ARGUMENT`.
"useParentReservation": True or False, # If true, any query using this reservation will also be submitted to the
# parent reservation. This allows the query to share the additional slot
# capacity of the parent with other queries in the parent reservation. If the
# parent also has this field set to true, then this process will continue
# until it encounters a reservation for which this is false.
# If false, a query using this reservation will
# execute with the maximum slot capacity as specified above.
# If not specified, default value is true.
# Ignored for top-level reservation.
}
delete(name, force=None, x__xgafv=None)
Deletes a reservation.
Returns `google.rpc.Code.FAILED_PRECONDITION` in the following cases:
1. When reservation has child reservations. This check can be bypassed by
setting DeleteReservationRequest.force flag to true.
2. When top-level reservation with slot pools is being deleted.
Args:
name: string, Resource name of the reservation to retrieve. E.g.,
projects/myproject/locations/us-central1/reservations/my_reservation (required)
force: boolean, If true, deletes all the child reservations of the given reservation.
Otherwise, attempting to delete a reservation that has child
reservations will fail with error code
`google.rpc.Code.FAILED_PRECONDITION`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}
get(name, x__xgafv=None)
Returns information about the reservation.
Args:
name: string, Resource name of the reservation to retrieve. E.g.,
projects/myproject/locations/us-central1/reservations/path/to/reserv (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A reservation is a mechanism used to guarantee slots to users.
"slotCapacity": "A String", # Maximum slots available to this reservation and its children. A slot is a
# unit of computational power in BigQuery, and serves as the unit of
# parallelism. In a scan of a multi-partitioned table, a single slot operates
# on a single partition of the table.
#
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
"name": "A String", # The resource name of the reservation, e.g.,
# "projects/*/locations/*/reservations/dev/team/product". Reservation names
# (e.g., "dev/team/product") exceeding a depth of six will fail with
# `google.rpc.Code.INVALID_ARGUMENT`.
"useParentReservation": True or False, # If true, any query using this reservation will also be submitted to the
# parent reservation. This allows the query to share the additional slot
# capacity of the parent with other queries in the parent reservation. If the
# parent also has this field set to true, then this process will continue
# until it encounters a reservation for which this is false.
# If false, a query using this reservation will
# execute with the maximum slot capacity as specified above.
# If not specified, default value is true.
# Ignored for top-level reservation.
}
list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)
Lists all the reservations for the project in the specified location.
Args:
parent: string, The parent resource name containing project and location, e.g.:
"projects/myproject/locations/us-central1" (required)
pageSize: integer, The maximum number of items to return.
filter: string, Can be used to filter out reservations based on names, capacity, etc, e.g.:
filter="reservation.slot_capacity > 200"
filter="reservation.name = \"*dev/*\""
Advanced filtering syntax can be
[here](https://cloud.google.com/logging/docs/view/advanced-filters).
pageToken: string, The next_page_token value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for ReservationService.ListReservations.
"reservations": [ # List of reservations visible to the user.
{ # A reservation is a mechanism used to guarantee slots to users.
"slotCapacity": "A String", # Maximum slots available to this reservation and its children. A slot is a
# unit of computational power in BigQuery, and serves as the unit of
# parallelism. In a scan of a multi-partitioned table, a single slot operates
# on a single partition of the table.
#
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
"name": "A String", # The resource name of the reservation, e.g.,
# "projects/*/locations/*/reservations/dev/team/product". Reservation names
# (e.g., "dev/team/product") exceeding a depth of six will fail with
# `google.rpc.Code.INVALID_ARGUMENT`.
"useParentReservation": True or False, # If true, any query using this reservation will also be submitted to the
# parent reservation. This allows the query to share the additional slot
# capacity of the parent with other queries in the parent reservation. If the
# parent also has this field set to true, then this process will continue
# until it encounters a reservation for which this is false.
# If false, a query using this reservation will
# execute with the maximum slot capacity as specified above.
# If not specified, default value is true.
# Ignored for top-level reservation.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
# more results in the list.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an existing reservation resource. Applicable only for child
reservations.
Args:
name: string, The resource name of the reservation, e.g.,
"projects/*/locations/*/reservations/dev/team/product". Reservation names
(e.g., "dev/team/product") exceeding a depth of six will fail with
`google.rpc.Code.INVALID_ARGUMENT`. (required)
body: object, The request body.
The object takes the form of:
{ # A reservation is a mechanism used to guarantee slots to users.
"slotCapacity": "A String", # Maximum slots available to this reservation and its children. A slot is a
# unit of computational power in BigQuery, and serves as the unit of
# parallelism. In a scan of a multi-partitioned table, a single slot operates
# on a single partition of the table.
#
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
"name": "A String", # The resource name of the reservation, e.g.,
# "projects/*/locations/*/reservations/dev/team/product". Reservation names
# (e.g., "dev/team/product") exceeding a depth of six will fail with
# `google.rpc.Code.INVALID_ARGUMENT`.
"useParentReservation": True or False, # If true, any query using this reservation will also be submitted to the
# parent reservation. This allows the query to share the additional slot
# capacity of the parent with other queries in the parent reservation. If the
# parent also has this field set to true, then this process will continue
# until it encounters a reservation for which this is false.
# If false, a query using this reservation will
# execute with the maximum slot capacity as specified above.
# If not specified, default value is true.
# Ignored for top-level reservation.
}
updateMask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A reservation is a mechanism used to guarantee slots to users.
"slotCapacity": "A String", # Maximum slots available to this reservation and its children. A slot is a
# unit of computational power in BigQuery, and serves as the unit of
# parallelism. In a scan of a multi-partitioned table, a single slot operates
# on a single partition of the table.
#
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
"name": "A String", # The resource name of the reservation, e.g.,
# "projects/*/locations/*/reservations/dev/team/product". Reservation names
# (e.g., "dev/team/product") exceeding a depth of six will fail with
# `google.rpc.Code.INVALID_ARGUMENT`.
"useParentReservation": True or False, # If true, any query using this reservation will also be submitted to the
# parent reservation. This allows the query to share the additional slot
# capacity of the parent with other queries in the parent reservation. If the
# parent also has this field set to true, then this process will continue
# until it encounters a reservation for which this is false.
# If false, a query using this reservation will
# execute with the maximum slot capacity as specified above.
# If not specified, default value is true.
# Ignored for top-level reservation.
}