REST Resource: projects.locations.parameters

Resource: Parameter

Message describing Parameter resource

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "format": enum (ParameterFormat),
  "policyMember": {
    object (ResourcePolicyMember)
  },
  "kmsKey": string
}
Fields
name

string

Identifier. [Output only] The resource name of the Parameter in the format projects/*/locations/*/parameters/*.

createTime

string (Timestamp format)

Output only. [Output only] Create time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

format

enum (ParameterFormat)

Optional. Specifies the format of a Parameter.

policyMember

object (ResourcePolicyMember)

Output only. [Output-only] policy member strings of a Google Cloud resource.

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/*.

ParameterFormat

Option to specify the format of a Parameter resource (UNFORMATTED / YAML / JSON). This option is user specified at the time of creation of the resource and is immutable.

Enums
PARAMETER_FORMAT_UNSPECIFIED The default / unset value. The API will default to the UNFORMATTED format.
UNFORMATTED Unformatted.
YAML YAML format.
JSON JSON format.

ResourcePolicyMember

Output-only policy member strings of a Google Cloud resource's built-in identity.

JSON representation
{
  "iamPolicyNamePrincipal": string,
  "iamPolicyUidPrincipal": string
}
Fields
iamPolicyNamePrincipal

string

Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource.

Example: principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter

iamPolicyUidPrincipal

string

Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource

Example: principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5

Methods

create

Creates a new Parameter in a given project and location.

delete

Deletes a single Parameter.

get

Gets details of a single Parameter.

list

Lists Parameters in a given project and location.

patch

Updates a single Parameter.