parameters

Creates, updates, deletes, gets or lists a parameters resource.

Overview

Name	parameters
Type	Resource
Id	google.parametermanager.parameters

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. [Output only] The resource name of the Parameter in the format projects/*/locations/*/parameters/*.
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
format	string	Optional. Specifies the format of a Parameter.
kmsKey	string	Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
labels	object	Optional. Labels as key value pairs
policyMember	object	Output only. [Output-only] policy member strings of a Google Cloud resource. (id: ResourcePolicyMember)
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp

list

Successful response

Name	Datatype	Description
name	string	Identifier. [Output only] The resource name of the Parameter in the format projects/*/locations/*/parameters/*.
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
format	string	Optional. Specifies the format of a Parameter.
kmsKey	string	Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
labels	object	Optional. Labels as key value pairs
policyMember	object	Output only. [Output-only] policy member strings of a Google Cloud resource. (id: ResourcePolicyMember)
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, parametersId		Gets details of a single Parameter.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Parameters in a given project and location.
create	insert	projectsId, locationsId	parameterId, requestId	Creates a new Parameter in a given project and location.
patch	update	projectsId, locationsId, parametersId	updateMask, requestId	Updates a single Parameter.
delete	delete	projectsId, locationsId, parametersId	requestId	Deletes a single Parameter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
parametersId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
parameterId	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Parameter.

SELECT
name,
createTime,
format,
kmsKey,
labels,
policyMember,
updateTime
FROM google.parametermanager.parameters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND parametersId = '{{ parametersId }}' -- required;

list

Lists Parameters in a given project and location.

SELECT
name,
createTime,
format,
kmsKey,
labels,
policyMember,
updateTime
FROM google.parametermanager.parameters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new Parameter in a given project and location.

INSERT INTO google.parametermanager.parameters (
data__name,
data__labels,
data__format,
data__kmsKey,
projectsId,
locationsId,
parameterId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ format }}',
'{{ kmsKey }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ parameterId }}',
'{{ requestId }}'
RETURNING
name,
createTime,
format,
kmsKey,
labels,
policyMember,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: parameters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the parameters resource.
    - name: locationsId
      value: string
      description: Required parameter for the parameters resource.
    - name: name
      value: string
      description: >
        Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs
        
    - name: format
      value: string
      description: >
        Optional. Specifies the format of a Parameter.
        
      valid_values: ['PARAMETER_FORMAT_UNSPECIFIED', 'UNFORMATTED', 'YAML', 'JSON']
    - name: kmsKey
      value: string
      description: >
        Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
        
    - name: parameterId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates a single Parameter.

UPDATE google.parametermanager.parameters
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__format = '{{ format }}',
data__kmsKey = '{{ kmsKey }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND parametersId = '{{ parametersId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
createTime,
format,
kmsKey,
labels,
policyMember,
updateTime;

DELETE examples

delete

Deletes a single Parameter.

DELETE FROM google.parametermanager.parameters
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND parametersId = '{{ parametersId }}' --required
AND requestId = '{{ requestId }}';