Class DynamicField (0.27.0)

public final class DynamicField extends GeneratedMessage implements DynamicFieldOrBuilder

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

Protobuf type google.cloud.geminidataanalytics.v1.DynamicField

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER
Field Value
Type Description
int

BASED_ON_FIELD_NUMBER

public static final int BASED_ON_FIELD_NUMBER
Field Value
Type Description
int

CALCULATION_TYPE_FIELD_NUMBER

public static final int CALCULATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXPRESSION_FIELD_NUMBER

public static final int EXPRESSION_FIELD_NUMBER
Field Value
Type Description
int

FILTER_EXPRESSION_FIELD_NUMBER

public static final int FILTER_EXPRESSION_FIELD_NUMBER
Field Value
Type Description
int

IS_DISABLED_FIELD_NUMBER

public static final int IS_DISABLED_FIELD_NUMBER
Field Value
Type Description
int

KIND_HINT_FIELD_NUMBER

public static final int KIND_HINT_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_HINT_FIELD_NUMBER

public static final int TYPE_HINT_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FORMAT_FIELD_NUMBER

public static final int VALUE_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FORMAT_NAME_FIELD_NUMBER

public static final int VALUE_FORMAT_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DynamicField getDefaultInstance()
Returns
Type Description
DynamicField

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DynamicField.Builder newBuilder()
Returns
Type Description
DynamicField.Builder

newBuilder(DynamicField prototype)

public static DynamicField.Builder newBuilder(DynamicField prototype)
Parameter
Name Description
prototype DynamicField
Returns
Type Description
DynamicField.Builder

parseDelimitedFrom(InputStream input)

public static DynamicField parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DynamicField
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DynamicField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DynamicField
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DynamicField parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DynamicField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DynamicField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DynamicField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DynamicField parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DynamicField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DynamicField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DynamicField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DynamicField parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DynamicField
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DynamicField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DynamicField
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DynamicField parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DynamicField
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DynamicField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DynamicField
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DynamicField parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DynamicField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DynamicField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DynamicField
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DynamicField> parser()
Returns
Type Description
Parser<DynamicField>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArgs(int index)

public String getArgs(int index)

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

repeated string args = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The args at the given index.

getArgsBytes(int index)

public ByteString getArgsBytes(int index)

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

repeated string args = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the args at the given index.

getArgsCount()

public int getArgsCount()

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

repeated string args = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of args.

getArgsList()

public ProtocolStringList getArgsList()

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

repeated string args = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the args.

getBasedOn()

public String getBasedOn()

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

optional string based_on = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The basedOn.

getBasedOnBytes()

public ByteString getBasedOnBytes()

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

optional string based_on = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for basedOn.

getCalculationType()

public String 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.

optional string calculation_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The calculationType.

getCalculationTypeBytes()

public ByteString getCalculationTypeBytes()

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.

optional string calculation_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for calculationType.

getCategory()

public String 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.

optional string category = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The category.

getCategoryBytes()

public ByteString getCategoryBytes()

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.

optional string category = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for category.

getDefaultInstanceForType()

public DynamicField getDefaultInstanceForType()
Returns
Type Description
DynamicField

getDescription()

public String getDescription()

Optional. Description of the dynamic field.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the dynamic field.

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

Returns
Type Description
ByteString

The bytes for description.

getExpression()

public String getExpression()

Optional. Looker expression to create a table calculation.

optional string expression = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The expression.

getExpressionBytes()

public ByteString getExpressionBytes()

Optional. Looker expression to create a table calculation.

optional string expression = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for expression.

getFilterExpression()

public String getFilterExpression()

Optional. Looker expression to filter a base measure.

optional string filter_expression = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filterExpression.

getFilterExpressionBytes()

public ByteString getFilterExpressionBytes()

Optional. Looker expression to filter a base measure.

optional string filter_expression = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filterExpression.

getIsDisabled()

public boolean getIsDisabled()

Optional. Whether the dynamic field is disabled.

optional bool is_disabled = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The isDisabled.

getKindHint()

public String getKindHint()

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

optional string kind_hint = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kindHint.

getKindHintBytes()

public ByteString getKindHintBytes()

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

optional string kind_hint = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kindHint.

getLabel()

public String getLabel()

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

optional string label = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

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

optional string label = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for label.

getName()

public String getName()

Optional. The name of the dynamic field in LookML.

optional string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. The name of the dynamic field in LookML.

optional string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DynamicField> getParserForType()
Returns
Type Description
Parser<DynamicField>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public String getType()

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

optional string type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

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

optional string type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for type.

getTypeHint()

public String getTypeHint()

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

optional string type_hint = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The typeHint.

getTypeHintBytes()

public ByteString getTypeHintBytes()

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

optional string type_hint = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for typeHint.

getValueFormat()

public String getValueFormat()

Optional. Value format for the dynamic field.

optional string value_format = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The valueFormat.

getValueFormatBytes()

public ByteString getValueFormatBytes()

Optional. Value format for the dynamic field.

optional string value_format = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for valueFormat.

getValueFormatName()

public String getValueFormatName()

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

optional string value_format_name = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The valueFormatName.

getValueFormatNameBytes()

public ByteString getValueFormatNameBytes()

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

optional string value_format_name = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for valueFormatName.

hasBasedOn()

public boolean hasBasedOn()

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

optional string based_on = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the basedOn field is set.

hasCalculationType()

public boolean hasCalculationType()

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.

optional string calculation_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the calculationType field is set.

hasCategory()

public boolean hasCategory()

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.

optional string category = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the category field is set.

hasDescription()

public boolean hasDescription()

Optional. Description of the dynamic field.

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

Returns
Type Description
boolean

Whether the description field is set.

hasExpression()

public boolean hasExpression()

Optional. Looker expression to create a table calculation.

optional string expression = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the expression field is set.

hasFilterExpression()

public boolean hasFilterExpression()

Optional. Looker expression to filter a base measure.

optional string filter_expression = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the filterExpression field is set.

hasIsDisabled()

public boolean hasIsDisabled()

Optional. Whether the dynamic field is disabled.

optional bool is_disabled = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the isDisabled field is set.

hasKindHint()

public boolean hasKindHint()

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

optional string kind_hint = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the kindHint field is set.

hasLabel()

public boolean hasLabel()

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

optional string label = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the label field is set.

hasName()

public boolean hasName()

Optional. The name of the dynamic field in LookML.

optional string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the name field is set.

hasType()

public boolean hasType()

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

optional string type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the type field is set.

hasTypeHint()

public boolean hasTypeHint()

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

optional string type_hint = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the typeHint field is set.

hasValueFormat()

public boolean hasValueFormat()

Optional. Value format for the dynamic field.

optional string value_format = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the valueFormat field is set.

hasValueFormatName()

public boolean hasValueFormatName()

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

optional string value_format_name = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the valueFormatName field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DynamicField.Builder newBuilderForType()
Returns
Type Description
DynamicField.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DynamicField.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DynamicField.Builder
Overrides

toBuilder()

public DynamicField.Builder toBuilder()
Returns
Type Description
DynamicField.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException