Class AspectType.MetadataTemplate.Builder (1.45.0) 

public static final class AspectType.MetadataTemplate.Builder extends GeneratedMessageV3.Builder<AspectType.MetadataTemplate.Builder> implements AspectType.MetadataTemplateOrBuilder

MetadataTemplate definition for AspectType

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AspectType.MetadataTemplate.Builder

Static Methods

getDescriptor()

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

Methods

addAllEnumValues(Iterable<? extends AspectType.MetadataTemplate.EnumValue> values)

public AspectType.MetadataTemplate.Builder addAllEnumValues(Iterable<? extends AspectType.MetadataTemplate.EnumValue> values)

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
values Iterable<? extends com.google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue>
Returns
Type Description
AspectType.MetadataTemplate.Builder

addAllRecordFields(Iterable<? extends AspectType.MetadataTemplate> values)

public AspectType.MetadataTemplate.Builder addAllRecordFields(Iterable<? extends AspectType.MetadataTemplate> values)

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
values Iterable<? extends com.google.cloud.dataplex.v1.AspectType.MetadataTemplate>
Returns
Type Description
AspectType.MetadataTemplate.Builder

addEnumValues(AspectType.MetadataTemplate.EnumValue value)

public AspectType.MetadataTemplate.Builder addEnumValues(AspectType.MetadataTemplate.EnumValue value)

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
value AspectType.MetadataTemplate.EnumValue
Returns
Type Description
AspectType.MetadataTemplate.Builder

addEnumValues(AspectType.MetadataTemplate.EnumValue.Builder builderForValue)

public AspectType.MetadataTemplate.Builder addEnumValues(AspectType.MetadataTemplate.EnumValue.Builder builderForValue)

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
builderForValue AspectType.MetadataTemplate.EnumValue.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

addEnumValues(int index, AspectType.MetadataTemplate.EnumValue value)

public AspectType.MetadataTemplate.Builder addEnumValues(int index, AspectType.MetadataTemplate.EnumValue value)

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

Parameters
Name Description
index int
value AspectType.MetadataTemplate.EnumValue
Returns
Type Description
AspectType.MetadataTemplate.Builder

addEnumValues(int index, AspectType.MetadataTemplate.EnumValue.Builder builderForValue)

