# Interface FieldOrBuilder (0.21.0)

0.21.0 (latest) 0.19.0 0.16.0 0.15.0 0.13.0 0.11.0 0.10.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.2.0 0.1.0

    public interface FieldOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getCategory()

    public abstract String getCategory()

Optional. Field category, not required, currently only useful for Looker.

`string category = 10 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The category. |

### getCategoryBytes()

    public abstract ByteString getCategoryBytes()

Optional. Field category, not required, currently only useful for Looker.

`string category = 10 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for category. |

### getDescription()

    public abstract String getDescription()

Optional. A brief description of the field.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The description. |

### getDescriptionBytes()

    public abstract ByteString getDescriptionBytes()

Optional. A brief description of the field.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for description. |

### getDisplayName()

    public abstract String getDisplayName()

Optional. Field display_name (same as label in

`string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The displayName. |

### getDisplayNameBytes()

    public abstract ByteString getDisplayNameBytes()

Optional. Field display_name (same as label in

`string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for displayName. |

### getMode()

    public abstract String getMode()

Optional. The mode of the field (e.g., NULLABLE, REPEATED).

`string mode = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The mode. |

### getModeBytes()

    public abstract ByteString getModeBytes()

Optional. The mode of the field (e.g., NULLABLE, REPEATED).

`string mode = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for mode. |

### getName()

    public abstract String getName()

Optional. The name of the field.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The name. |

### getNameBytes()

    public abstract ByteString getNameBytes()

Optional. The name of the field.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for name. |

### getSubfields(int index)

    public abstract Field getSubfields(int index)

Optional. Recursive property for nested schema structures.

`
repeated .google.cloud.geminidataanalytics.v1.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-geminidataanalytics/latest/com.google.cloud.geminidataanalytics.v1.Field` |   |

### getSubfieldsCount()

    public abstract int getSubfieldsCount()

Optional. Recursive property for nested schema structures.

`
repeated .google.cloud.geminidataanalytics.v1.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getSubfieldsList()

    public abstract List<Field> getSubfieldsList()

Optional. Recursive property for nested schema structures.

`
repeated .google.cloud.geminidataanalytics.v1.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-geminidataanalytics/latest/com.google.cloud.geminidataanalytics.v1.Field>` |   |

### getSubfieldsOrBuilder(int index)

    public abstract FieldOrBuilder getSubfieldsOrBuilder(int index)

Optional. Recursive property for nested schema structures.

`
repeated .google.cloud.geminidataanalytics.v1.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-geminidataanalytics/latest/com.google.cloud.geminidataanalytics.v1.FieldOrBuilder` |   |

### getSubfieldsOrBuilderList()

    public abstract List<? extends FieldOrBuilder> getSubfieldsOrBuilderList()

Optional. Recursive property for nested schema structures.

`
repeated .google.cloud.geminidataanalytics.v1.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? extends com.google.cloud.geminidataanalytics.v1.FieldOrBuilder>` |   |

### getSynonyms(int index)

    public abstract String getSynonyms(int index)

Optional. A list of alternative names or synonyms that can be used to refer
to this field. For example: \["id", "customerid", "cust_id"\]. Currently only
used for BigQuery data sources.

`repeated string synonyms = 6 [(.google.api.field_behavior) = OPTIONAL];`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the element to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The synonyms at the given index. |

### getSynonymsBytes(int index)

    public abstract ByteString getSynonymsBytes(int index)

Optional. A list of alternative names or synonyms that can be used to refer
to this field. For example: \["id", "customerid", "cust_id"\]. Currently only
used for BigQuery data sources.

`repeated string synonyms = 6 [(.google.api.field_behavior) = OPTIONAL];`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the value to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes of the synonyms at the given index. |

### getSynonymsCount()

    public abstract int getSynonymsCount()

Optional. A list of alternative names or synonyms that can be used to refer
to this field. For example: \["id", "customerid", "cust_id"\]. Currently only
used for BigQuery data sources.

`repeated string synonyms = 6 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The count of synonyms. |

### getSynonymsList()

    public abstract List<String> getSynonymsList()

Optional. A list of alternative names or synonyms that can be used to refer
to this field. For example: \["id", "customerid", "cust_id"\]. Currently only
used for BigQuery data sources.

`repeated string synonyms = 6 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` | A list containing the synonyms. |

### getTags(int index)

    public abstract String getTags(int index)

Optional. A list of tags or keywords associated with the field, used for
categorization. For example: \["identifier", "customer", "pii"\]. Currently
only used for BigQuery data sources.

`repeated string tags = 7 [(.google.api.field_behavior) = OPTIONAL];`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the element to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The tags at the given index. |

### getTagsBytes(int index)

    public abstract ByteString getTagsBytes(int index)

Optional. A list of tags or keywords associated with the field, used for
categorization. For example: \["identifier", "customer", "pii"\]. Currently
only used for BigQuery data sources.

`repeated string tags = 7 [(.google.api.field_behavior) = OPTIONAL];`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the value to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes of the tags at the given index. |

### getTagsCount()

    public abstract int getTagsCount()

Optional. A list of tags or keywords associated with the field, used for
categorization. For example: \["identifier", "customer", "pii"\]. Currently
only used for BigQuery data sources.

`repeated string tags = 7 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The count of tags. |

### getTagsList()

    public abstract List<String> getTagsList()

Optional. A list of tags or keywords associated with the field, used for
categorization. For example: \["identifier", "customer", "pii"\]. Currently
only used for BigQuery data sources.

`repeated string tags = 7 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` | A list containing the tags. |

### getType()

    public abstract String getType()

Optional. The type of the field.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The type. |

### getTypeBytes()

    public abstract ByteString getTypeBytes()

Optional. The type of the field.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for type. |

### getValueFormat()

    public abstract String getValueFormat()

Optional. Looker only. Value format of the field.
Ref:
<https://cloud.google.com/looker/docs/reference/param-field-value-format>

`string value_format = 11 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The valueFormat. |

### getValueFormatBytes()

    public abstract ByteString getValueFormatBytes()

Optional. Looker only. Value format of the field.
Ref:
<https://cloud.google.com/looker/docs/reference/param-field-value-format>

`string value_format = 11 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for valueFormat. |