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

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.

Parameter
Name Description
data mixed

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getTags

Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

For example, a single resource can have the following tags:

  "123/environment": "production",
  "123/costCenter": "marketing",

Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource.

Returns
Type Description
Google\Protobuf\Internal\MapField

setTags

Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

For example, a single resource can have the following tags:

  "123/environment": "production",
  "123/costCenter": "marketing",

Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this