Package com.google.cloud.resourcemanager.v3

Class TagKey

  • All Implemented Interfaces:
    TagKeyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TagKey
extends com.google.protobuf.GeneratedMessageV3
implements TagKeyOrBuilder
     A TagKey, used to group a set of TagValues.
    Protobuf type google.cloud.resourcemanager.v3.TagKey
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public 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];
        Specified by:
        getName in interface TagKeyOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface TagKeyOrBuilder
        Returns:
        The bytes for name.

      • getParent

        public 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];
        Specified by:
        getParent in interface TagKeyOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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];
        Specified by:
        getParentBytes in interface TagKeyOrBuilder
        Returns:
        The bytes for parent.

      • getShortName

        public 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];
        Specified by:
        getShortName in interface TagKeyOrBuilder
        Returns:
        The shortName.

      • getShortNameBytes

        public 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];
        Specified by:
        getShortNameBytes in interface TagKeyOrBuilder
        Returns:
        The bytes for shortName.

      • getNamespacedName

        public 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];
        Specified by:
        getNamespacedName in interface TagKeyOrBuilder
        Returns:
        The namespacedName.

      • getNamespacedNameBytes

        public 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];
        Specified by:
        getNamespacedNameBytes in interface TagKeyOrBuilder
        Returns:
        The bytes for namespacedName.

      • getDescription

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

 Read-write.
        string description = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface TagKeyOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public 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];
        Specified by:
        getDescriptionBytes in interface TagKeyOrBuilder
        Returns:
        The bytes for description.

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface TagKeyOrBuilder

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Update time.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface TagKeyOrBuilder

      • getEtag

        public 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];
        Specified by:
        getEtag in interface TagKeyOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public 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];
        Specified by:
        getEtagBytes in interface TagKeyOrBuilder
        Returns:
        The bytes for etag.

      • getPurposeValue

        public 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];
        Specified by:
        getPurposeValue in interface TagKeyOrBuilder
        Returns:
        The enum numeric value on the wire for purpose.

      • getPurpose

        public 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];
        Specified by:
        getPurpose in interface TagKeyOrBuilder
        Returns:
        The purpose.

      • getPurposeDataCount

        public int getPurposeDataCount()
        Description copied from interface: TagKeyOrBuilder
         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];
        Specified by:
        getPurposeDataCount in interface TagKeyOrBuilder

      • containsPurposeData

        public 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];
        Specified by:
        containsPurposeData in interface TagKeyOrBuilder

      • getPurposeDataMap

        public 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];
        Specified by:
        getPurposeDataMap in interface TagKeyOrBuilder

      • getPurposeDataOrDefault

        public 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];
        Specified by:
        getPurposeDataOrDefault in interface TagKeyOrBuilder

      • getPurposeDataOrThrow

        public 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];
        Specified by:
        getPurposeDataOrThrow in interface TagKeyOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static TagKey parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TagKey parseFrom​(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TagKey parseFrom​(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TagKey parseFrom​(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TagKey parseFrom​(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TagKey parseFrom​(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TagKey parseFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Throws:
        IOException

      • newBuilderForType

        public TagKey.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TagKey.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TagKey.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static TagKey getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<TagKey> parser()

      • getParserForType

        public com.google.protobuf.Parser<TagKey> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TagKey getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder