Class SerializedTaxonomy (1.54.0)

public final class SerializedTaxonomy extends GeneratedMessageV3 implements SerializedTaxonomyOrBuilder

Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.

Protobuf type google.cloud.datacatalog.v1beta1.SerializedTaxonomy

Static Fields

ACTIVATED_POLICY_TYPES_FIELD_NUMBER

public static final int ACTIVATED_POLICY_TYPES_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

POLICY_TAGS_FIELD_NUMBER

public static final int POLICY_TAGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SerializedTaxonomy getDefaultInstance()
Returns
Type Description
SerializedTaxonomy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SerializedTaxonomy.Builder newBuilder()
Returns
Type Description
SerializedTaxonomy.Builder

newBuilder(SerializedTaxonomy prototype)

public static SerializedTaxonomy.Builder newBuilder(SerializedTaxonomy prototype)
Parameter
Name Description
prototype SerializedTaxonomy
Returns
Type Description
SerializedTaxonomy.Builder

parseDelimitedFrom(InputStream input)

public static SerializedTaxonomy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SerializedTaxonomy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SerializedTaxonomy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SerializedTaxonomy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SerializedTaxonomy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SerializedTaxonomy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SerializedTaxonomy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SerializedTaxonomy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SerializedTaxonomy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SerializedTaxonomy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SerializedTaxonomy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SerializedTaxonomy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SerializedTaxonomy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SerializedTaxonomy> parser()
Returns
Type Description
Parser<SerializedTaxonomy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActivatedPolicyTypes(int index)

public Taxonomy.PolicyType getActivatedPolicyTypes(int index)

A list of policy types that are activated for a taxonomy.

repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Taxonomy.PolicyType

The activatedPolicyTypes at the given index.

getActivatedPolicyTypesCount()

public int getActivatedPolicyTypesCount()

A list of policy types that are activated for a taxonomy.

repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 4;

Returns
Type Description
int

The count of activatedPolicyTypes.

getActivatedPolicyTypesList()

public List<Taxonomy.PolicyType> getActivatedPolicyTypesList()

A list of policy types that are activated for a taxonomy.

repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 4;

Returns
Type Description
List<PolicyType>

A list containing the activatedPolicyTypes.

getActivatedPolicyTypesValue(int index)

public int getActivatedPolicyTypesValue(int index)

A list of policy types that are activated for a taxonomy.

repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of activatedPolicyTypes at the given index.

getActivatedPolicyTypesValueList()

public List<Integer> getActivatedPolicyTypesValueList()

A list of policy types that are activated for a taxonomy.

repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 4;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for activatedPolicyTypes.

getDefaultInstanceForType()

public SerializedTaxonomy getDefaultInstanceForType()
Returns
Type Description
SerializedTaxonomy

getDescription()

public String getDescription()

Description of the serialized taxonomy. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the serialized taxonomy. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. Display name of the taxonomy. Max 200 bytes when encoded in UTF-8.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name of the taxonomy. Max 200 bytes when encoded in UTF-8.

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

Returns
Type Description
ByteString

The bytes for displayName.

getParserForType()

public Parser<SerializedTaxonomy> getParserForType()
Returns
Type Description
Parser<SerializedTaxonomy>
Overrides

getPolicyTags(int index)

public SerializedPolicyTag getPolicyTags(int index)

Top level policy tags associated with the taxonomy if any.

repeated .google.cloud.datacatalog.v1beta1.SerializedPolicyTag policy_tags = 3;

Parameter
Name Description
index int
Returns
Type Description
SerializedPolicyTag

getPolicyTagsCount()

public int getPolicyTagsCount()

Top level policy tags associated with the taxonomy if any.

repeated .google.cloud.datacatalog.v1beta1.SerializedPolicyTag policy_tags = 3;

Returns
Type Description
int

getPolicyTagsList()

public List<SerializedPolicyTag> getPolicyTagsList()

Top level policy tags associated with the taxonomy if any.

repeated .google.cloud.datacatalog.v1beta1.SerializedPolicyTag policy_tags = 3;

Returns
Type Description
List<SerializedPolicyTag>

getPolicyTagsOrBuilder(int index)

public SerializedPolicyTagOrBuilder getPolicyTagsOrBuilder(int index)

Top level policy tags associated with the taxonomy if any.

repeated .google.cloud.datacatalog.v1beta1.SerializedPolicyTag policy_tags = 3;

Parameter
Name Description
index int
Returns
Type Description
SerializedPolicyTagOrBuilder

getPolicyTagsOrBuilderList()

public List<? extends SerializedPolicyTagOrBuilder> getPolicyTagsOrBuilderList()

Top level policy tags associated with the taxonomy if any.

repeated .google.cloud.datacatalog.v1beta1.SerializedPolicyTag policy_tags = 3;

Returns
Type Description
List<? extends com.google.cloud.datacatalog.v1beta1.SerializedPolicyTagOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SerializedTaxonomy.Builder newBuilderForType()
Returns
Type Description
SerializedTaxonomy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SerializedTaxonomy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SerializedTaxonomy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SerializedTaxonomy.Builder toBuilder()
Returns
Type Description
SerializedTaxonomy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException