Google BigQuery Reservation V1 Client - Class DeleteCapacityCommitmentRequest (1.3.5)

Reference documentation and code samples for the Google BigQuery Reservation V1 Client class DeleteCapacityCommitmentRequest.

The request for ReservationService.DeleteCapacityCommitment.

Generated from protobuf message google.cloud.bigquery.reservation.v1.DeleteCapacityCommitmentRequest

Namespace

Google \ Cloud \ BigQuery \ Reservation \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123

↳ force bool

Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.

getName

Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123

Returns
Type Description
string

setName

Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.

Returns
Type Description
bool

setForce

Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123 Please see Google\Cloud\BigQuery\Reservation\V1\ReservationServiceClient::capacityCommitmentName() for help formatting this field.

Returns
Type Description
Google\Cloud\BigQuery\Reservation\V1\DeleteCapacityCommitmentRequest