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

The "features" collection of methods. More...

Inheritance diagram for Google_Service_MapsEngine_TablesFeatures_Resource:
Google_Service_Resource

Public Member Functions

 batchDelete ($id, Google_Service_MapsEngine_FeaturesBatchDeleteRequest $postBody, $optParams=array())
 Delete all features matching the given IDs.
 
 batchInsert ($id, Google_Service_MapsEngine_FeaturesBatchInsertRequest $postBody, $optParams=array())
 Append features to an existing table.
 
 batchPatch ($id, Google_Service_MapsEngine_FeaturesBatchPatchRequest $postBody, $optParams=array())
 Update the supplied features.
 
 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($tableId, $id, $optParams=array())
 Return a single feature, given its ID.
 
 listTablesFeatures ($id, $optParams=array())
 Return all features readable by the current user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "features" collection of methods.

Typical usage is: $mapsengineService = new Google_Service_MapsEngine(...); $features = $mapsengineService->features;

Member Function Documentation

◆ batchDelete()

Google_Service_MapsEngine_TablesFeatures_Resource::batchDelete ( $id,
Google_Service_MapsEngine_FeaturesBatchDeleteRequest $postBody,
$optParams = array() )

Delete all features matching the given IDs.

(features.batchDelete)

Parameters
string$idThe ID of the table that contains the features to be deleted.
Google_FeaturesBatchDeleteRequest$postBody
array$optParamsOptional parameters.

◆ batchInsert()

Google_Service_MapsEngine_TablesFeatures_Resource::batchInsert ( $id,
Google_Service_MapsEngine_FeaturesBatchInsertRequest $postBody,
$optParams = array() )

Append features to an existing table.

A single batchInsert request can create:

  • Up to 50 features. - A combined total of 10 000 vertices. Feature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.

For more information about inserting features, read Creating features in the Google Maps Engine developer's guide. (features.batchInsert)

Parameters
string$idThe ID of the table to append the features to.
Google_FeaturesBatchInsertRequest$postBody
array$optParamsOptional parameters.

◆ batchPatch()

Google_Service_MapsEngine_TablesFeatures_Resource::batchPatch ( $id,
Google_Service_MapsEngine_FeaturesBatchPatchRequest $postBody,
$optParams = array() )

Update the supplied features.

A single batchPatch request can update:

  • Up to 50 features. - A combined total of 10 000 vertices. Feature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.

Feature updates use HTTP PATCH semantics:

  • A supplied value replaces an existing value (if any) in that field. - Omitted fields remain unchanged. - Complex values in geometries and properties must be replaced as atomic units. For example, providing just the coordinates of a geometry is not allowed; the complete geometry, including type, must be supplied. - Setting a property's value to null deletes that property. For more information about updating features, read Updating features in the Google Maps Engine developer's guide. (features.batchPatch)
Parameters
string$idThe ID of the table containing the features to be patched.
Google_FeaturesBatchPatchRequest$postBody
array$optParamsOptional parameters.

◆ 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

◆ get()

Google_Service_MapsEngine_TablesFeatures_Resource::get ( $tableId,
$id,
$optParams = array() )

Return a single feature, given its ID.

(features.get)

Parameters
string$tableIdThe ID of the table.
string$idThe ID of the feature to get.
array$optParamsOptional parameters.

@opt_param string version The table version to access. See Accessing Public Data for information. @opt_param string select A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.

Return values
Google_Service_MapsEngine_Feature

◆ listTablesFeatures()

Google_Service_MapsEngine_TablesFeatures_Resource::listTablesFeatures ( $id,
$optParams = array() )

Return all features readable by the current user.

(features.listTablesFeatures)

Parameters
string$idThe ID of the table to which these features belong.
array$optParamsOptional parameters.

@opt_param string orderBy An SQL-like order by clause used to sort results. If this parameter is not included, the order of features is undefined. @opt_param string intersects A geometry literal that specifies the spatial restriction of the query. @opt_param string maxResults The maximum number of items to include in the response, used for paging. The maximum supported value is 1000. @opt_param string pageToken The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. @opt_param string version The table version to access. See Accessing Public Data for information. @opt_param string limit The total number of features to return from the query, irrespective of the number of pages. @opt_param string include A comma separated list of optional data to include. Optional data available: schema. @opt_param string where An SQL-like predicate used to filter results. @opt_param string select A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.

Return values
Google_Service_MapsEngine_FeaturesListResponse

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