Reference documentation and code samples for the Compute V1 Client class CancelFutureReservationRequest.
A request message for FutureReservations.Cancel. See the method description for details.
Generated from protobuf message google.cloud.compute.v1.CancelFutureReservationRequest
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ future_reservation |
string
Name of the future reservation to retrieve. Name should conform to RFC1035. |
↳ project |
string
Project ID for this request. |
↳ request_id |
string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ zone |
string
Name of the zone for this request. Name should conform to RFC1035. |
getFutureReservation
Name of the future reservation to retrieve. Name should conform to RFC1035.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFutureReservation
Name of the future reservation to retrieve. Name should conform to RFC1035.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProject
Project ID for this request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProject
Project ID for this request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestId
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Returns | |
|---|---|
| Type | Description |
string |
|
hasRequestId
clearRequestId
setRequestId
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getZone
Name of the zone for this request. Name should conform to RFC1035.
| Returns | |
|---|---|
| Type | Description |
string |
|
setZone
Name of the zone for this request. Name should conform to RFC1035.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
project |
string
Project ID for this request. |
zone |
string
Name of the zone for this request. Name should conform to RFC1035. |
futureReservation |
string
Name of the future reservation to retrieve. Name should conform to RFC1035. |
| Returns | |
|---|---|
| Type | Description |
CancelFutureReservationRequest |
|