- 1.76.0 (latest)
 - 1.74.0
 - 1.73.0
 - 1.72.0
 - 1.71.0
 - 1.70.0
 - 1.68.0
 - 1.66.0
 - 1.65.0
 - 1.62.0
 - 1.61.0
 - 1.60.0
 - 1.58.0
 - 1.57.0
 - 1.56.0
 - 1.55.0
 - 1.54.0
 - 1.53.0
 - 1.52.0
 - 1.51.0
 - 1.50.0
 - 1.49.0
 - 1.47.0
 - 1.46.0
 - 1.45.0
 - 1.44.0
 - 1.43.0
 - 1.42.0
 - 1.41.0
 - 1.40.0
 - 1.39.0
 - 1.38.0
 - 1.37.0
 - 1.35.0
 - 1.34.0
 - 1.33.0
 - 1.32.0
 - 1.31.0
 - 1.30.0
 - 1.29.0
 - 1.28.0
 - 1.27.0
 - 1.26.0
 - 1.25.0
 - 1.22.0
 - 1.21.0
 - 1.20.0
 - 1.19.0
 - 1.18.0
 - 1.17.0
 - 1.16.0
 - 1.15.0
 - 1.14.0
 - 1.13.0
 - 1.12.0
 - 1.11.0
 - 1.10.0
 - 1.9.0
 - 1.7.0
 - 1.6.0
 - 1.5.0
 - 1.4.0
 - 1.3.0
 - 1.2.0
 - 1.1.2
 - 1.0.1
 - 0.2.2
 
public static final class Schema.SchemaField.Builder extends GeneratedMessageV3.Builder<Schema.SchemaField.Builder> implements Schema.SchemaFieldOrBuilderRepresents a column field within a table schema.
 Protobuf type google.cloud.dataplex.v1.Schema.SchemaField
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Schema.SchemaField.BuilderImplements
Schema.SchemaFieldOrBuilderStatic 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 | 
        |
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 | 
        |
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 | 
        |
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 | 
        |
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 | 
        |
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 | 
        |
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 | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
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 | 
        |
| 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 | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Schema.SchemaField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
Schema.SchemaField.Builder | 
        |
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 | 
        StringThe 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 | 
        ByteStringThe 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 | 
        |
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.ModeThe 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 | 
        intThe 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 | 
        StringThe 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 | 
        ByteStringThe 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 | 
        |
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.TypeThe 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 | 
        intThe 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 | 
        |