Class AspectType.MetadataTemplate (1.52.0)

public static final class AspectType.MetadataTemplate extends GeneratedMessageV3 implements AspectType.MetadataTemplateOrBuilder

MetadataTemplate definition for an AspectType.

Protobuf type google.cloud.dataplex.v1.AspectType.MetadataTemplate

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

ARRAY_ITEMS_FIELD_NUMBER

public static final int ARRAY_ITEMS_FIELD_NUMBER
Field Value
Type Description
int

CONSTRAINTS_FIELD_NUMBER

public static final int CONSTRAINTS_FIELD_NUMBER
Field Value
Type Description
int

ENUM_VALUES_FIELD_NUMBER

public static final int ENUM_VALUES_FIELD_NUMBER
Field Value
Type Description
int

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
Type Description
int

MAP_ITEMS_FIELD_NUMBER

public static final int MAP_ITEMS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RECORD_FIELDS_FIELD_NUMBER

public static final int RECORD_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_ID_FIELD_NUMBER

public static final int TYPE_ID_FIELD_NUMBER
Field Value
Type Description
int

TYPE_REF_FIELD_NUMBER

public static final int TYPE_REF_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AspectType.MetadataTemplate getDefaultInstance()
Returns
Type Description
AspectType.MetadataTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AspectType.MetadataTemplate.Builder newBuilder()
Returns
Type Description
AspectType.MetadataTemplate.Builder

newBuilder(AspectType.MetadataTemplate prototype)

public static AspectType.MetadataTemplate.Builder newBuilder(AspectType.MetadataTemplate prototype)
Parameter
Name Description
prototype AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

parseDelimitedFrom(InputStream input)

public static AspectType.MetadataTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AspectType.MetadataTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AspectType.MetadataTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AspectType.MetadataTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AspectType.MetadataTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AspectType.MetadataTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AspectType.MetadataTemplate> parser()
Returns
Type Description
Parser<MetadataTemplate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

Returns
Type Description
AspectType.MetadataTemplate.Annotations

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

Returns
Type Description
AspectType.MetadataTemplate.AnnotationsOrBuilder

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

Returns
Type Description
AspectType.MetadataTemplate

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

Returns
Type Description
AspectType.MetadataTemplateOrBuilder

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

Returns
Type Description
AspectType.MetadataTemplate.Constraints

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

Returns
Type Description
AspectType.MetadataTemplate.ConstraintsOrBuilder

getDefaultInstanceForType()

public AspectType.MetadataTemplate getDefaultInstanceForType()
Returns
Type Description
AspectType.MetadataTemplate

getEnumValues(int index)

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

Parameter
Name Description
index int
Returns
Type Description
AspectType.MetadataTemplate.EnumValue

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

Returns
Type Description
int

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

Returns
Type Description
List<EnumValue>

getEnumValuesOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
AspectType.MetadataTemplate.EnumValueOrBuilder

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

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

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

Returns
Type Description
int

The index.

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

Returns
Type Description
AspectType.MetadataTemplate

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

Returns
Type Description
AspectType.MetadataTemplateOrBuilder

getName()

public String getName()

Required. The name of the field.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the field.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<AspectType.MetadataTemplate> getParserForType()
Returns
Type Description
Parser<MetadataTemplate>
Overrides

getRecordFields(int index)

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

Parameter
Name Description
index int
Returns
Type Description
AspectType.MetadataTemplate

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

Returns
Type Description
int

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

Returns
Type Description
List<MetadataTemplate>

getRecordFieldsOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
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];

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AspectType.MetadataTemplate.Builder newBuilderForType()
Returns
Type Description
AspectType.MetadataTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AspectType.MetadataTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AspectType.MetadataTemplate.Builder toBuilder()
Returns
Type Description
AspectType.MetadataTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException