Interface AspectType.MetadataTemplateOrBuilder (1.52.0)

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. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't 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. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't 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. You must define it 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. You must define it 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. You must define it 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. You must define it 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. You must define it 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. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't 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. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't 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. You must specify it if the type is record. It 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. You must specify it if the type is record. It 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. You must specify it if the type is record. It 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. You must specify it if the type is record. It 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. You must specify it if the type is record. It 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. 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. 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. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it 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. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it 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 (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type 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 (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type 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. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't 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. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't 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.