ProjectsLocationsCapacityCommitments
class ProjectsLocationsCapacityCommitments extends Resource (View source)
The "capacityCommitments" collection of methods.
Typical usage is:
$bigqueryreservationService = new Google\Service\BigQueryReservation(...);
$capacityCommitments = $bigqueryreservationService->projects_locations_capacityCommitments;Methods
Creates a new capacity commitment resource. (capacityCommitments.create)
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. (capacityCommitments.delete)
Returns information about the capacity commitment. (capacityCommitments.get)
Lists all the capacity commitments for the admin project.
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. (capacityCommitments.merge)
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.
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.
Details
CapacityCommitment
create(string $parent, CapacityCommitment $postBody, array $optParams = [])
Creates a new capacity commitment resource. (capacityCommitments.create)
BigqueryreservationEmpty
delete(string $name, array $optParams = [])
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. (capacityCommitments.delete)
CapacityCommitment
get(string $name, array $optParams = [])
Returns information about the capacity commitment. (capacityCommitments.get)
ListCapacityCommitmentsResponse
listProjectsLocationsCapacityCommitments(string $parent, array $optParams = [])
Lists all the capacity commitments for the admin project.
(capacityCommitments.listProjectsLocationsCapacityCommitments)
CapacityCommitment
merge(string $parent, MergeCapacityCommitmentsRequest $postBody, array $optParams = [])
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. (capacityCommitments.merge)
CapacityCommitment
patch(string $name, CapacityCommitment $postBody, array $optParams = [])
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.
(capacityCommitments.patch)
SplitCapacityCommitmentResponse
split(string $name, SplitCapacityCommitmentRequest $postBody, array $optParams = [])
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. (capacityCommitments.split)