Package com.google.cloud.dataplex.v1

Class AspectType.MetadataTemplate

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.AspectType.MetadataTemplate
All Implemented Interfaces:
AspectType.MetadataTemplateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
AspectType
public static final class AspectType.MetadataTemplate extends com.google.protobuf.GeneratedMessage implements AspectType.MetadataTemplateOrBuilder
 MetadataTemplate definition for an AspectType.
Protobuf type google.cloud.dataplex.v1.AspectType.MetadataTemplate
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getIndex

      public 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];
      Specified by:
      getIndex in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The index.

    • getName

      public String getName()
       Required. The name of the field.
      string name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The name of the field.
      string name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The bytes for name.

    • getType

      public 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];
      Specified by:
      getType in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public 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];
      Specified by:
      getTypeBytes in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The bytes for type.

    • getRecordFieldsList

      public 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];
      Specified by:
      getRecordFieldsList in interface AspectType.MetadataTemplateOrBuilder

    • getRecordFieldsOrBuilderList

      public 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];
      Specified by:
      getRecordFieldsOrBuilderList in interface AspectType.MetadataTemplateOrBuilder

    • getRecordFieldsCount

      public 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];
      Specified by:
      getRecordFieldsCount in interface AspectType.MetadataTemplateOrBuilder

    • getRecordFields

      public 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];
      Specified by:
      getRecordFields in interface AspectType.MetadataTemplateOrBuilder

    • getRecordFieldsOrBuilder

      public 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];
      Specified by:
      getRecordFieldsOrBuilder in interface AspectType.MetadataTemplateOrBuilder

    • getEnumValuesList

      public 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];
      Specified by:
      getEnumValuesList in interface AspectType.MetadataTemplateOrBuilder

    • getEnumValuesOrBuilderList

      public 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];
      Specified by:
      getEnumValuesOrBuilderList in interface AspectType.MetadataTemplateOrBuilder

    • getEnumValuesCount

      public 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];
      Specified by:
      getEnumValuesCount in interface AspectType.MetadataTemplateOrBuilder

    • getEnumValues

      public 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];
      Specified by:
      getEnumValues in interface AspectType.MetadataTemplateOrBuilder

    • getEnumValuesOrBuilder

      public 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];
      Specified by:
      getEnumValuesOrBuilder in interface AspectType.MetadataTemplateOrBuilder

    • hasMapItems

      public 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];
      Specified by:
      hasMapItems in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      Whether the mapItems field is set.

    • getMapItems

      public 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];
      Specified by:
      getMapItems in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The mapItems.

    • getMapItemsOrBuilder

      public 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];
      Specified by:
      getMapItemsOrBuilder in interface AspectType.MetadataTemplateOrBuilder

    • hasArrayItems

      public 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];
      Specified by:
      hasArrayItems in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      Whether the arrayItems field is set.

    • getArrayItems

      public 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];
      Specified by:
      getArrayItems in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The arrayItems.

    • getArrayItemsOrBuilder

      public 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];
      Specified by:
      getArrayItemsOrBuilder in interface AspectType.MetadataTemplateOrBuilder

    • getTypeId

      public 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];
      Specified by:
      getTypeId in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The typeId.

    • getTypeIdBytes

      public 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];
      Specified by:
      getTypeIdBytes in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The bytes for typeId.

    • getTypeRef

      public 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];
      Specified by:
      getTypeRef in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The typeRef.

    • getTypeRefBytes

      public 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];
      Specified by:
      getTypeRefBytes in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The bytes for typeRef.

    • hasConstraints

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

    • getConstraints

      public 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];
      Specified by:
      getConstraints in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The constraints.

    • getConstraintsOrBuilder

      public 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];
      Specified by:
      getConstraintsOrBuilder in interface AspectType.MetadataTemplateOrBuilder

    • hasAnnotations

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

    • getAnnotations

      public AspectType.MetadataTemplate.Annotations getAnnotations()
       Optional. Specifies annotations on this field.
      .google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations annotations = 51 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotations in interface AspectType.MetadataTemplateOrBuilder
      Returns:
      The annotations.

    • getAnnotationsOrBuilder

      public AspectType.MetadataTemplate.AnnotationsOrBuilder getAnnotationsOrBuilder()
       Optional. Specifies annotations on this field.
      .google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations annotations = 51 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsOrBuilder in interface AspectType.MetadataTemplateOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AspectType.MetadataTemplate parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AspectType.MetadataTemplate parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AspectType.MetadataTemplate parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AspectType.MetadataTemplate.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AspectType.MetadataTemplate.Builder newBuilder()

    • newBuilder

      public static AspectType.MetadataTemplate.Builder newBuilder(AspectType.MetadataTemplate prototype)

    • toBuilder

      public AspectType.MetadataTemplate.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AspectType.MetadataTemplate.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AspectType.MetadataTemplate getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AspectType.MetadataTemplate> parser()

    • getParserForType

      public com.google.protobuf.Parser<AspectType.MetadataTemplate> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public AspectType.MetadataTemplate getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder