1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Compute
  7. \
  8. Resource
  9. \
  10. UrlMaps

UrlMaps

class UrlMaps extends Resource (View source)

The "urlMaps" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $urlMaps = $computeService->urlMaps;

Methods

UrlMapsAggregatedList
aggregatedList(string $project, array $optParams = [])

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. (urlMaps.aggregatedList)

Operation
delete(string $project, string $urlMap, array $optParams = [])

Deletes the specified UrlMap resource. (urlMaps.delete)

UrlMap
get(string $project, string $urlMap, array $optParams = [])

Returns the specified UrlMap resource. (urlMaps.get)

Operation
insert(string $project, UrlMap $postBody, array $optParams = [])

Creates a UrlMap resource in the specified project using the data included in the request. (urlMaps.insert)

Operation
invalidateCache(string $project, string $urlMap, CacheInvalidationRule $postBody, array $optParams = [])

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

UrlMapList
listUrlMaps(string $project, array $optParams = [])

Retrieves the list of UrlMap resources available to the specified project.

Operation
patch(string $project, string $urlMap, UrlMap $postBody, array $optParams = [])

Patches the specified UrlMap resource with the data included in the request.

Operation
update(string $project, string $urlMap, UrlMap $postBody, array $optParams = [])

Updates the specified UrlMap resource with the data included in the request.

UrlMapsValidateResponse
validate(string $project, string $urlMap, UrlMapsValidateRequest $postBody, array $optParams = [])

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Details

at line 112
UrlMapsAggregatedList aggregatedList(string $project, array $optParams = [])

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. (urlMaps.aggregatedList)

Parameters

string $project

Name of the project scoping this request.
array $optParams

Optional parameters.

Return Value

UrlMapsAggregatedList

Exceptions

Exception

at line 138
Operation delete(string $project, string $urlMap, array $optParams = [])

Deletes the specified UrlMap resource. (urlMaps.delete)

Parameters

string $project

Project ID for this request.
string $urlMap

Name of the UrlMap resource to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 153
UrlMap get(string $project, string $urlMap, array $optParams = [])

Returns the specified UrlMap resource. (urlMaps.get)

Parameters

string $project

Project ID for this request.
string $urlMap

Name of the UrlMap resource to return.
array $optParams

Optional parameters.

Return Value

UrlMap

Exceptions

Exception

at line 180
Operation insert(string $project, UrlMap $postBody, array $optParams = [])

Creates a UrlMap resource in the specified project using the data included in the request. (urlMaps.insert)

Parameters

string $project

Project ID for this request.
UrlMap $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 210
Operation invalidateCache(string $project, string $urlMap, CacheInvalidationRule $postBody, array $optParams = [])

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

(urlMaps.invalidateCache)

Parameters

string $project

Project ID for this request.
string $urlMap

Name of the UrlMap scoping this request.
CacheInvalidationRule $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 279
UrlMapList listUrlMaps(string $project, array $optParams = [])

Retrieves the list of UrlMap resources available to the specified project.

(urlMaps.listUrlMaps)

Parameters

string $project

Project ID for this request.
array $optParams

Optional parameters.

Return Value

UrlMapList

Exceptions

Exception

at line 308
Operation patch(string $project, string $urlMap, UrlMap $postBody, array $optParams = [])

Patches the specified UrlMap resource with the data included in the request.

This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (urlMaps.patch)

Parameters

string $project

Project ID for this request.
string $urlMap

Name of the UrlMap resource to patch.
UrlMap $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 336
Operation update(string $project, string $urlMap, UrlMap $postBody, array $optParams = [])

Updates the specified UrlMap resource with the data included in the request.

(urlMaps.update)

Parameters

string $project

Project ID for this request.
string $urlMap

Name of the UrlMap resource to update.
UrlMap $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 354
UrlMapsValidateResponse validate(string $project, string $urlMap, UrlMapsValidateRequest $postBody, array $optParams = [])

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

(urlMaps.validate)

Parameters

string $project

Project ID for this request.
string $urlMap

Name of the UrlMap resource to be validated as.
UrlMapsValidateRequest $postBody
array $optParams

Optional parameters.

Return Value

UrlMapsValidateResponse

Exceptions

Exception