📄 Source: Projects.php
<?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\DiskMoveRequest;
use Google\Service\Compute\InstanceMoveRequest;
use Google\Service\Compute\Metadata;
use Google\Service\Compute\Operation;
use Google\Service\Compute\Project;
use Google\Service\Compute\ProjectsDisableXpnResourceRequest;
use Google\Service\Compute\ProjectsEnableXpnResourceRequest;
use Google\Service\Compute\ProjectsGetXpnResources;
use Google\Service\Compute\ProjectsListXpnHostsRequest;
use Google\Service\Compute\ProjectsSetCloudArmorTierRequest;
use Google\Service\Compute\ProjectsSetDefaultNetworkTierRequest;
use Google\Service\Compute\UsageExportLocation;
use Google\Service\Compute\XpnHostList;
/**
* The "projects" collection of methods.
* Typical usage is:
* <code>
* $computeService = new Google\Service\Compute(...);
* $projects = $computeService->projects;
* </code>
*/
class Projects extends \Google\Service\Resource
{
/**
* Disable this project as a shared VPC host project. (projects.disableXpnHost)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function disableXpnHost($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('disableXpnHost', [$params], Operation::class);
}
/**
* Disable a service resource (also known as service project) associated with
* this host project. (projects.disableXpnResource)
*
* @param string $project Project ID for this request.
* @param ProjectsDisableXpnResourceRequest $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function disableXpnResource($project, ProjectsDisableXpnResourceRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('disableXpnResource', [$params], Operation::class);
}
/**
* Enable this project as a shared VPC host project. (projects.enableXpnHost)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function enableXpnHost($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('enableXpnHost', [$params], Operation::class);
}
/**
* Enable service resource (a.k.a service project) for a host project, so that
* subnets in the host project can be used by instances in the service project.
* (projects.enableXpnResource)
*
* @param string $project Project ID for this request.
* @param ProjectsEnableXpnResourceRequest $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function enableXpnResource($project, ProjectsEnableXpnResourceRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('enableXpnResource', [$params], Operation::class);
}
/**
* Returns the specified Project resource.
*
* To decrease latency for this method, you can optionally omit any unneeded
* information from the response by using a field mask. This practice is
* especially recommended for unused quota information (the `quotas` field). To
* exclude one or more fields, set your request's `fields` query parameter to
* only include the fields you need. For example, to only include the `id` and
* `selfLink` fields, add the query parameter `?fields=id,selfLink` to your
* request. (projects.get)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
* @return Project
* @throws \Google\Service\Exception
*/
public function get($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Project::class);
}
/**
* Gets the shared VPC host project that this project links to. May be empty if
* no link exists. (projects.getXpnHost)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
* @return Project
* @throws \Google\Service\Exception
*/
public function getXpnHost($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('getXpnHost', [$params], Project::class);
}
/**
* Gets service resources (a.k.a service project) associated with this host
* project. (projects.getXpnResources)
*
* @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. Most Compute resources support two types of filter expressions:
* expressions that support regular expressions and expressions that follow API
* improvement proposal AIP-160. These two types of filter expressions cannot be
* mixed in one request.
*
* 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 `=`, `!=`, `>`,
* `<`, `<=`, `>=` or `:`.
*
* For example, if you are filtering Compute Engine instances, you can exclude
* instances named `example-instance` by specifying `name != example-instance`.
*
* 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 onresource 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) ```
*
* If you want to use a regular expression, use the `eq` (equal) or `ne` (not
* equal) operator against a single un-parenthesized expression with or without
* quotes or against multiple parenthesized expressions. Examples:
*
* `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'`
* `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2
* ne "literal")`
*
* The literal value is interpreted as a regular expression using GoogleRE2
* library syntax. The literal value must match the entire field.
*
* For example, to filter for instances that do not end with name "instance",
* you would use `name ne .*instance`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @return ProjectsGetXpnResources
* @throws \Google\Service\Exception
*/
public function getXpnResources($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('getXpnResources', [$params], ProjectsGetXpnResources::class);
}
/**
* Lists all shared VPC host projects visible to the user in an organization.
* (projects.listXpnHosts)
*
* @param string $project Project ID for this request.
* @param ProjectsListXpnHostsRequest $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string filter 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. These two types of filter expressions cannot be
* mixed in one request.
*
* 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 `=`, `!=`, `>`,
* `<`, `<=`, `>=` or `:`.
*
* For example, if you are filtering Compute Engine instances, you can exclude
* instances named `example-instance` by specifying `name != example-instance`.
*
* 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 onresource 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) ```
*
* If you want to use a regular expression, use the `eq` (equal) or `ne` (not
* equal) operator against a single un-parenthesized expression with or without
* quotes or against multiple parenthesized expressions. Examples:
*
* `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'`
* `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2
* ne "literal")`
*
* The literal value is interpreted as a regular expression using GoogleRE2
* library syntax. The literal value must match the entire field.
*
* For example, to filter for instances that do not end with name "instance",
* you would use `name ne .*instance`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @return XpnHostList
* @throws \Google\Service\Exception
*/
public function listXpnHosts($project, ProjectsListXpnHostsRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('listXpnHosts', [$params], XpnHostList::class);
}
/**
* Moves a persistent disk from one zone to another. *Note*: The moveDisk API
* will be deprecated on September 29, 2026.
*
* Starting September 29, 2025, you can't use the moveDisk API on new projects.
* To move a disk to a different region or zone, follow the steps in [Change the
* location of a disk](https://cloud.google.com/compute/docs/disks/migrate-to-
* hyperdisk#migrate-to-hd).
*
* Projects that already use the moveDisk API can continue usage until September
* 29, 2026.
*
* Starting November 1, 2025, API responses will include a warning message in
* the response body about the upcoming deprecation. You can skip the message to
* continue using the service without interruption. (projects.moveDisk)
*
* @param string $project Project ID for this request.
* @param DiskMoveRequest $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function moveDisk($project, DiskMoveRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('moveDisk', [$params], Operation::class);
}
/**
* Moves an instance and its attached persistent disks from one zone to another.
* *Note*: Moving VMs or disks by using this method might cause unexpected
* behavior. For more information, see the [known
* issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_t
* he_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This
* method is deprecated. See [moving instance across
* zones](/compute/docs/instances/moving-instance-across-zones) instead.
* (projects.moveInstance)
*
* @param string $project Project ID for this request.
* @param InstanceMoveRequest $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function moveInstance($project, InstanceMoveRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('moveInstance', [$params], Operation::class);
}
/**
* Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the
* billing account of the project must be subscribed to Cloud Armor Enterprise.
* See Subscribing to Cloud Armor Enterprise for more information.
* (projects.setCloudArmorTier)
*
* @param string $project Project ID for this request.
* @param ProjectsSetCloudArmorTierRequest $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function setCloudArmorTier($project, ProjectsSetCloudArmorTierRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setCloudArmorTier', [$params], Operation::class);
}
/**
* Sets metadata common to all instances within the specified project using the
* data included in the request. (projects.setCommonInstanceMetadata)
*
* @param string $project Project ID for this request.
* @param Metadata $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function setCommonInstanceMetadata($project, Metadata $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setCommonInstanceMetadata', [$params], Operation::class);
}
/**
* Sets the default network tier of the project. The default network tier is
* used when an address/forwardingRule/instance is created without specifying
* the network tier field. (projects.setDefaultNetworkTier)
*
* @param string $project Project ID for this request.
* @param ProjectsSetDefaultNetworkTierRequest $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function setDefaultNetworkTier($project, ProjectsSetDefaultNetworkTierRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setDefaultNetworkTier', [$params], Operation::class);
}
/**
* Enables the usage export feature and sets theusage export bucket where
* reports are stored. If you provide an empty request body using this method,
* the usage export feature will be disabled. (projects.setUsageExportBucket)
*
* @param string $project Project ID for this request.
* @param UsageExportLocation $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId 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).
* @return Operation
* @throws \Google\Service\Exception
*/
public function setUsageExportBucket($project, UsageExportLocation $postBody, $optParams = [])
{
$params = ['project' => $project, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setUsageExportBucket', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Projects::class, 'Google_Service_Compute_Resource_Projects');
← Back