com.google.cloud.datacatalog.v1

Interface TaxonomyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Taxonomy, Taxonomy.Builder

public interface TaxonomyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Taxonomy.PolicyType	getActivatedPolicyTypes(int index) Optional.
int	getActivatedPolicyTypesCount() Optional.
List<Taxonomy.PolicyType>	getActivatedPolicyTypesList() Optional.
int	getActivatedPolicyTypesValue(int index) Optional.
List<Integer>	getActivatedPolicyTypesValueList() Optional.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
int	getPolicyTagCount() Output only.
Taxonomy.Service	getService() Output only.
Taxonomy.ServiceOrBuilder	getServiceOrBuilder() Output only.
SystemTimestamps	getTaxonomyTimestamps() Output only.
SystemTimestampsOrBuilder	getTaxonomyTimestampsOrBuilder() Output only.
boolean	hasService() Output only.
boolean	hasTaxonomyTimestamps() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Resource name of this taxonomy in URL format.

 Note: Policy tag manager generates unique taxonomy IDs.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Resource name of this taxonomy in URL format.

 Note: Policy tag manager generates unique taxonomy IDs.
 

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

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 Required. User-defined name of this taxonomy.

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

 The taxonomy display name must be unique within an organization.
 

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

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Required. User-defined name of this taxonomy.

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

 The taxonomy display name must be unique within an organization.
 

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

Returns:

The bytes for displayName.

getDescription

String getDescription()

 Optional. Description of this taxonomy. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Optional. Description of this taxonomy. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for description.

getPolicyTagCount

int getPolicyTagCount()

 Output only. Number of policy tags in this taxonomy.
 

int32 policy_tag_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The policyTagCount.

hasTaxonomyTimestamps

boolean hasTaxonomyTimestamps()

 Output only. Creation and modification timestamps of this taxonomy.
 

.google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the taxonomyTimestamps field is set.

getTaxonomyTimestamps

SystemTimestamps getTaxonomyTimestamps()

 Output only. Creation and modification timestamps of this taxonomy.
 

.google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The taxonomyTimestamps.

getTaxonomyTimestampsOrBuilder

SystemTimestampsOrBuilder getTaxonomyTimestampsOrBuilder()

 Output only. Creation and modification timestamps of this taxonomy.
 

.google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

getActivatedPolicyTypesList

List<Taxonomy.PolicyType> getActivatedPolicyTypesList()

 Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
 

repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the activatedPolicyTypes.

getActivatedPolicyTypesCount

int getActivatedPolicyTypesCount()

 Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
 

repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of activatedPolicyTypes.

getActivatedPolicyTypes

Taxonomy.PolicyType getActivatedPolicyTypes(int index)

 Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
 

repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The activatedPolicyTypes at the given index.

getActivatedPolicyTypesValueList

List<Integer> getActivatedPolicyTypesValueList()

 Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
 

repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

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

getActivatedPolicyTypesValue

int getActivatedPolicyTypesValue(int index)

 Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
 

repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

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

hasService

boolean hasService()

 Output only. Identity of the service which owns the Taxonomy. This field is
 only populated when the taxonomy is created by a Google Cloud service.
 Currently only 'DATAPLEX' is supported.
 

.google.cloud.datacatalog.v1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the service field is set.

getService

Taxonomy.Service getService()

 Output only. Identity of the service which owns the Taxonomy. This field is
 only populated when the taxonomy is created by a Google Cloud service.
 Currently only 'DATAPLEX' is supported.
 

.google.cloud.datacatalog.v1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The service.

getServiceOrBuilder

Taxonomy.ServiceOrBuilder getServiceOrBuilder()

 Output only. Identity of the service which owns the Taxonomy. This field is
 only populated when the taxonomy is created by a Google Cloud service.
 Currently only 'DATAPLEX' is supported.
 

.google.cloud.datacatalog.v1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];