Interface ParameterOrBuilder (0.43.0) 

public interface ParameterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsTags(String key)

public abstract boolean containsTags(String key)

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: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code> Tags are used to organize and group resources.

Tags can be used to control policy evaluation for the resource.

map<string, string> tags = 8 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getFormat()

public abstract ParameterFormat getFormat()

Optional. Specifies the format of a Parameter.

.google.cloud.parametermanager.v1.ParameterFormat format = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ParameterFormat

The format.

getFormatValue()

public abstract int getFormatValue()

Optional. Specifies the format of a Parameter.

.google.cloud.parametermanager.v1.ParameterFormat format = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for format.

getKmsKey()

public abstract String 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/*.

optional string kms_key = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public abstract ByteString getKmsKeyBytes()

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

optional string kms_key = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKey.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPolicyMember()

public abstract ResourcePolicyMember getPolicyMember()

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

.google.iam.v1.ResourcePolicyMember policy_member = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.iam.v1.ResourcePolicyMember

The policyMember.

getPolicyMemberOrBuilder()

public abstract ResourcePolicyMemberOrBuilder getPolicyMemberOrBuilder()

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

.google.iam.v1.ResourcePolicyMember policy_member = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.iam.v1.ResourcePolicyMemberOrBuilder

getTags() (deprecated)

public abstract Map<String,String> getTags()

Use #getTagsMap() instead.

Returns
Type Description
Map<String,String>

getTagsCount()

public abstract int getTagsCount()

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: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code> Tags are used to organize and group resources.

Tags can be used to control policy evaluation for the resource.

map<string, string> tags = 8 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTagsMap()

public abstract Map<String,String> getTagsMap()

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: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code> Tags are used to organize and group resources.

Tags can be used to control policy evaluation for the resource.

map<string, string> tags = 8 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getTagsOrDefault(String key, String defaultValue)

public abstract String getTagsOrDefault(String key, String defaultValue)

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: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code> Tags are used to organize and group resources.

Tags can be used to control policy evaluation for the resource.

map<string, string> tags = 8 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getTagsOrThrow(String key)

public abstract String getTagsOrThrow(String key)

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: <code><code> "123/environment": "production", "123/costCenter": "marketing", </code></code> Tags are used to organize and group resources.

Tags can be used to control policy evaluation for the resource.

map<string, string> tags = 8 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasKmsKey()

public abstract boolean hasKmsKey()

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

optional string kms_key = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the kmsKey field is set.

hasPolicyMember()

public abstract boolean hasPolicyMember()

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

.google.iam.v1.ResourcePolicyMember policy_member = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the policyMember field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.