Package com.google.cloud.resourcemanager.v3

Class EffectiveTag

  • All Implemented Interfaces:
    EffectiveTagOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class EffectiveTag
extends com.google.protobuf.GeneratedMessageV3
implements EffectiveTagOrBuilder
     An EffectiveTag represents a tag that applies to a resource during policy
 evaluation. Tags can be either directly bound to a resource or inherited from
 its ancestor. EffectiveTag contains the name and
 namespaced_name of the tag value and tag key, with additional fields of
 `inherited` to indicate the inheritance status of the effective tag.
    Protobuf type google.cloud.resourcemanager.v3.EffectiveTag
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  EffectiveTag.Builder
      An EffectiveTag represents a tag that applies to a resource during policy evaluation.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • NAMESPACED_TAG_VALUE_FIELD_NUMBER

        public static final int NAMESPACED_TAG_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NAMESPACED_TAG_KEY_FIELD_NUMBER

        public static final int NAMESPACED_TAG_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TAG_KEY_PARENT_NAME_FIELD_NUMBER

        public static final int TAG_KEY_PARENT_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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()

      • internalGetFieldAccessorTable

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

      • getTagValue

        public String getTagValue()
         Resource name for TagValue in the format `tagValues/456`.
        string tag_value = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTagValue in interface EffectiveTagOrBuilder
        Returns:
        The tagValue.

      • getTagValueBytes

        public com.google.protobuf.ByteString getTagValueBytes()
         Resource name for TagValue in the format `tagValues/456`.
        string tag_value = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTagValueBytes in interface EffectiveTagOrBuilder
        Returns:
        The bytes for tagValue.

      • getNamespacedTagValue

        public String getNamespacedTagValue()
         The namespaced name of the TagValue. Can be in the form
 `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
 `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
 `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
        string namespaced_tag_value = 2;
        Specified by:
        getNamespacedTagValue in interface EffectiveTagOrBuilder
        Returns:
        The namespacedTagValue.

      • getNamespacedTagValueBytes

        public com.google.protobuf.ByteString getNamespacedTagValueBytes()
         The namespaced name of the TagValue. Can be in the form
 `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or
 `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or
 `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
        string namespaced_tag_value = 2;
        Specified by:
        getNamespacedTagValueBytes in interface EffectiveTagOrBuilder
        Returns:
        The bytes for namespacedTagValue.

      • getTagKey

        public String getTagKey()
         The name of the TagKey, in the format `tagKeys/{id}`, such as
 `tagKeys/123`.
        string tag_key = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTagKey in interface EffectiveTagOrBuilder
        Returns:
        The tagKey.

      • getTagKeyBytes

        public com.google.protobuf.ByteString getTagKeyBytes()
         The name of the TagKey, in the format `tagKeys/{id}`, such as
 `tagKeys/123`.
        string tag_key = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTagKeyBytes in interface EffectiveTagOrBuilder
        Returns:
        The bytes for tagKey.

      • getNamespacedTagKey

        public String getNamespacedTagKey()
         The namespaced name of the TagKey. Can be in the form
 `{organization_id}/{tag_key_short_name}` or
 `{project_id}/{tag_key_short_name}` or
 `{project_number}/{tag_key_short_name}`.
        string namespaced_tag_key = 4;
        Specified by:
        getNamespacedTagKey in interface EffectiveTagOrBuilder
        Returns:
        The namespacedTagKey.

      • getNamespacedTagKeyBytes

        public com.google.protobuf.ByteString getNamespacedTagKeyBytes()
         The namespaced name of the TagKey. Can be in the form
 `{organization_id}/{tag_key_short_name}` or
 `{project_id}/{tag_key_short_name}` or
 `{project_number}/{tag_key_short_name}`.
        string namespaced_tag_key = 4;
        Specified by:
        getNamespacedTagKeyBytes in interface EffectiveTagOrBuilder
        Returns:
        The bytes for namespacedTagKey.

      • getTagKeyParentName

        public String getTagKeyParentName()
         The parent name of the tag key.
 Must be in the format `organizations/{organization_id}` or
 `projects/{project_number}`
        string tag_key_parent_name = 6;
        Specified by:
        getTagKeyParentName in interface EffectiveTagOrBuilder
        Returns:
        The tagKeyParentName.

      • getTagKeyParentNameBytes

        public com.google.protobuf.ByteString getTagKeyParentNameBytes()
         The parent name of the tag key.
 Must be in the format `organizations/{organization_id}` or
 `projects/{project_number}`
        string tag_key_parent_name = 6;
        Specified by:
        getTagKeyParentNameBytes in interface EffectiveTagOrBuilder
        Returns:
        The bytes for tagKeyParentName.

      • getInherited

        public boolean getInherited()
         Indicates the inheritance status of a tag value
 attached to the given resource. If the tag value is inherited from one of
 the resource's ancestors, inherited will be true. If false, then the tag
 value is directly attached to the resource, inherited will be false.
        bool inherited = 5;
        Specified by:
        getInherited in interface EffectiveTagOrBuilder
        Returns:
        The inherited.

      • 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 EffectiveTag parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static EffectiveTag getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<EffectiveTag> 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 EffectiveTag getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder