Documentation

Google_Service_Compute_Resource_Disks extends Google_Service_Resource
in package

The "disks" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
addResourcePolicies()  : Google_Service_Compute_Operation
Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
aggregatedList()  : Google_Service_Compute_DiskAggregatedList
Retrieves an aggregated list of persistent disks. (disks.aggregatedList)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
createSnapshot()  : Google_Service_Compute_Operation
Creates a snapshot of a specified persistent disk. (disks.createSnapshot)
delete()  : Google_Service_Compute_Operation
Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (disks.delete)
get()  : Google_Service_Compute_Disk
Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. (disks.get)
getIamPolicy()  : Google_Service_Compute_Policy
Gets the access control policy for a resource. May be empty if no such policy or resource exists. (disks.getIamPolicy)
insert()  : Google_Service_Compute_Operation
Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties.
listDisks()  : Google_Service_Compute_DiskList
Retrieves a list of persistent disks contained within the specified zone.
removeResourcePolicies()  : Google_Service_Compute_Operation
Removes resource policies from a disk. (disks.removeResourcePolicies)
resize()  : Google_Service_Compute_Operation
Resizes the specified persistent disk. You can only increase the size of the disk. (disks.resize)
setIamPolicy()  : Google_Service_Compute_Policy
Sets the access control policy on the specified resource. Replaces any existing policy. (disks.setIamPolicy)
setLabels()  : Google_Service_Compute_Operation
Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. (disks.setLabels)
testIamPermissions()  : Google_Service_Compute_TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
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 —

addResourcePolicies()

Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

public addResourcePolicies(string $project, string $zone, string $disk, Google_Service_Compute_DisksAddResourcePoliciesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation

(disks.addResourcePolicies)

Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$disk : string

The disk name for this request.

$postBody : Google_Service_Compute_DisksAddResourcePoliciesRequest
$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 —

aggregatedList()

Retrieves an aggregated list of persistent disks. (disks.aggregatedList)

public aggregatedList(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_DiskAggregatedList
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

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

Return values
Google_Service_Compute_DiskAggregatedList —

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

createSnapshot()

Creates a snapshot of a specified persistent disk. (disks.createSnapshot)

public createSnapshot(string $project, string $zone, string $disk, Google_Service_Compute_Snapshot $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$disk : string

Name of the persistent disk to snapshot.

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

Optional parameters.

Tags
opt_param

bool guestFlush [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

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 —

delete()

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (disks.delete)

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

Project ID for this request.

$zone : string

The name of the zone for this request.

$disk : string

Name of the persistent disk to delete.

$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 a specified persistent disk. Gets a list of available persistent disks by making a list() request. (disks.get)

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

Project ID for this request.

$zone : string

The name of the zone for this request.

$disk : string

Name of the persistent disk to return.

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

Optional parameters.

Return values
Google_Service_Compute_Disk —

getIamPolicy()

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (disks.getIamPolicy)

public getIamPolicy(string $project, string $zone, string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Policy
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$resource : string

Name or id of the resource for this request.

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

Optional parameters.

Tags
opt_param

int optionsRequestedPolicyVersion Requested IAM Policy version.

Return values
Google_Service_Compute_Policy —

insert()

Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties.

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

You can also create a disk that is larger than the default size by specifying the sizeGb property. (disks.insert)

Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$postBody : Google_Service_Compute_Disk
$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).

opt_param

string sourceImage Optional. Source image to restore onto a disk.

Return values
Google_Service_Compute_Operation —

listDisks()

Retrieves a list of persistent disks contained within the specified zone.

public listDisks(string $project, string $zone[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_DiskList

(disks.listDisks)

Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone 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_DiskList —

removeResourcePolicies()

Removes resource policies from a disk. (disks.removeResourcePolicies)

public removeResourcePolicies(string $project, string $zone, string $disk, Google_Service_Compute_DisksRemoveResourcePoliciesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$disk : string

The disk name for this request.

$postBody : Google_Service_Compute_DisksRemoveResourcePoliciesRequest
$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 —

resize()

Resizes the specified persistent disk. You can only increase the size of the disk. (disks.resize)

public resize(string $project, string $zone, string $disk, Google_Service_Compute_DisksResizeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$disk : string

The name of the persistent disk.

$postBody : Google_Service_Compute_DisksResizeRequest
$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 —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. (disks.setIamPolicy)

public setIamPolicy(string $project, string $zone, string $resource, Google_Service_Compute_ZoneSetPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Policy
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$resource : string

Name or id of the resource for this request.

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

Optional parameters.

Return values
Google_Service_Compute_Policy —

setLabels()

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. (disks.setLabels)

public setLabels(string $project, string $zone, string $resource, Google_Service_Compute_ZoneSetLabelsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$resource : string

Name or id of the resource for this request.

$postBody : Google_Service_Compute_ZoneSetLabelsRequest
$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 —

testIamPermissions()

Returns permissions that a caller has on the specified resource.

public testIamPermissions(string $project, string $zone, string $resource, Google_Service_Compute_TestPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_TestPermissionsResponse

(disks.testIamPermissions)

Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$resource : string

Name or id of the resource for this request.

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

Optional parameters.

Return values
Google_Service_Compute_TestPermissionsResponse —

convertToArrayAndStripNulls()

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

Search results