Interface TaxonomyOrBuilder (1.48.0)

Version 1.48.0

• 1.61.0 (latest)
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public interface TaxonomyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActivatedPolicyTypes(int index)

public abstract 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];

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 abstract 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
Type	Description
int	The count of activatedPolicyTypes.

getActivatedPolicyTypesList()

public abstract 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
Type	Description
List<PolicyType>	A list containing the activatedPolicyTypes.

getActivatedPolicyTypesValue(int index)

public abstract 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];

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 abstract 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
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for activatedPolicyTypes.

getDescription()

public abstract 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
Type	Description
String	The description.

getDescriptionBytes()

public abstract 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
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract 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
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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
Type	Description
ByteString	The bytes for displayName.

getName()

public abstract String getName()

Identifier. Resource name of this taxonomy in URL format.

Note: Policy tag manager generates unique taxonomy IDs.

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

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Resource name of this taxonomy in URL format.

Note: Policy tag manager generates unique taxonomy IDs.

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

Returns
Type	Description
ByteString	The bytes for name.

getPolicyTagCount()

public abstract int getPolicyTagCount()

Output only. Number of policy tags in this taxonomy.

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

Returns
Type	Description
int	The policyTagCount.

getService()

public abstract 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
Type	Description
Taxonomy.Service	The service.

getServiceOrBuilder()

public abstract 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];

Returns
Type	Description
Taxonomy.ServiceOrBuilder

getTaxonomyTimestamps()

public abstract 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
Type	Description
SystemTimestamps	The taxonomyTimestamps.

getTaxonomyTimestampsOrBuilder()

public abstract 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];

Returns
Type	Description
SystemTimestampsOrBuilder

hasService()

public abstract 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
Type	Description
boolean	Whether the service field is set.

hasTaxonomyTimestamps()

public abstract 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
Type	Description
boolean	Whether the taxonomyTimestamps field is set.