public AspectType.MetadataTemplate.Builder addEnumValues(int index, AspectType.MetadataTemplate.EnumValue.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue AspectType.MetadataTemplate.EnumValue.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

addEnumValuesBuilder()

public AspectType.MetadataTemplate.EnumValue.Builder addEnumValuesBuilder()

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
AspectType.MetadataTemplate.EnumValue.Builder

addEnumValuesBuilder(int index)

public AspectType.MetadataTemplate.EnumValue.Builder addEnumValuesBuilder(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.Builder

addRecordFields(AspectType.MetadataTemplate value)

public AspectType.MetadataTemplate.Builder addRecordFields(AspectType.MetadataTemplate value)

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
value AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

addRecordFields(AspectType.MetadataTemplate.Builder builderForValue)

public AspectType.MetadataTemplate.Builder addRecordFields(AspectType.MetadataTemplate.Builder builderForValue)

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
builderForValue AspectType.MetadataTemplate.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

addRecordFields(int index, AspectType.MetadataTemplate value)

public AspectType.MetadataTemplate.Builder addRecordFields(int index, AspectType.MetadataTemplate value)

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

Parameters
Name Description
index int
value AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

addRecordFields(int index, AspectType.MetadataTemplate.Builder builderForValue)

public AspectType.MetadataTemplate.Builder addRecordFields(int index, AspectType.MetadataTemplate.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue AspectType.MetadataTemplate.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

addRecordFieldsBuilder()

public AspectType.MetadataTemplate.Builder addRecordFieldsBuilder()

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
AspectType.MetadataTemplate.Builder

addRecordFieldsBuilder(int index)

public AspectType.MetadataTemplate.Builder addRecordFieldsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AspectType.MetadataTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

build()

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

buildPartial()

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

clear()

public AspectType.MetadataTemplate.Builder clear()
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

clearAnnotations()

public AspectType.MetadataTemplate.Builder clearAnnotations()

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

clearArrayItems()

public AspectType.MetadataTemplate.Builder clearArrayItems()

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

clearConstraints()

public AspectType.MetadataTemplate.Builder clearConstraints()

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

clearEnumValues()

public AspectType.MetadataTemplate.Builder clearEnumValues()

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
AspectType.MetadataTemplate.Builder

clearField(Descriptors.FieldDescriptor field)

public AspectType.MetadataTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

clearIndex()

public AspectType.MetadataTemplate.Builder clearIndex()

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
AspectType.MetadataTemplate.Builder

This builder for chaining.

clearMapItems()

public AspectType.MetadataTemplate.Builder clearMapItems()

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

clearName()

public AspectType.MetadataTemplate.Builder clearName()

Required. The name of the field.

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

Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AspectType.MetadataTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

clearRecordFields()

public AspectType.MetadataTemplate.Builder clearRecordFields()

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
AspectType.MetadataTemplate.Builder

clearType()

public AspectType.MetadataTemplate.Builder clearType()

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
AspectType.MetadataTemplate.Builder

This builder for chaining.

clearTypeId()

public AspectType.MetadataTemplate.Builder clearTypeId()

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
AspectType.MetadataTemplate.Builder

This builder for chaining.

clearTypeRef()

public AspectType.MetadataTemplate.Builder clearTypeRef()

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
AspectType.MetadataTemplate.Builder

This builder for chaining.

clone()

public AspectType.MetadataTemplate.Builder clone()
Returns
Type Description
AspectType.MetadataTemplate.Builder
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.

getAnnotationsBuilder()

public AspectType.MetadataTemplate.Annotations.Builder getAnnotationsBuilder()

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

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

getArrayItemsBuilder()

public AspectType.MetadataTemplate.Builder getArrayItemsBuilder()

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

getArrayItemsOrBuilder()

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

getConstraintsBuilder()

public AspectType.MetadataTemplate.Constraints.Builder getConstraintsBuilder()

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnumValues(int index)

public 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

getEnumValuesBuilder(int index)

public AspectType.MetadataTemplate.EnumValue.Builder getEnumValuesBuilder(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.Builder

getEnumValuesBuilderList()

public List<AspectType.MetadataTemplate.EnumValue.Builder> getEnumValuesBuilderList()

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<Builder>

getEnumValuesCount()

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

getMapItemsBuilder()

public AspectType.MetadataTemplate.Builder getMapItemsBuilder()

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

getMapItemsOrBuilder()

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

getRecordFields(int index)

public 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

getRecordFieldsBuilder(int index)

public AspectType.MetadataTemplate.Builder getRecordFieldsBuilder(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.Builder

getRecordFieldsBuilderList()

public List<AspectType.MetadataTemplate.Builder> getRecordFieldsBuilderList()

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<Builder>

getRecordFieldsCount()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAnnotations(AspectType.MetadataTemplate.Annotations value)

public AspectType.MetadataTemplate.Builder mergeAnnotations(AspectType.MetadataTemplate.Annotations value)

Optional. Specifies annotations on this field.

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

Parameter
Name Description
value AspectType.MetadataTemplate.Annotations
Returns
Type Description
AspectType.MetadataTemplate.Builder

mergeArrayItems(AspectType.MetadataTemplate value)

public AspectType.MetadataTemplate.Builder mergeArrayItems(AspectType.MetadataTemplate value)

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

Parameter
Name Description
value AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

mergeConstraints(AspectType.MetadataTemplate.Constraints value)

public AspectType.MetadataTemplate.Builder mergeConstraints(AspectType.MetadataTemplate.Constraints value)

Optional. Specifies the constraints on this field.

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

Parameter
Name Description
value AspectType.MetadataTemplate.Constraints
Returns
Type Description
AspectType.MetadataTemplate.Builder

mergeFrom(AspectType.MetadataTemplate other)

public AspectType.MetadataTemplate.Builder mergeFrom(AspectType.MetadataTemplate other)
Parameter
Name Description
other AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AspectType.MetadataTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AspectType.MetadataTemplate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

mergeMapItems(AspectType.MetadataTemplate value)

public AspectType.MetadataTemplate.Builder mergeMapItems(AspectType.MetadataTemplate value)

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

Parameter
Name Description
value AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AspectType.MetadataTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

removeEnumValues(int index)

public AspectType.MetadataTemplate.Builder removeEnumValues(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.Builder

removeRecordFields(int index)

public AspectType.MetadataTemplate.Builder removeRecordFields(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.Builder

setAnnotations(AspectType.MetadataTemplate.Annotations value)

public AspectType.MetadataTemplate.Builder setAnnotations(AspectType.MetadataTemplate.Annotations value)

Optional. Specifies annotations on this field.

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

Parameter
Name Description
value AspectType.MetadataTemplate.Annotations
Returns
Type Description
AspectType.MetadataTemplate.Builder

setAnnotations(AspectType.MetadataTemplate.Annotations.Builder builderForValue)

public AspectType.MetadataTemplate.Builder setAnnotations(AspectType.MetadataTemplate.Annotations.Builder builderForValue)

Optional. Specifies annotations on this field.

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

Parameter
Name Description
builderForValue AspectType.MetadataTemplate.Annotations.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

setArrayItems(AspectType.MetadataTemplate value)

public AspectType.MetadataTemplate.Builder setArrayItems(AspectType.MetadataTemplate value)

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

Parameter
Name Description
value AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

setArrayItems(AspectType.MetadataTemplate.Builder builderForValue)

public AspectType.MetadataTemplate.Builder setArrayItems(AspectType.MetadataTemplate.Builder builderForValue)

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

Parameter
Name Description
builderForValue AspectType.MetadataTemplate.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

setConstraints(AspectType.MetadataTemplate.Constraints value)

public AspectType.MetadataTemplate.Builder setConstraints(AspectType.MetadataTemplate.Constraints value)

Optional. Specifies the constraints on this field.

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

Parameter
Name Description
value AspectType.MetadataTemplate.Constraints
Returns
Type Description
AspectType.MetadataTemplate.Builder

setConstraints(AspectType.MetadataTemplate.Constraints.Builder builderForValue)

public AspectType.MetadataTemplate.Builder setConstraints(AspectType.MetadataTemplate.Constraints.Builder builderForValue)

Optional. Specifies the constraints on this field.

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

Parameter
Name Description
builderForValue AspectType.MetadataTemplate.Constraints.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

setEnumValues(int index, AspectType.MetadataTemplate.EnumValue value)

public AspectType.MetadataTemplate.Builder setEnumValues(int index, AspectType.MetadataTemplate.EnumValue value)

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

Parameters
Name Description
index int
value AspectType.MetadataTemplate.EnumValue
Returns
Type Description
AspectType.MetadataTemplate.Builder

setEnumValues(int index, AspectType.MetadataTemplate.EnumValue.Builder builderForValue)

public AspectType.MetadataTemplate.Builder setEnumValues(int index, AspectType.MetadataTemplate.EnumValue.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue AspectType.MetadataTemplate.EnumValue.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AspectType.MetadataTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

setIndex(int value)

public AspectType.MetadataTemplate.Builder setIndex(int value)

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

Parameter
Name Description
value int

The index to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setMapItems(AspectType.MetadataTemplate value)

public AspectType.MetadataTemplate.Builder setMapItems(AspectType.MetadataTemplate value)

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

Parameter
Name Description
value AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

setMapItems(AspectType.MetadataTemplate.Builder builderForValue)

public AspectType.MetadataTemplate.Builder setMapItems(AspectType.MetadataTemplate.Builder builderForValue)

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

Parameter
Name Description
builderForValue AspectType.MetadataTemplate.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

setName(String value)

public AspectType.MetadataTemplate.Builder setName(String value)

Required. The name of the field.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AspectType.MetadataTemplate.Builder setNameBytes(ByteString value)

Required. The name of the field.

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setRecordFields(int index, AspectType.MetadataTemplate value)

public AspectType.MetadataTemplate.Builder setRecordFields(int index, AspectType.MetadataTemplate value)

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

Parameters
Name Description
index int
value AspectType.MetadataTemplate
Returns
Type Description
AspectType.MetadataTemplate.Builder

setRecordFields(int index, AspectType.MetadataTemplate.Builder builderForValue)

public AspectType.MetadataTemplate.Builder setRecordFields(int index, AspectType.MetadataTemplate.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue AspectType.MetadataTemplate.Builder
Returns
Type Description
AspectType.MetadataTemplate.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AspectType.MetadataTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides

setType(String value)

public AspectType.MetadataTemplate.Builder setType(String value)

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

Parameter
Name Description
value String

The type to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public AspectType.MetadataTemplate.Builder setTypeBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for type to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setTypeId(String value)

public AspectType.MetadataTemplate.Builder setTypeId(String value)

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

Parameter
Name Description
value String

The typeId to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setTypeIdBytes(ByteString value)

public AspectType.MetadataTemplate.Builder setTypeIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for typeId to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setTypeRef(String value)

public AspectType.MetadataTemplate.Builder setTypeRef(String value)

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

Parameter
Name Description
value String

The typeRef to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setTypeRefBytes(ByteString value)

public AspectType.MetadataTemplate.Builder setTypeRefBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for typeRef to set.
Returns
Type Description
AspectType.MetadataTemplate.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AspectType.MetadataTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AspectType.MetadataTemplate.Builder
Overrides