Interface TableFieldSchemaOrBuilder (3.11.0)

public interface TableFieldSchemaOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

Optional. The field description. The maximum length is 1,024 characters.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The field description. The maximum length is 1,024 characters.

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

Returns
Type Description
ByteString

The bytes for description.

getFields(int index)

public abstract TableFieldSchema getFields(int index)

Optional. Describes the nested schema fields if the type property is set to STRUCT.

repeated .google.cloud.bigquery.storage.v1beta2.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TableFieldSchema

getFieldsCount()

public abstract int getFieldsCount()

Optional. Describes the nested schema fields if the type property is set to STRUCT.

repeated .google.cloud.bigquery.storage.v1beta2.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getFieldsList()

public abstract List<TableFieldSchema> getFieldsList()

Optional. Describes the nested schema fields if the type property is set to STRUCT.

repeated .google.cloud.bigquery.storage.v1beta2.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<TableFieldSchema>

getFieldsOrBuilder(int index)

public abstract TableFieldSchemaOrBuilder getFieldsOrBuilder(int index)

Optional. Describes the nested schema fields if the type property is set to STRUCT.

repeated .google.cloud.bigquery.storage.v1beta2.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TableFieldSchemaOrBuilder

getFieldsOrBuilderList()

public abstract List<? extends TableFieldSchemaOrBuilder> getFieldsOrBuilderList()

Optional. Describes the nested schema fields if the type property is set to STRUCT.

repeated .google.cloud.bigquery.storage.v1beta2.TableFieldSchema fields = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.bigquery.storage.v1beta2.TableFieldSchemaOrBuilder>

getMode()

public abstract TableFieldSchema.Mode getMode()

Optional. The field mode. The default value is NULLABLE.

.google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Mode mode = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TableFieldSchema.Mode

The mode.

getModeValue()

public abstract int getModeValue()

Optional. The field mode. The default value is NULLABLE.

.google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Mode mode = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for mode.

getName()

public abstract String getName()

Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

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

Returns
Type Description
ByteString

The bytes for name.

getType()

public abstract TableFieldSchema.Type getType()

Required. The field data type.

.google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Type type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TableFieldSchema.Type

The type.

getTypeValue()

public abstract int getTypeValue()

Required. The field data type.

.google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Type type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.