Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Cloud Parameter Manager V1 Client - Class Parameter (0.5.1)

Reference documentation and code samples for the Google Cloud Parameter Manager V1 Client class Parameter.

Message describing Parameter resource

Generated from protobuf message google.cloud.parametermanager.v1.Parameter

Namespace

Google \ Cloud \ ParameterManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. [Output only] The resource name of the Parameter in the format `projects//locations//parameters/*`.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. [Output only] Create time stamp
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. [Output only] Update time stamp
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. Labels as key value pairs
`↳ format`	`int` Optional. Specifies the format of a Parameter.
`↳ policy_member`	`Google\Cloud\Iam\V1\ResourcePolicyMember` Output only. [Output-only] policy member strings of a Google Cloud resource.
`↳ kms_key`	`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/`.

getName

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

Returns
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. [Output only] Create time stamp

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. [Output only] Create time stamp

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. [Output only] Update time stamp

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. [Output only] Update time stamp

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

Optional. Labels as key value pairs

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. Labels as key value pairs

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getFormat

Optional. Specifies the format of a Parameter.

Returns
Type	Description
`int`	Enum of type ParameterFormat.

setFormat

Optional. Specifies the format of a Parameter.

Parameter
Name	Description
`var`	`int` Enum of type ParameterFormat.

Returns
Type	Description
`$this`

getPolicyMember

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

Returns
Type	Description
`Google\Cloud\Iam\V1\ResourcePolicyMember\|null`

hasPolicyMember

clearPolicyMember

setPolicyMember

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

Parameter
Name	Description
`var`	`Google\Cloud\Iam\V1\ResourcePolicyMember`

Returns
Type	Description
`$this`

getKmsKey

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

Returns
Type	Description
`string`

hasKmsKey

clearKmsKey

setKmsKey

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`