Documentation

Google_Service_Compute_Resource_Projects extends Google_Service_Resource
in package

The "projects" collection of methods.

Typical usage is: $computeService = new Google_Service_Compute(...); $projects = $computeService->projects;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
disableXpnHost()  : Google_Service_Compute_Operation
Disable this project as a shared VPC host project. (projects.disableXpnHost)
disableXpnResource()  : Google_Service_Compute_Operation
Disable a service resource (also known as service project) associated with this host project. (projects.disableXpnResource)
enableXpnHost()  : Google_Service_Compute_Operation
Enable this project as a shared VPC host project. (projects.enableXpnHost)
enableXpnResource()  : Google_Service_Compute_Operation
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.
get()  : Google_Service_Compute_Project
Returns the specified Project resource. (projects.get)
getXpnHost()  : Google_Service_Compute_Project
Gets the shared VPC host project that this project links to. May be empty if no link exists. (projects.getXpnHost)
getXpnResources()  : Google_Service_Compute_ProjectsGetXpnResources
Gets service resources (a.k.a service project) associated with this host project. (projects.getXpnResources)
listXpnHosts()  : Google_Service_Compute_XpnHostList
Lists all shared VPC host projects visible to the user in an organization.
moveDisk()  : Google_Service_Compute_Operation
Moves a persistent disk from one zone to another. (projects.moveDisk)
moveInstance()  : Google_Service_Compute_Operation
Moves an instance and its attached persistent disks from one zone to another.
setCommonInstanceMetadata()  : Google_Service_Compute_Operation
Sets metadata common to all instances within the specified project using the data included in the request. (projects.setCommonInstanceMetadata)
setDefaultNetworkTier()  : Google_Service_Compute_Operation
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)
setUsageExportBucket()  : Google_Service_Compute_Operation
Enables the usage export feature and sets the usage 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)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

disableXpnHost()

Disable this project as a shared VPC host project. (projects.disableXpnHost)

public disableXpnHost(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

disableXpnResource()

Disable a service resource (also known as service project) associated with this host project. (projects.disableXpnResource)

public disableXpnResource(string $project, Google_Service_Compute_ProjectsDisableXpnResourceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$postBody : Google_Service_Compute_ProjectsDisableXpnResourceRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

enableXpnHost()

Enable this project as a shared VPC host project. (projects.enableXpnHost)

public enableXpnHost(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

enableXpnResource()

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.

public enableXpnResource(string $project, Google_Service_Compute_ProjectsEnableXpnResourceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation

(projects.enableXpnResource)

Parameters
$project : string

Project ID for this request.

$postBody : Google_Service_Compute_ProjectsEnableXpnResourceRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

get()

Returns the specified Project resource. (projects.get)

public get(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Project
Parameters
$project : string

Project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_Project —

getXpnHost()

Gets the shared VPC host project that this project links to. May be empty if no link exists. (projects.getXpnHost)

public getXpnHost(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Project
Parameters
$project : string

Project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_Project —

getXpnResources()

Gets service resources (a.k.a service project) associated with this host project. (projects.getXpnResources)

public getXpnResources(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_ProjectsGetXpnResources
Parameters
$project : string

Project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.

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 and the logic is the same as today.

Return values
Google_Service_Compute_ProjectsGetXpnResources —

listXpnHosts()

Lists all shared VPC host projects visible to the user in an organization.

public listXpnHosts(string $project, Google_Service_Compute_ProjectsListXpnHostsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_XpnHostList

(projects.listXpnHosts)

Parameters
$project : string

Project ID for this request.

$postBody : Google_Service_Compute_ProjectsListXpnHostsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.

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 and the logic is the same as today.

Return values
Google_Service_Compute_XpnHostList —

moveDisk()

Moves a persistent disk from one zone to another. (projects.moveDisk)

public moveDisk(string $project, Google_Service_Compute_DiskMoveRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$postBody : Google_Service_Compute_DiskMoveRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

moveInstance()

Moves an instance and its attached persistent disks from one zone to another.

public moveInstance(string $project, Google_Service_Compute_InstanceMoveRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation

(projects.moveInstance)

Parameters
$project : string

Project ID for this request.

$postBody : Google_Service_Compute_InstanceMoveRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

setCommonInstanceMetadata()

Sets metadata common to all instances within the specified project using the data included in the request. (projects.setCommonInstanceMetadata)

public setCommonInstanceMetadata(string $project, Google_Service_Compute_Metadata $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$postBody : Google_Service_Compute_Metadata
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

setDefaultNetworkTier()

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)

public setDefaultNetworkTier(string $project, Google_Service_Compute_ProjectsSetDefaultNetworkTierRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$postBody : Google_Service_Compute_ProjectsSetDefaultNetworkTierRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

setUsageExportBucket()

Enables the usage export feature and sets the usage 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)

public setUsageExportBucket(string $project, Google_Service_Compute_UsageExportLocation $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$postBody : Google_Service_Compute_UsageExportLocation
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 values
Google_Service_Compute_Operation —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results