<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Compute\Resource;
use Google\Service\Compute\Operation;
use Google\Service\Compute\OperationAggregatedList;
use Google\Service\Compute\OperationList;
/**
* The "globalOperations" collection of methods.
* Typical usage is:
* <code>
* $computeService = new Google\Service\Compute(...);
* $globalOperations = $computeService->globalOperations;
* </code>
*/
class GlobalOperations extends \Google\Service\Resource
{
/**
* Retrieves an aggregated list of all operations.
* (globalOperations.aggregatedList)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that filters resources listed in
* the response. The 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 `=`, `!=`, `>`, `<`, `<=`,
* `>=` or `:`. For example, if you are filtering Compute Engine instances, you
* can exclude instances named `example-instance` by specifying `name !=
* example-instance`. The `:` operator can be used with string fields to match
* substrings. For non-string fields it is equivalent to the `=` operator. The
* `:*` comparison can be used to test whether a key has been defined. For
* example, to find all objects with `owner` label use: ``` labels.owner:* ```
* You can also filter nested fields. For example, you could specify
* `scheduling.automaticRestart = false` to include instances only if they are
* not scheduled for automatic restarts. You can use filtering on nested fields
* to filter based on resource labels. To filter on multiple expressions,
* provide each separate expression within parentheses. For example: ```
* (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By
* default, each expression is an `AND` expression. However, you can include
* `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel
* Skylake") OR (cpuPlatform = "Intel Broadwell") AND
* (scheduling.automaticRestart = true) ```
* @opt_param bool includeAllScopes 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.
* @opt_param string maxResults The maximum number of results per page that
* should be returned. If the number of available results is larger than
* `maxResults`, Compute Engine returns a `nextPageToken` that can be used to
* get the next page of results in subsequent list requests. Acceptable values
* are `0` to `500`, inclusive. (Default: `500`)
* @opt_param string orderBy 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 `orderBy="creationTimestamp desc"`. This sorts results based on the
* `creationTimestamp` field in reverse chronological order (newest result
* first). Use this to sort resources like operations so that the newest
* operation is returned first. Currently, only sorting by `name` or
* `creationTimestamp desc` is supported.
* @opt_param string pageToken Specifies a page token to use. Set `pageToken` to
* the `nextPageToken` returned by a previous list request to get the next page
* of results.
* @opt_param bool returnPartialSuccess Opt-in for partial success behavior
* which provides partial results in case of failure. The default value is
* false.
* @return OperationAggregatedList
*/
public function aggregatedList($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('aggregatedList', [$params], OperationAggregatedList::class);
}
/**
* Deletes the specified Operations resource. (globalOperations.delete)
*
* @param string $project Project ID for this request.
* @param string $operation Name of the Operations resource to delete.
* @param array $optParams Optional parameters.
*/
public function delete($project, $operation, $optParams = [])
{
$params = ['project' => $project, 'operation' => $operation];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Retrieves the specified Operations resource. (globalOperations.get)
*
* @param string $project Project ID for this request.
* @param string $operation Name of the Operations resource to return.
* @param array $optParams Optional parameters.
* @return Operation
*/
public function get($project, $operation, $optParams = [])
{
$params = ['project' => $project, 'operation' => $operation];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Operation::class);
}
/**
* Retrieves a list of Operation resources contained within the specified
* project. (globalOperations.listGlobalOperations)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that filters resources listed in
* the response. The 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 `=`, `!=`, `>`, `<`, `<=`,
* `>=` or `:`. For example, if you are filtering Compute Engine instances, you
* can exclude instances named `example-instance` by specifying `name !=
* example-instance`. The `:` operator can be used with string fields to match
* substrings. For non-string fields it is equivalent to the `=` operator. The
* `:*` comparison can be used to test whether a key has been defined. For
* example, to find all objects with `owner` label use: ``` labels.owner:* ```
* You can also filter nested fields. For example, you could specify
* `scheduling.automaticRestart = false` to include instances only if they are
* not scheduled for automatic restarts. You can use filtering on nested fields
* to filter based on resource labels. To filter on multiple expressions,
* provide each separate expression within parentheses. For example: ```
* (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By
* default, each expression is an `AND` expression. However, you can include
* `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel
* Skylake") OR (cpuPlatform = "Intel Broadwell") AND
* (scheduling.automaticRestart = true) ```
* @opt_param string maxResults The maximum number of results per page that
* should be returned. If the number of available results is larger than
* `maxResults`, Compute Engine returns a `nextPageToken` that can be used to
* get the next page of results in subsequent list requests. Acceptable values
* are `0` to `500`, inclusive. (Default: `500`)
* @opt_param string orderBy 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 `orderBy="creationTimestamp desc"`. This sorts results based on the
* `creationTimestamp` field in reverse chronological order (newest result
* first). Use this to sort resources like operations so that the newest
* operation is returned first. Currently, only sorting by `name` or
* `creationTimestamp desc` is supported.
* @opt_param string pageToken Specifies a page token to use. Set `pageToken` to
* the `nextPageToken` returned by a previous list request to get the next page
* of results.
* @opt_param bool returnPartialSuccess Opt-in for partial success behavior
* which provides partial results in case of failure. The default value is
* false.
* @return OperationList
*/
public function listGlobalOperations($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], OperationList::class);
}
/**
* Waits for the specified Operation resource to return as `DONE` or for the
* request to approach the 2 minute deadline, and retrieves the specified
* Operation resource. This method differs from the `GET` method in that it
* waits for no more than the default deadline (2 minutes) and then returns the
* current state of the operation, which might be `DONE` or still in progress.
* This method is called on a best-effort basis. Specifically: - In uncommon
* cases, when the server is overloaded, the request might return before the
* default deadline is reached, or might return after zero seconds. - If the
* default deadline is reached, there is no guarantee that the operation is
* actually done when the method returns. Be prepared to retry if the operation
* is not `DONE`. (globalOperations.wait)
*
* @param string $project Project ID for this request.
* @param string $operation Name of the Operations resource to return.
* @param array $optParams Optional parameters.
* @return Operation
*/
public function wait($project, $operation, $optParams = [])
{
$params = ['project' => $project, 'operation' => $operation];
$params = array_merge($params, $optParams);
return $this->call('wait', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GlobalOperations::class, 'Google_Service_Compute_Resource_GlobalOperations');