docs/dyn/bigqueryreservation_v1alpha2.projects.locations.reservations.slotPools.html - external/github.com/google/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="bigqueryreservation_v1alpha2.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1alpha2.projects.html">projects</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.reservations.html">reservations</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.reservations.slotPools.html">slotPools</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes a slot pool. Attempting to delete slot pool before its</p>
 <p class="toc_element">
   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Returns information about the slot pool.</p>
 <p class="toc_element">
   <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Lists all the slot pools for the reservation.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="delete">delete(name, x__xgafv=None)</code>
   <pre>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 `{}`.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(name, x__xgafv=None)</code>
   <pre>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.
     &quot;failureStatus&quot;: { # 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).
       &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
           # message types for APIs to use.
         {
           &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
         },
       ],
       &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
       &quot;message&quot;: &quot;A String&quot;, # 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.
     },
     &quot;plan&quot;: &quot;A String&quot;, # Slot pool commitment plan.
     &quot;commitmentEndTime&quot;: &quot;A String&quot;, # 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.
     &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the slot pool, e.g.,
         #    projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
     &quot;state&quot;: &quot;A String&quot;, # Output only.
     &quot;slotCount&quot;: &quot;A String&quot;, # Number of slots in this pool.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
   <pre>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)
   pageSize: integer, The maximum number of items to return.
   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.ListSlotPools.
     &quot;slotPools&quot;: [ # 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.
         &quot;failureStatus&quot;: { # 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).
           &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
               # message types for APIs to use.
             {
               &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
             },
           ],
           &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
           &quot;message&quot;: &quot;A String&quot;, # 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.
         },
         &quot;plan&quot;: &quot;A String&quot;, # Slot pool commitment plan.
         &quot;commitmentEndTime&quot;: &quot;A String&quot;, # 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.
         &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the slot pool, e.g.,
             #    projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
         &quot;state&quot;: &quot;A String&quot;, # Output only.
         &quot;slotCount&quot;: &quot;A String&quot;, # Number of slots in this pool.
       },
     ],
     &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
         # more results in the list.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   <pre>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 &#x27;execute()&#x27; on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="bigqueryreservation_v1alpha2.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1alpha2.projects.html">projects</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.reservations.html">reservations</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.reservations.slotPools.html">slotPools</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Deletes a slot pool. Attempting to delete slot pool before its</p>
	<p class="toc_element">
	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Returns information about the slot pool.</p>
	<p class="toc_element">
	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Lists all the slot pools for the reservation.</p>
	<p class="toc_element">
	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
	<pre>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 `{}`.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="get">get(name, x__xgafv=None)</code>
	<pre>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.
	"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).
	"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.
	},
	],
	"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.
	},
	"plan": "A String", # Slot pool commitment plan.
	"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.
	"name": "A String", # Output only. The resource name of the slot pool, e.g.,
	# projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
	"state": "A String", # Output only.
	"slotCount": "A String", # Number of slots in this pool.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
	<pre>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)
	pageSize: integer, The maximum number of items to return.
	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.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.
	"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).
	"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.
	},
	],
	"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.
	},
	"plan": "A String", # Slot pool commitment plan.
	"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.
	"name": "A String", # Output only. The resource name of the slot pool, e.g.,
	# projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
	"state": "A String", # Output only.
	"slotCount": "A String", # Number of slots in this pool.
	},
	],
	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
	# more results in the list.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
	<pre>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.
	</pre>
	</div>

	</body></html>