Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_Compute_TargetInstances_Resource Class Reference

The "targetInstances" collection of methods. More...

Inheritance diagram for Google_Service_Compute_TargetInstances_Resource:
Google_Service_Resource

Public Member Functions

 aggregatedList ($project, $optParams=array())
 Retrieves the list of target instances grouped by scope.
 
 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($project, $zone, $targetInstance, $optParams=array())
 Deletes the specified TargetInstance resource.
 
 get ($project, $zone, $targetInstance, $optParams=array())
 Returns the specified TargetInstance resource.
 
 insert ($project, $zone, Google_Service_Compute_TargetInstance $postBody, $optParams=array())
 Creates a TargetInstance resource in the specified project and zone using the data included in the request.
 
 listTargetInstances ($project, $zone, $optParams=array())
 Retrieves the list of TargetInstance resources available to the specified project and zone.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "targetInstances" collection of methods.

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

Member Function Documentation

◆ aggregatedList()

Google_Service_Compute_TargetInstances_Resource::aggregatedList ( $project,
$optParams = array() )

Retrieves the list of target instances grouped by scope.

(targetInstances.aggregatedList)

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_TargetInstanceAggregatedList

◆ 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_TargetInstances_Resource::delete ( $project,
$zone,
$targetInstance,
$optParams = array() )

Deletes the specified TargetInstance resource.

(targetInstances.delete)

Parameters
string$projectName of the project scoping this request.
string$zoneName of the zone scoping this request.
string$targetInstanceName of the TargetInstance resource to delete.
array$optParamsOptional parameters.
Return values
Google_Service_Compute_Operation

◆ get()

Google_Service_Compute_TargetInstances_Resource::get ( $project,
$zone,
$targetInstance,
$optParams = array() )

Returns the specified TargetInstance resource.

(targetInstances.get)

Parameters
string$projectName of the project scoping this request.
string$zoneName of the zone scoping this request.
string$targetInstanceName of the TargetInstance resource to return.
array$optParamsOptional parameters.
Return values
Google_Service_Compute_TargetInstance

◆ insert()

Google_Service_Compute_TargetInstances_Resource::insert ( $project,
$zone,
Google_Service_Compute_TargetInstance $postBody,
$optParams = array() )

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

(targetInstances.insert)

Parameters
string$projectName of the project scoping this request.
string$zoneName of the zone scoping this request.
Google_TargetInstance$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Compute_Operation

◆ listTargetInstances()

Google_Service_Compute_TargetInstances_Resource::listTargetInstances ( $project,
$zone,
$optParams = array() )

Retrieves the list of TargetInstance resources available to the specified project and zone.

(targetInstances.listTargetInstances)

Parameters
string$projectName of the project scoping this request.
string$zoneName of the zone 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_TargetInstanceList

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