# Interface AdvancedFilterConfigOrBuilder (0.31.0)

0.31.0 (latest) 0.29.0 0.26.0 0.25.0 0.23.0 0.21.0 0.20.0 0.19.0 0.18.0 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.6.0 0.5.0 0.2.0 0.1.0

    public interface AdvancedFilterConfigOrBuilder extends MessageOrBuilder

## Implements

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

## Methods

### getDefaultValues(int index)

    public abstract String getDefaultValues(int index)

Optional. Default values to use if no value is selected/provided.

`repeated string default_values = 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 defaultValues at the given index. |

### getDefaultValuesBytes(int index)

    public abstract ByteString getDefaultValuesBytes(int index)

Optional. Default values to use if no value is selected/provided.

`repeated string default_values = 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 defaultValues at the given index. |

### getDefaultValuesCount()

    public abstract int getDefaultValuesCount()

Optional. Default values to use if no value is selected/provided.

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

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

### getDefaultValuesList()

    public abstract List<String> getDefaultValuesList()

Optional. Default values to use if no value is selected/provided.

`repeated string default_values = 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 defaultValues. |

### getMultipleAllowed()

    public abstract boolean getMultipleAllowed()

Optional. Whether to allow selection of multiple values.

`bool multiple_allowed = 5 [(.google.api.field_behavior) = OPTIONAL];`

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

### getPrefix()

    public abstract String getPrefix()

Optional. String to prepend to the final replaced value (e.g., "/", "\^(",
"\\"").

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

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

### getPrefixBytes()

    public abstract ByteString getPrefixBytes()

Optional. String to prepend to the final replaced value (e.g., "/", "\^(",
"\\"").

`string prefix = 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 prefix. |

### getSeparator()

    public abstract String getSeparator()

Optional. Delimiter to join multiple selected values (e.g., "\|", " OR field
= ").

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

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

### getSeparatorBytes()

    public abstract ByteString getSeparatorBytes()

Optional. Delimiter to join multiple selected values (e.g., "\|", " OR field
= ").

`string separator = 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 separator. |

### getSkipDefaultAffixes()

    public abstract boolean getSkipDefaultAffixes()

Optional. Whether to skip the configured prefix and suffix when using
default values. If true, default values are inserted raw (joined by the
separator).

`bool skip_default_affixes = 7 [(.google.api.field_behavior) = OPTIONAL];`

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

### getSuffix()

    public abstract String getSuffix()

Optional. String to append to the final replaced value (e.g., "/", ")$",
"\\"").

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

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

### getSuffixBytes()

    public abstract ByteString getSuffixBytes()

Optional. String to append to the final replaced value (e.g., "/", ")$",
"\\"").

`string suffix = 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 suffix. |

### getToken()

    public abstract String getToken()

Required. The token name to look for in the query (e.g., "hostname").
The system will automatically wrap this in '$' (e.g., "$hostname$").

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

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

### getTokenBytes()

    public abstract ByteString getTokenBytes()

Required. The token name to look for in the query (e.g., "hostname").
The system will automatically wrap this in '$' (e.g., "$hostname$").

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

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

### getValueSource()

    public abstract AdvancedFilterConfig.ValueSource getValueSource()

Required. Source of the values for the filter.

`
.google.cloud.chronicle.v1.AdvancedFilterConfig.ValueSource value_source = 8 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-chronicle/latest/com.google.cloud.chronicle.v1.AdvancedFilterConfig.ValueSource` | The valueSource. |

### getValueSourceOrBuilder()

    public abstract AdvancedFilterConfig.ValueSourceOrBuilder getValueSourceOrBuilder()

Required. Source of the values for the filter.

`
.google.cloud.chronicle.v1.AdvancedFilterConfig.ValueSource value_source = 8 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-chronicle/latest/com.google.cloud.chronicle.v1.AdvancedFilterConfig.ValueSourceOrBuilder` |   |

### hasValueSource()

    public abstract boolean hasValueSource()

Required. Source of the values for the filter.

`
.google.cloud.chronicle.v1.AdvancedFilterConfig.ValueSource value_source = 8 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the valueSource field is set. |