• Home
• com.google.apis
• google-api-services-bigqueryreservation
• v1-rev20230326-2.0.0
• source code
• BigQueryReservation.Projects.Locations.CapacityCommitments.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.bigqueryreservation.v1.BigQueryReservation.Projects.Locations.CapacityCommitments.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigqueryreservation.v1
Class BigQueryReservation.Projects.Locations.CapacityCommitments



java.lang.Object


com.google.api.services.bigqueryreservation.v1.BigQueryReservation.Projects.Locations.CapacityCommitments







Enclosing class:
BigQueryReservation.Projects.Locations




public class BigQueryReservation.Projects.Locations.CapacityCommitments
extends Object
The "capacityCommitments" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
BigQueryReservation.Projects.Locations.CapacityCommitments.Create 


class 
BigQueryReservation.Projects.Locations.CapacityCommitments.Delete 


class 
BigQueryReservation.Projects.Locations.CapacityCommitments.Get 


class 
BigQueryReservation.Projects.Locations.CapacityCommitments.List 


class 
BigQueryReservation.Projects.Locations.CapacityCommitments.Merge 


class 
BigQueryReservation.Projects.Locations.CapacityCommitments.Patch 


class 
BigQueryReservation.Projects.Locations.CapacityCommitments.Split 









Constructor Summary

Constructors 

Constructor and Description


CapacityCommitments() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BigQueryReservation.Projects.Locations.CapacityCommitments.Create
create(String parent,
      CapacityCommitment content)
Creates a new capacity commitment resource.



BigQueryReservation.Projects.Locations.CapacityCommitments.Delete
delete(String name)
Deletes a capacity commitment.



BigQueryReservation.Projects.Locations.CapacityCommitments.Get
get(String name)
Returns information about the capacity commitment.



BigQueryReservation.Projects.Locations.CapacityCommitments.List
list(String parent)
Lists all the capacity commitments for the admin project.



BigQueryReservation.Projects.Locations.CapacityCommitments.Merge
merge(String parent,
     MergeCapacityCommitmentsRequest content)
Merges capacity commitments of the same plan into a single commitment.



BigQueryReservation.Projects.Locations.CapacityCommitments.Patch
patch(String name,
     CapacityCommitment content)
Updates an existing capacity commitment.



BigQueryReservation.Projects.Locations.CapacityCommitments.Split
split(String name,
     SplitCapacityCommitmentRequest content)
Splits capacity commitment to two commitments of the same plan and `commitment_end_time`.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





CapacityCommitments
public CapacityCommitments()









Method Detail





create
public BigQueryReservation.Projects.Locations.CapacityCommitments.Create create(String parent,
                                                                                CapacityCommitment content)
                                                                         throws IOException
Creates a new capacity commitment resource.

 Create a request for the method "capacityCommitments.create".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. Resource name of the parent reservation. E.g., `projects/myproject/locations/US`
content - the CapacityCommitment
Returns:
the request
Throws:
IOException








delete
public BigQueryReservation.Projects.Locations.CapacityCommitments.Delete delete(String name)
                                                                         throws IOException
Deletes a capacity commitment. Attempting to delete capacity commitment before its
 commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.

 Create a request for the method "capacityCommitments.delete".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Resource name of the capacity commitment to delete. E.g.,
        `projects/myproject/locations/US/capacityCommitments/123`
Returns:
the request
Throws:
IOException








get
public BigQueryReservation.Projects.Locations.CapacityCommitments.Get get(String name)
                                                                   throws IOException
Returns information about the capacity commitment.

 Create a request for the method "capacityCommitments.get".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Resource name of the capacity commitment to retrieve. E.g.,
        `projects/myproject/locations/US/capacityCommitments/123`
Returns:
the request
Throws:
IOException








list
public BigQueryReservation.Projects.Locations.CapacityCommitments.List list(String parent)
                                                                     throws IOException
Lists all the capacity commitments for the admin project.

 Create a request for the method "capacityCommitments.list".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. Resource name of the parent reservation. E.g., `projects/myproject/locations/US`
Returns:
the request
Throws:
IOException








merge
public BigQueryReservation.Projects.Locations.CapacityCommitments.Merge merge(String parent,
                                                                              MergeCapacityCommitmentsRequest content)
                                                                       throws IOException
Merges capacity commitments of the same plan into a single commitment. The resulting capacity
 commitment has the greater commitment_end_time out of the to-be-merged capacity commitments.
 Attempting to merge capacity commitments of different plan will fail with the error code
 `google.rpc.Code.FAILED_PRECONDITION`.

 Create a request for the method "capacityCommitments.merge".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Parent resource that identifies admin project and location e.g., `projects/myproject/locations/us`
content - the MergeCapacityCommitmentsRequest
Returns:
the request
Throws:
IOException








patch
public BigQueryReservation.Projects.Locations.CapacityCommitments.Patch patch(String name,
                                                                              CapacityCommitment content)
                                                                       throws IOException
Updates an existing capacity commitment. Only `plan` and `renewal_plan` fields can be updated.
 Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan
 with shorter commitment period will fail with the error code
 `google.rpc.Code.FAILED_PRECONDITION`.

 Create a request for the method "capacityCommitments.patch".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Output only. The resource name of the capacity commitment, e.g.,
        `projects/myproject/locations/US/capacityCommitments/123` The commitment_id must only
        contain lower case alphanumeric characters or dashes. It must start with a letter and must
        not end with a dash. Its maximum length is 64 characters.
content - the CapacityCommitment
Returns:
the request
Throws:
IOException








split
public BigQueryReservation.Projects.Locations.CapacityCommitments.Split split(String name,
                                                                              SplitCapacityCommitmentRequest content)
                                                                       throws IOException
Splits capacity commitment to two commitments of the same plan and `commitment_end_time`. A
 common use case is to enable downgrading commitments. For example, in order to downgrade from
 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and
 8000. Then, you delete the first one after the commitment end time passes.

 Create a request for the method "capacityCommitments.split".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The resource name e.g.,: `projects/myproject/locations/US/capacityCommitments/123`
content - the SplitCapacityCommitmentRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.