Class PolicyTag (1.51.0)

public final class PolicyTag extends GeneratedMessageV3 implements PolicyTagOrBuilder

Denotes one policy tag in a taxonomy, for example, SSN.

Policy tags can be defined in a hierarchy. For example:


Geolocation

LatLong
City
ZipCode

Where the "Geolocation" policy tag contains three children.

Protobuf type google.cloud.datacatalog.v1.PolicyTag

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PolicyTag

Implements

PolicyTagOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CHILD_POLICY_TAGS_FIELD_NUMBER

public static final int CHILD_POLICY_TAGS_FIELD_NUMBER

Field Value
Type	Description
`int`

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

PARENT_POLICY_TAG_FIELD_NUMBER

public static final int PARENT_POLICY_TAG_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static PolicyTag getDefaultInstance()

Returns
Type	Description
`PolicyTag`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static PolicyTag.Builder newBuilder()

Returns
Type	Description
`PolicyTag.Builder`

newBuilder(PolicyTag prototype)

public static PolicyTag.Builder newBuilder(PolicyTag prototype)

Parameter
Name	Description
`prototype`	`PolicyTag`

Returns
Type	Description
`PolicyTag.Builder`

parseDelimitedFrom(InputStream input)

public static PolicyTag parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicyTag parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static PolicyTag parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PolicyTag parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static PolicyTag parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PolicyTag parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static PolicyTag parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicyTag parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static PolicyTag parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicyTag parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static PolicyTag parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PolicyTag parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicyTag`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<PolicyTag> parser()

Returns
Type	Description
`Parser<PolicyTag>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getChildPolicyTags(int index)

public String getChildPolicyTags(int index)

Output only. Resource names of child policy tags of this policy tag.

repeated string child_policy_tags = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The childPolicyTags at the given index.

getChildPolicyTagsBytes(int index)

public ByteString getChildPolicyTagsBytes(int index)

Output only. Resource names of child policy tags of this policy tag.

repeated string child_policy_tags = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the childPolicyTags at the given index.

getChildPolicyTagsCount()

public int getChildPolicyTagsCount()

Output only. Resource names of child policy tags of this policy tag.

repeated string child_policy_tags = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The count of childPolicyTags.

getChildPolicyTagsList()

public ProtocolStringList getChildPolicyTagsList()

Output only. Resource names of child policy tags of this policy tag.

repeated string child_policy_tags = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ProtocolStringList`	A list containing the childPolicyTags.

getDefaultInstanceForType()

public PolicyTag getDefaultInstanceForType()

Returns
Type	Description
`PolicyTag`

getDescription()

public String getDescription()

Description of this policy tag. If not set, defaults to empty.

The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

string description = 3;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of this policy tag. If not set, defaults to empty.

The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

string description = 3;

Returns
Type	Description
`ByteString`	The bytes for description.

getDisplayName()

public String getDisplayName()

Required. User-defined name of this policy tag.

The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. User-defined name of this policy tag.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for displayName.

getName()

public String getName()

Identifier. Resource name of this policy tag in the URL format.

The policy tag manager generates unique taxonomy IDs and policy tag IDs.

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

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name of this policy tag in the URL format.

The policy tag manager generates unique taxonomy IDs and policy tag IDs.

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

Returns
Type	Description
`ByteString`	The bytes for name.

getParentPolicyTag()

public String getParentPolicyTag()

Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.

For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.

string parent_policy_tag = 4;

Returns
Type	Description
`String`	The parentPolicyTag.

getParentPolicyTagBytes()

public ByteString getParentPolicyTagBytes()

Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.

For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.

string parent_policy_tag = 4;

Returns
Type	Description
`ByteString`	The bytes for parentPolicyTag.

getParserForType()

public Parser<PolicyTag> getParserForType()

Returns
Type	Description
`Parser<PolicyTag>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public PolicyTag.Builder newBuilderForType()

Returns
Type	Description
`PolicyTag.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PolicyTag.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`PolicyTag.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public PolicyTag.Builder toBuilder()

Returns
Type	Description
`PolicyTag.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`