BigQuery Reservation API . projects . locations . reservations . slotPools

Instance Methods

delete(name, x__xgafv=None)

Deletes a slot pool. Attempting to delete slot pool before its

get(name, x__xgafv=None)

Returns information about the slot pool.

list(parent, pageToken=None, pageSize=None, x__xgafv=None)

Lists all the slot pools for the reservation.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(name, x__xgafv=None)
Deletes a slot pool. Attempting to delete slot pool before its
commitment_end_time will fail with the error code
`google.rpc.Code.FAILED_PRECONDITION`.

Args:
  name: string, Resource name of the slot pool to delete. E.g.,
   projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123 (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 slot pool.

Args:
  name: string, Resource name of the slot pool to retrieve. E.g.,
   projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Slot pool is a way to purchase slots with some minimum committed period of
      # usage. Slot pool is immutable and cannot be deleted until the end of the
      # commitment period. After the end of the commitment period, slots are still
      # available but can be freely removed any time. Annual commitments will
      # automatically be downgraded to monthly after the commitment ends.
      #
      # A slot pool resource exists as a child resource of a top-level reservation.
      # Sum of all the ACTIVE pools slot_count is always equal to the reservation
      # slot_capacity.
    "plan": "A String", # Slot pool commitment plan.
    "slotCount": "A String", # Number of slots in this pool.
    "failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED slot pool, provides the reason of failure.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "commitmentEndTime": "A String", # Output only. The end of the commitment period. Slot pool cannot be
        # removed before commitment_end_time. It is applicable only for ACTIVE slot
        # pools and is computed as a combination of the plan and the time when the
        # slot pool became ACTIVE.
    "state": "A String", # Output only.
    "name": "A String", # Output only. The resource name of the slot pool, e.g.,
        #    projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
  }
list(parent, pageToken=None, pageSize=None, x__xgafv=None)
Lists all the slot pools for the reservation.

Args:
  parent: string, Resource name of the parent reservation. Only top-level reservations can
have slot pools. E.g.,
   projects/myproject/locations/us-central1/reservations/my_reservation (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.
  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.ListSlotPools.
    "slotPools": [ # List of slot pools visible to the user.
      { # Slot pool is a way to purchase slots with some minimum committed period of
          # usage. Slot pool is immutable and cannot be deleted until the end of the
          # commitment period. After the end of the commitment period, slots are still
          # available but can be freely removed any time. Annual commitments will
          # automatically be downgraded to monthly after the commitment ends.
          #
          # A slot pool resource exists as a child resource of a top-level reservation.
          # Sum of all the ACTIVE pools slot_count is always equal to the reservation
          # slot_capacity.
        "plan": "A String", # Slot pool commitment plan.
        "slotCount": "A String", # Number of slots in this pool.
        "failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED slot pool, provides the reason of failure.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "details": [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "commitmentEndTime": "A String", # Output only. The end of the commitment period. Slot pool cannot be
            # removed before commitment_end_time. It is applicable only for ACTIVE slot
            # pools and is computed as a combination of the plan and the time when the
            # slot pool became ACTIVE.
        "state": "A String", # Output only.
        "name": "A String", # Output only. The resource name of the slot pool, e.g.,
            #    projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
      },
    ],
    "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.