0.16.0 (latest) 0.15.0 0.14.1 0.11.1 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.1

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class DynamicField.

A dynamic field in Looker (Custom Dimension, Custom Measure, or Table
Calculation).

Generated from protobuf message `google.cloud.geminidataanalytics.v1beta.DynamicField`

## Namespace

Google \\ Cloud \\ GeminiDataAnalytics \\ V1beta

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ category` | `string` Optional. The type of dynamic field: dimension, measure, table_calculation. Looker can use the category type to specify the name of the dynamic field. However, Looker Conversational Analytics keeps the category separate from the name of the dynamic field. For more details, see <https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#dynamic_fields>. |
| `↳ name` | `string` Optional. The name of the dynamic field in LookML. |
| `↳ label` | `string` Optional. The label defines the display name of the dynamic field. |
| `↳ based_on` | `string` Optional. For custom measures, this identifies the measure the field is based on. |
| `↳ type` | `string` Optional. For custom measures, this identifies the type of aggregation (e.g. sum). |
| `↳ description` | `string` Optional. Description of the dynamic field. |
| `↳ expression` | `string` Optional. Looker expression to create a table calculation. |
| `↳ filter_expression` | `string` Optional. Looker expression to filter a base measure. |
| `↳ value_format` | `string` Optional. Value format for the dynamic field. |
| `↳ value_format_name` | `string` Optional. Value format name for the dynamic field if using a default named format. |
| `↳ calculation_type` | `string` Optional. Calculation type for table calculations. Refer to <https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#calculation_type> for all possible values depending on the `category` of dynamic field. |
| `↳ args` | `string[]` Optional. Arguments for custom groups, custom bins, or shortcut calculations. For more details, refer to <https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#args_for_custom_groups> |
| `↳ kind_hint` | `string` Optional. Identifies whether the dynamic field returns a dimension or measure. |
| `↳ type_hint` | `string` Optional. Identifies the data type the dynamic field's expression should produce. |
| `↳ is_disabled` | `bool` Optional. Whether the dynamic field is disabled. |

### getCategory

Optional. The type of dynamic field: dimension, measure, table_calculation.

Looker can use the category type to specify the name of the dynamic field.
However, Looker Conversational Analytics keeps the category separate from
the name of the dynamic field. For more details, see
<https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#dynamic_fields>.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasCategory

### clearCategory

### setCategory

Optional. The type of dynamic field: dimension, measure, table_calculation.

Looker can use the category type to specify the name of the dynamic field.
However, Looker Conversational Analytics keeps the category separate from
the name of the dynamic field. For more details, see
<https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#dynamic_fields>.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getName

Optional. The name of the dynamic field in LookML.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasName

### clearName

### setName

Optional. The name of the dynamic field in LookML.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLabel

Optional. The label defines the display name of the dynamic field.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasLabel

### clearLabel

### setLabel

Optional. The label defines the display name of the dynamic field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getBasedOn

Optional. For custom measures, this identifies the measure the field is
based on.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasBasedOn

### clearBasedOn

### setBasedOn

Optional. For custom measures, this identifies the measure the field is
based on.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getType

Optional. For custom measures, this identifies the type of aggregation
(e.g. sum).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasType

### clearType

### setType

Optional. For custom measures, this identifies the type of aggregation
(e.g. sum).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDescription

Optional. Description of the dynamic field.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasDescription

### clearDescription

### setDescription

Optional. Description of the dynamic field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getExpression

Optional. Looker expression to create a table calculation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasExpression

### clearExpression

### setExpression

Optional. Looker expression to create a table calculation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getFilterExpression

Optional. Looker expression to filter a base measure.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasFilterExpression

### clearFilterExpression

### setFilterExpression

Optional. Looker expression to filter a base measure.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getValueFormat

Optional. Value format for the dynamic field.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasValueFormat

### clearValueFormat

### setValueFormat

Optional. Value format for the dynamic field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getValueFormatName

Optional. Value format name for the dynamic field if using a default named
format.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasValueFormatName

### clearValueFormatName

### setValueFormatName

Optional. Value format name for the dynamic field if using a default named
format.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCalculationType

Optional. Calculation type for table calculations. Refer to
<https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#calculation_type>
for all possible values depending on the `category` of dynamic field.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasCalculationType

### clearCalculationType

### setCalculationType

Optional. Calculation type for table calculations. Refer to
<https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#calculation_type>
for all possible values depending on the `category` of dynamic field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getArgs

Optional. Arguments for custom groups, custom bins, or shortcut
calculations. For more details, refer to
<https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#args_for_custom_groups>

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\RepeatedField<string>` |   |

### setArgs

Optional. Arguments for custom groups, custom bins, or shortcut
calculations. For more details, refer to
<https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-table-chart#args_for_custom_groups>

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getKindHint

Optional. Identifies whether the dynamic field returns a dimension or
measure.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasKindHint

### clearKindHint

### setKindHint

Optional. Identifies whether the dynamic field returns a dimension or
measure.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTypeHint

Optional. Identifies the data type the dynamic field's expression should
produce.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasTypeHint

### clearTypeHint

### setTypeHint

Optional. Identifies the data type the dynamic field's expression should
produce.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIsDisabled

Optional. Whether the dynamic field is disabled.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasIsDisabled

### clearIsDisabled

### setIsDisabled

Optional. Whether the dynamic field is disabled.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |