Reference documentation and code samples for the Compute V1 Client class ReservationsClient.
Service Description: The Reservations API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
// Iterate over pages of elements
$pagedResponse = $reservationsClient->aggregatedList($project);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $key => $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $reservationsClient->aggregatedList($project);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$reservationsClient->close();
}
Methods
getOperationsClient
Return an ZoneOperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\ZoneOperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed {@see} object or {@see} object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see {@see} . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the {@see} method for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
aggregatedList
Retrieves an aggregated list of reservations.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
// Iterate over pages of elements
$pagedResponse = $reservationsClient->aggregatedList($project);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $key => $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $reservationsClient->aggregatedList($project);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
optionalArgs |
array
Optional. |
↳ filter |
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either |
↳ includeAllScopes |
bool
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
↳ maxResults |
int
The maximum number of results per page that should be returned. If the number of available results is larger than |
↳ orderBy |
string
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ returnPartialSuccess |
bool
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
delete
Deletes the specified reservation.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$reservation = 'reservation';
$zone = 'zone';
$operationResponse = $reservationsClient->delete($project, $reservation, $zone);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $reservationsClient->delete($project, $reservation, $zone);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $reservationsClient->resumeOperation($operationName, 'delete');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
reservation |
string
Name of the reservation to delete. |
zone |
string
Name of the zone for this request. |
optionalArgs |
array
Optional. |
↳ requestId |
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
get
Retrieves information about the specified reservation.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$reservation = 'reservation';
$zone = 'zone';
$response = $reservationsClient->get($project, $reservation, $zone);
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
reservation |
string
Name of the reservation to retrieve. |
zone |
string
Name of the zone for this request. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Reservation |
getIamPolicy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$resource = 'resource';
$zone = 'zone';
$response = $reservationsClient->getIamPolicy($project, $resource, $zone);
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
resource |
string
Name or id of the resource for this request. |
zone |
string
The name of the zone for this request. |
optionalArgs |
array
Optional. |
↳ optionsRequestedPolicyVersion |
int
Requested IAM Policy version. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Policy |
insert
Creates a new reservation. For more information, read Reserving zonal resources.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$reservationResource = new Reservation();
$zone = 'zone';
$operationResponse = $reservationsClient->insert($project, $reservationResource, $zone);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $reservationsClient->insert($project, $reservationResource, $zone);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $reservationsClient->resumeOperation($operationName, 'insert');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
reservationResource |
Google\Cloud\Compute\V1\Reservation
The body resource for this request |
zone |
string
Name of the zone for this request. |
optionalArgs |
array
Optional. |
↳ requestId |
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
list
A list of all the reservations that have been configured for the specified project in specified zone.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$zone = 'zone';
// Iterate over pages of elements
$pagedResponse = $reservationsClient->list($project, $zone);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $reservationsClient->list($project, $zone);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
zone |
string
Name of the zone for this request. |
optionalArgs |
array
Optional. |
↳ filter |
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either |
↳ maxResults |
int
The maximum number of results per page that should be returned. If the number of available results is larger than |
↳ orderBy |
string
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ returnPartialSuccess |
bool
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
resize
Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$reservation = 'reservation';
$reservationsResizeRequestResource = new ReservationsResizeRequest();
$zone = 'zone';
$operationResponse = $reservationsClient->resize($project, $reservation, $reservationsResizeRequestResource, $zone);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $reservationsClient->resize($project, $reservation, $reservationsResizeRequestResource, $zone);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $reservationsClient->resumeOperation($operationName, 'resize');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
reservation |
string
Name of the reservation to update. |
reservationsResizeRequestResource |
Google\Cloud\Compute\V1\ReservationsResizeRequest
The body resource for this request |
zone |
string
Name of the zone for this request. |
optionalArgs |
array
Optional. |
↳ requestId |
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). |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$resource = 'resource';
$zone = 'zone';
$zoneSetPolicyRequestResource = new ZoneSetPolicyRequest();
$response = $reservationsClient->setIamPolicy($project, $resource, $zone, $zoneSetPolicyRequestResource);
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
resource |
string
Name or id of the resource for this request. |
zone |
string
The name of the zone for this request. |
zoneSetPolicyRequestResource |
Google\Cloud\Compute\V1\ZoneSetPolicyRequest
The body resource for this request |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Policy |
testIamPermissions
Returns permissions that a caller has on the specified resource.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$resource = 'resource';
$testPermissionsRequestResource = new TestPermissionsRequest();
$zone = 'zone';
$response = $reservationsClient->testIamPermissions($project, $resource, $testPermissionsRequestResource, $zone);
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
resource |
string
Name or id of the resource for this request. |
testPermissionsRequestResource |
Google\Cloud\Compute\V1\TestPermissionsRequest
The body resource for this request |
zone |
string
The name of the zone for this request. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\TestPermissionsResponse |
update
Update share settings of the reservation.
Sample code:
$reservationsClient = new ReservationsClient();
try {
$project = 'project';
$reservation = 'reservation';
$reservationResource = new Reservation();
$zone = 'zone';
$operationResponse = $reservationsClient->update($project, $reservation, $reservationResource, $zone);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $reservationsClient->update($project, $reservation, $reservationResource, $zone);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $reservationsClient->resumeOperation($operationName, 'update');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$reservationsClient->close();
}
Parameters | |
---|---|
Name | Description |
project |
string
Project ID for this request. |
reservation |
string
Name of the reservation to update. |
reservationResource |
Google\Cloud\Compute\V1\Reservation
The body resource for this request |
zone |
string
Name of the zone for this request. |
optionalArgs |
array
Optional. |
↳ paths |
string
|
↳ requestId |
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). |
↳ updateMask |
string
Update_mask indicates fields to be updated as part of this request. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
Constants
SERVICE_NAME
Value: 'google.cloud.compute.v1.Reservations'
The name of the service.
SERVICE_ADDRESS
Value: 'compute.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.