BigQuery Reservation API . projects . locations . reservations

Instance Methods

assignments()

Returns the assignments Resource.

create(parent, body=None, reservationId=None, x__xgafv=None)

Creates a new reservation resource.

delete(name, x__xgafv=None)

Deletes a reservation.

get(name, x__xgafv=None)

Returns information about the reservation.

list(parent, pageToken=None, pageSize=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.

Method Details

create(parent, body=None, reservationId=None, x__xgafv=None)
Creates a new reservation resource.

Args:
  parent: string, Required. Project, location. E.g.,
`projects/myproject/locations/US` (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", # Minimum slots available to this reservation. A slot is a unit of
      # computational power in BigQuery, and serves as the unit of parallelism.
      # 
      # Queries using this reservation might use more slots during runtime if
      # ignore_idle_slots is set to false.
      # 
      # 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/team1-prod`.
  "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other
      # reservations within the same admin project. If true, a query using this
      # reservation will execute with the slot capacity specified above at most.
}

  reservationId: string, The reservation ID. This field must only contain lower case alphanumeric
characters or dash. Max length is 64 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", # Minimum slots available to this reservation. A slot is a unit of
        # computational power in BigQuery, and serves as the unit of parallelism.
        #
        # Queries using this reservation might use more slots during runtime if
        # ignore_idle_slots is set to false.
        #
        # 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/team1-prod`.
    "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other
        # reservations within the same admin project. If true, a query using this
        # reservation will execute with the slot capacity specified above at most.
  }
delete(name, x__xgafv=None)
Deletes a reservation.
Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has
assignments.

Args:
  name: string, Required. Resource name of the reservation to retrieve. E.g.,
   `projects/myproject/locations/US/reservations/team1-prod` (required)
  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, Required. Resource name of the reservation to retrieve. E.g.,
   `projects/myproject/locations/US/reservations/team1-prod` (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", # Minimum slots available to this reservation. A slot is a unit of
        # computational power in BigQuery, and serves as the unit of parallelism.
        #
        # Queries using this reservation might use more slots during runtime if
        # ignore_idle_slots is set to false.
        #
        # 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/team1-prod`.
    "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other
        # reservations within the same admin project. If true, a query using this
        # reservation will execute with the slot capacity specified above at most.
  }
list(parent, pageToken=None, pageSize=None, x__xgafv=None)
Lists all the reservations for the project in the specified location.

Args:
  parent: string, Required. The parent resource name containing project and location, e.g.:
  `projects/myproject/locations/US` (required)
  pageToken: string, The next_page_token value returned from a previous List request, if any.
  pageSize: integer, The maximum number of items to return per page.
  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", # Minimum slots available to this reservation. A slot is a unit of
            # computational power in BigQuery, and serves as the unit of parallelism.
            #
            # Queries using this reservation might use more slots during runtime if
            # ignore_idle_slots is set to false.
            #
            # 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/team1-prod`.
        "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other
            # reservations within the same admin project. If true, a query using this
            # reservation will execute with the slot capacity specified above at most.
      },
    ],
    "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.

Args:
  name: string, The resource name of the reservation, e.g.,
`projects/*/locations/*/reservations/team1-prod`. (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", # Minimum slots available to this reservation. A slot is a unit of
      # computational power in BigQuery, and serves as the unit of parallelism.
      # 
      # Queries using this reservation might use more slots during runtime if
      # ignore_idle_slots is set to false.
      # 
      # 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/team1-prod`.
  "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other
      # reservations within the same admin project. If true, a query using this
      # reservation will execute with the slot capacity specified above at most.
}

  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", # Minimum slots available to this reservation. A slot is a unit of
        # computational power in BigQuery, and serves as the unit of parallelism.
        #
        # Queries using this reservation might use more slots during runtime if
        # ignore_idle_slots is set to false.
        #
        # 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/team1-prod`.
    "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other
        # reservations within the same admin project. If true, a query using this
        # reservation will execute with the slot capacity specified above at most.
  }