Package com.google.cloud.resourcemanager.v3

Interface TagKeyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TagKey, TagKey.Builder
    public interface TagKeyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Immutable. The resource name for a TagKey. Must be in the format
 `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for
 the TagKey.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Immutable. The resource name for a TagKey. Must be in the format
 `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for
 the TagKey.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for name.

      • getParent

        String getParent()
         Immutable. The resource name of the TagKey's parent. A TagKey can be
 parented by an Organization or a Project. For a TagKey parented by an
 Organization, its parent must be in the form `organizations/{org_id}`. For
 a TagKey parented by a Project, its parent can be in the form
 `projects/{project_id}` or `projects/{project_number}`.
        string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Immutable. The resource name of the TagKey's parent. A TagKey can be
 parented by an Organization or a Project. For a TagKey parented by an
 Organization, its parent must be in the form `organizations/{org_id}`. For
 a TagKey parented by a Project, its parent can be in the form
 `projects/{project_id}` or `projects/{project_number}`.
        string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for parent.

      • getShortName

        String getShortName()
         Required. Immutable. The user friendly name for a TagKey. The short name
 should be unique for TagKeys within the same tag namespace.

 The short name must be 1-63 characters, beginning and ending with
 an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
 dots (.), and alphanumerics between.
        string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The shortName.

      • getShortNameBytes

        com.google.protobuf.ByteString getShortNameBytes()
         Required. Immutable. The user friendly name for a TagKey. The short name
 should be unique for TagKeys within the same tag namespace.

 The short name must be 1-63 characters, beginning and ending with
 an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
 dots (.), and alphanumerics between.
        string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for shortName.

      • getNamespacedName

        String getNamespacedName()
         Output only. Immutable. Namespaced name of the TagKey.
        string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The namespacedName.

      • getNamespacedNameBytes

        com.google.protobuf.ByteString getNamespacedNameBytes()
         Output only. Immutable. Namespaced name of the TagKey.
        string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for namespacedName.

      • getDescription

        String getDescription()
         Optional. User-assigned description of the TagKey. Must not exceed 256
 characters.

 Read-write.
        string description = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Optional. User-assigned description of the TagKey. Must not exceed 256
 characters.

 Read-write.
        string description = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for description.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. Update time.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. Update time.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Update time.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getEtag

        String getEtag()
         Optional. Entity tag which users can pass to prevent race conditions. This
 field is always set in server responses. See UpdateTagKeyRequest for
 details.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The etag.

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         Optional. Entity tag which users can pass to prevent race conditions. This
 field is always set in server responses. See UpdateTagKeyRequest for
 details.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for etag.

      • getPurposeValue

        int getPurposeValue()
         Optional. A purpose denotes that this Tag is intended for use in policies
 of a specific policy engine, and will involve that policy engine in
 management operations involving this Tag. A purpose does not grant a
 policy engine exclusive rights to the Tag, and it may be referenced by
 other policy engines.

 A purpose cannot be changed once set.
        .google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for purpose.

      • getPurpose

        Purpose getPurpose()
         Optional. A purpose denotes that this Tag is intended for use in policies
 of a specific policy engine, and will involve that policy engine in
 management operations involving this Tag. A purpose does not grant a
 policy engine exclusive rights to the Tag, and it may be referenced by
 other policy engines.

 A purpose cannot be changed once set.
        .google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The purpose.

      • getPurposeDataCount

        int getPurposeDataCount()
         Optional. Purpose data corresponds to the policy system that the tag is
 intended for. See documentation for `Purpose` for formatting of this field.

 Purpose data cannot be changed once set.
        map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];

      • containsPurposeData

        boolean containsPurposeData​(String key)
         Optional. Purpose data corresponds to the policy system that the tag is
 intended for. See documentation for `Purpose` for formatting of this field.

 Purpose data cannot be changed once set.
        map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];

      • getPurposeDataMap

        Map<String,​String> getPurposeDataMap()
         Optional. Purpose data corresponds to the policy system that the tag is
 intended for. See documentation for `Purpose` for formatting of this field.

 Purpose data cannot be changed once set.
        map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];

      • getPurposeDataOrDefault

        String getPurposeDataOrDefault​(String key,
                               String defaultValue)
         Optional. Purpose data corresponds to the policy system that the tag is
 intended for. See documentation for `Purpose` for formatting of this field.

 Purpose data cannot be changed once set.
        map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];

      • getPurposeDataOrThrow

        String getPurposeDataOrThrow​(String key)
         Optional. Purpose data corresponds to the policy system that the tag is
 intended for. See documentation for `Purpose` for formatting of this field.

 Purpose data cannot be changed once set.
        map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];