class ProjectsLocations extends Resource (View source)

The "locations" collection of methods.

Typical usage is:

 $cloudtasksService = new Google\Service\CloudTasks(...);
 $locations = $cloudtasksService->projects_locations;

Methods

get(string $name, array $optParams = [])

Gets information about a location. (locations.get)

getCmekConfig(string $name, array $optParams = [])

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

listProjectsLocations(string $name, array $optParams = [])

Lists information about the supported locations for this service.

updateCmekConfig(string $name, CmekConfig $postBody, array $optParams = [])

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config. (locations.updateCmekConfig)

Details

Location get(string $name, array $optParams = [])

Gets information about a location. (locations.get)

Parameters

string $name

Resource name for the location.

array $optParams

Optional parameters.

Return Value

Location

Exceptions

Exception

CmekConfig getCmekConfig(string $name, array $optParams = [])

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

(locations.getCmekConfig)

Parameters

string $name

Required. The config. For example: projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig`

array $optParams

Optional parameters.

Return Value

CmekConfig

Exceptions

Exception

ListLocationsResponse listProjectsLocations(string $name, array $optParams = [])

Lists information about the supported locations for this service.

(locations.listProjectsLocations)

Parameters

string $name

The resource that owns the locations collection, if applicable.

array $optParams

Optional parameters.

Return Value

ListLocationsResponse

Exceptions

Exception

CmekConfig updateCmekConfig(string $name, CmekConfig $postBody, array $optParams = [])

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config. (locations.updateCmekConfig)

Parameters

string $name

Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`

CmekConfig $postBody
array $optParams

Optional parameters.

Return Value

CmekConfig

Exceptions

Exception