Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Compute_Snapshots_Resource Class Reference

The "snapshots" collection of methods. More...

Inheritance diagram for Google_Service_Compute_Snapshots_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($project, $snapshot, $optParams=array())
 Deletes the specified Snapshot resource.
 
 get ($project, $snapshot, $optParams=array())
 Returns the specified Snapshot resource.
 
 listSnapshots ($project, $optParams=array())
 Retrieves the list of Snapshot resources contained within the specified project.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "snapshots" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Compute_Snapshots_Resource::delete ( $project,
$snapshot,
$optParams = array() )

Deletes the specified Snapshot resource.

Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snaphots. (snapshots.delete)

Parameters
string$projectName of the project scoping this request.
string$snapshotName of the Snapshot resource to delete.
array$optParamsOptional parameters.
Return values
Google_Service_Compute_Operation

◆ get()

Google_Service_Compute_Snapshots_Resource::get ( $project,
$snapshot,
$optParams = array() )

Returns the specified Snapshot resource.

(snapshots.get)

Parameters
string$projectName of the project scoping this request.
string$snapshotName of the Snapshot resource to return.
array$optParamsOptional parameters.
Return values
Google_Service_Compute_Snapshot

◆ listSnapshots()

Google_Service_Compute_Snapshots_Resource::listSnapshots ( $project,
$optParams = array() )

Retrieves the list of Snapshot resources contained within the specified project.

(snapshots.listSnapshots)

Parameters
string$projectName of the project scoping this request.
array$optParamsOptional parameters.

@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.

Return values
Google_Service_Compute_SnapshotList

The documentation for this class was generated from the following file: