Package com.google.cloud.dataplex.v1

Interface AspectType.MetadataTemplateOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AspectType.MetadataTemplate, AspectType.MetadataTemplate.Builder
Enclosing class:
AspectType
public static interface AspectType.MetadataTemplateOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getIndex

      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:
      The index.

    • getName

      String getName()
       Required. The name of the field.
      string name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The name of the field.
      string name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for name.

    • getType

      String getType()
       Required. The datatype of this field. The following values are supported:

 Primitive types:

 * string
 * int
 * bool
 * 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:
      The type.

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes()
       Required. The datatype of this field. The following values are supported:

 Primitive types:

 * string
 * int
 * bool
 * 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:
      The bytes for type.

    • getRecordFieldsList

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

    • getRecordFields

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

    • getRecordFieldsCount

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

    • getRecordFieldsOrBuilderList

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

    • getRecordFieldsOrBuilder

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

    • getEnumValuesList

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

    • getEnumValues

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

    • getEnumValuesCount

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

    • getEnumValuesOrBuilderList

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

    • getEnumValuesOrBuilder

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

    • hasMapItems

      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:
      Whether the mapItems field is set.

    • getMapItems

      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:
      The mapItems.

    • getMapItemsOrBuilder

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

    • hasArrayItems

      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:
      Whether the arrayItems field is set.

    • getArrayItems

      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:
      The arrayItems.

    • getArrayItemsOrBuilder

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

    • getTypeId

      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:
      The typeId.

    • getTypeIdBytes

      com.google.protobuf.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:
      The bytes for typeId.

    • getTypeRef

      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:
      The typeRef.

    • getTypeRefBytes

      com.google.protobuf.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:
      The bytes for typeRef.

    • hasConstraints

      boolean hasConstraints()
       Optional. Specifies the constraints on this field.
      .google.cloud.dataplex.v1.AspectType.MetadataTemplate.Constraints constraints = 50 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the constraints field is set.

    • getConstraints

      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:
      The constraints.

    • getConstraintsOrBuilder

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

    • hasAnnotations

      boolean hasAnnotations()
       Optional. Specifies annotations on this field.
      .google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations annotations = 51 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the annotations field is set.

    • getAnnotations

      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:
      The annotations.

    • getAnnotationsOrBuilder

      AspectType.MetadataTemplate.AnnotationsOrBuilder getAnnotationsOrBuilder()
       Optional. Specifies annotations on this field.
      .google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations annotations = 51 [(.google.api.field_behavior) = OPTIONAL];