Interface AspectType.MetadataTemplateOrBuilder (1.39.0)

Version 1.39.0

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

public static interface AspectType.MetadataTemplateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnnotations()

public abstract AspectType.MetadataTemplate.Annotations getAnnotations()

Optional. Specifies annotations on this field.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations annotations = 51 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AspectType.MetadataTemplate.Annotations	The annotations.

getAnnotationsOrBuilder()

public abstract AspectType.MetadataTemplate.AnnotationsOrBuilder getAnnotationsOrBuilder()

Optional. Specifies annotations on this field.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations annotations = 51 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AspectType.MetadataTemplate.AnnotationsOrBuilder

getArrayItems()

public abstract AspectType.MetadataTemplate getArrayItems()

Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate array_items = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AspectType.MetadataTemplate	The arrayItems.

getArrayItemsOrBuilder()

public abstract AspectType.MetadataTemplateOrBuilder getArrayItemsOrBuilder()

Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate array_items = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AspectType.MetadataTemplateOrBuilder

getConstraints()

public abstract AspectType.MetadataTemplate.Constraints getConstraints()

Optional. Specifies the constraints on this field.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate.Constraints constraints = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AspectType.MetadataTemplate.Constraints	The constraints.

getConstraintsOrBuilder()

public abstract AspectType.MetadataTemplate.ConstraintsOrBuilder getConstraintsOrBuilder()

Optional. Specifies the constraints on this field.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate.Constraints constraints = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AspectType.MetadataTemplate.ConstraintsOrBuilder

getEnumValues(int index)

public abstract AspectType.MetadataTemplate.EnumValue getEnumValues(int index)

Optional. The list of values for an enum type. Needs to be defined if the type is enum.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue enum_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
AspectType.MetadataTemplate.EnumValue

getEnumValuesCount()

public abstract int getEnumValuesCount()

Optional. The list of values for an enum type. Needs to be defined if the type is enum.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue enum_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getEnumValuesList()

public abstract List<AspectType.MetadataTemplate.EnumValue> getEnumValuesList()

Optional. The list of values for an enum type. Needs to be defined if the type is enum.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue enum_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<EnumValue>

getEnumValuesOrBuilder(int index)

public abstract AspectType.MetadataTemplate.EnumValueOrBuilder getEnumValuesOrBuilder(int index)

Optional. The list of values for an enum type. Needs to be defined if the type is enum.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue enum_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
AspectType.MetadataTemplate.EnumValueOrBuilder

getEnumValuesOrBuilderList()

public abstract List<? extends AspectType.MetadataTemplate.EnumValueOrBuilder> getEnumValuesOrBuilderList()

Optional. The list of values for an enum type. Needs to be defined if the type is enum.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue enum_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValueOrBuilder>

getIndex()

public abstract int getIndex()

Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.

int32 index = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The index.

getMapItems()

public abstract AspectType.MetadataTemplate getMapItems()

Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate map_items = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AspectType.MetadataTemplate	The mapItems.

getMapItemsOrBuilder()

public abstract AspectType.MetadataTemplateOrBuilder getMapItemsOrBuilder()

Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate map_items = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AspectType.MetadataTemplateOrBuilder

getName()

public abstract String getName()

Required. The name of the field.

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

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The name of the field.

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

Returns
Type	Description
ByteString	The bytes for name.

getRecordFields(int index)

public abstract AspectType.MetadataTemplate getRecordFields(int index)

Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate record_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
AspectType.MetadataTemplate

getRecordFieldsCount()

public abstract int getRecordFieldsCount()

Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate record_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getRecordFieldsList()

public abstract List<AspectType.MetadataTemplate> getRecordFieldsList()

Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate record_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<MetadataTemplate>

getRecordFieldsOrBuilder(int index)

public abstract AspectType.MetadataTemplateOrBuilder getRecordFieldsOrBuilder(int index)

Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate record_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
AspectType.MetadataTemplateOrBuilder

getRecordFieldsOrBuilderList()

public abstract List<? extends AspectType.MetadataTemplateOrBuilder> getRecordFieldsOrBuilderList()

Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.

repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate record_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.dataplex.v1.AspectType.MetadataTemplateOrBuilder>

getType()

public abstract String getType()

Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record).

string type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record).

string type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for type.

getTypeId()

public abstract String getTypeId()

Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.

string type_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The typeId.

getTypeIdBytes()

public abstract ByteString getTypeIdBytes()

Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.

string type_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for typeId.

getTypeRef()

public abstract String getTypeRef()

Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.

string type_ref = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The typeRef.

getTypeRefBytes()

public abstract ByteString getTypeRefBytes()

Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.

string type_ref = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for typeRef.

hasAnnotations()

public abstract boolean hasAnnotations()

Optional. Specifies annotations on this field.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations annotations = 51 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the annotations field is set.

hasArrayItems()

public abstract boolean hasArrayItems()

Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate array_items = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the arrayItems field is set.

hasConstraints()

public abstract boolean hasConstraints()

Optional. Specifies the constraints on this field.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate.Constraints constraints = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the constraints field is set.

hasMapItems()

public abstract boolean hasMapItems()

Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.

.google.cloud.dataplex.v1.AspectType.MetadataTemplate map_items = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the mapItems field is set.