Class Schema.SchemaField.Builder (1.53.0)

public static final class Schema.SchemaField.Builder extends GeneratedMessageV3.Builder<Schema.SchemaField.Builder> implements Schema.SchemaFieldOrBuilder

Represents a column field within a table schema.

Protobuf type google.cloud.dataplex.v1.Schema.SchemaField

Static Methods

getDescriptor()

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

Methods

addAllFields(Iterable<? extends Schema.SchemaField> values)

public Schema.SchemaField.Builder addAllFields(Iterable<? extends Schema.SchemaField> values)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dataplex.v1.Schema.SchemaField>
Returns
Type Description
Schema.SchemaField.Builder

addFields(Schema.SchemaField value)

public Schema.SchemaField.Builder addFields(Schema.SchemaField value)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Schema.SchemaField
Returns
Type Description
Schema.SchemaField.Builder

addFields(Schema.SchemaField.Builder builderForValue)

public Schema.SchemaField.Builder addFields(Schema.SchemaField.Builder builderForValue)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Schema.SchemaField.Builder
Returns
Type Description
Schema.SchemaField.Builder

addFields(int index, Schema.SchemaField value)

public Schema.SchemaField.Builder addFields(int index, Schema.SchemaField value)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Schema.SchemaField
Returns
Type Description
Schema.SchemaField.Builder

addFields(int index, Schema.SchemaField.Builder builderForValue)

public Schema.SchemaField.Builder addFields(int index, Schema.SchemaField.Builder builderForValue)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Schema.SchemaField.Builder
Returns
Type Description
Schema.SchemaField.Builder

addFieldsBuilder()

public Schema.SchemaField.Builder addFieldsBuilder()

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.SchemaField.Builder

addFieldsBuilder(int index)

public Schema.SchemaField.Builder addFieldsBuilder(int index)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.SchemaField.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Schema.SchemaField build()
Returns
Type Description
Schema.SchemaField

buildPartial()

public Schema.SchemaField buildPartial()
Returns
Type Description
Schema.SchemaField

clear()

public Schema.SchemaField.Builder clear()
Returns
Type Description
Schema.SchemaField.Builder
Overrides

clearDescription()

public Schema.SchemaField.Builder clearDescription()

Optional. User friendly field description. Must be less than or equal to 1024 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Schema.SchemaField.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Schema.SchemaField.Builder
Overrides

clearFields()

public Schema.SchemaField.Builder clearFields()

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.SchemaField.Builder

clearMode()

public Schema.SchemaField.Builder clearMode()

Required. Additional field semantics.

.google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

clearName()

public Schema.SchemaField.Builder clearName()

Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.

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

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Schema.SchemaField.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Schema.SchemaField.Builder
Overrides

clearType()

public Schema.SchemaField.Builder clearType()

Required. The type of field.

.google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

clone()

public Schema.SchemaField.Builder clone()
Returns
Type Description
Schema.SchemaField.Builder
Overrides

getDefaultInstanceForType()

public Schema.SchemaField getDefaultInstanceForType()
Returns
Type Description
Schema.SchemaField

getDescription()

public String getDescription()

Optional. User friendly field description. Must be less than or equal to 1024 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User friendly field description. Must be less than or equal to 1024 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getFields(int index)

public Schema.SchemaField getFields(int index)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.SchemaField

getFieldsBuilder(int index)

public Schema.SchemaField.Builder getFieldsBuilder(int index)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.SchemaField.Builder

getFieldsBuilderList()

public List<Schema.SchemaField.Builder> getFieldsBuilderList()

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getFieldsCount()

public int getFieldsCount()

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getFieldsList()

public List<Schema.SchemaField> getFieldsList()

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SchemaField>

getFieldsOrBuilder(int index)

public Schema.SchemaFieldOrBuilder getFieldsOrBuilder(int index)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.SchemaFieldOrBuilder

getFieldsOrBuilderList()

public List<? extends Schema.SchemaFieldOrBuilder> getFieldsOrBuilderList()

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dataplex.v1.Schema.SchemaFieldOrBuilder>

getMode()

public Schema.Mode getMode()

Required. Additional field semantics.

.google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Schema.Mode

The mode.

getModeValue()

public int getModeValue()

Required. Additional field semantics.

.google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for mode.

getName()

public String getName()

Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.

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

Returns
Type Description
ByteString

The bytes for name.

getType()

public Schema.Type getType()

Required. The type of field.

.google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Schema.Type

The type.

getTypeValue()

public int getTypeValue()

Required. The type of field.

.google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Schema.SchemaField other)

public Schema.SchemaField.Builder mergeFrom(Schema.SchemaField other)
Parameter
Name Description
other Schema.SchemaField
Returns
Type Description
Schema.SchemaField.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Schema.SchemaField.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Schema.SchemaField.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Schema.SchemaField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Schema.SchemaField.Builder
Overrides

removeFields(int index)

public Schema.SchemaField.Builder removeFields(int index)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.SchemaField.Builder

setDescription(String value)

public Schema.SchemaField.Builder setDescription(String value)

Optional. User friendly field description. Must be less than or equal to 1024 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Schema.SchemaField.Builder setDescriptionBytes(ByteString value)

Optional. User friendly field description. Must be less than or equal to 1024 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFields(int index, Schema.SchemaField value)

public Schema.SchemaField.Builder setFields(int index, Schema.SchemaField value)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Schema.SchemaField
Returns
Type Description
Schema.SchemaField.Builder

setFields(int index, Schema.SchemaField.Builder builderForValue)

public Schema.SchemaField.Builder setFields(int index, Schema.SchemaField.Builder builderForValue)

Optional. Any nested field for complex types.

repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Schema.SchemaField.Builder
Returns
Type Description
Schema.SchemaField.Builder

setMode(Schema.Mode value)

public Schema.SchemaField.Builder setMode(Schema.Mode value)

Required. Additional field semantics.

.google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Schema.Mode

The mode to set.

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

setModeValue(int value)

public Schema.SchemaField.Builder setModeValue(int value)

Required. Additional field semantics.

.google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for mode to set.

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

setName(String value)

public Schema.SchemaField.Builder setName(String value)

Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Schema.SchemaField.Builder setNameBytes(ByteString value)

Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

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

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

setType(Schema.Type value)

public Schema.SchemaField.Builder setType(Schema.Type value)

Required. The type of field.

.google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Schema.Type

The type to set.

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

setTypeValue(int value)

public Schema.SchemaField.Builder setTypeValue(int value)

Required. The type of field.

.google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
Schema.SchemaField.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Schema.SchemaField.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Schema.SchemaField.Builder
Overrides