Interface QueryMetricsRequestOrBuilder (2.54.0) 

public interface QueryMetricsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDimensions(int index)

public abstract Dimension getDimensions(int index)

The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique.

If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity.

Up to one dimension is supported for now.

repeated .google.cloud.contactcenterinsights.v1.Dimension dimensions = 4;

Parameter
Name Description
index int
Returns
Type Description
Dimension

getDimensionsCount()

public abstract int getDimensionsCount()

The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique.

If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity.

Up to one dimension is supported for now.

repeated .google.cloud.contactcenterinsights.v1.Dimension dimensions = 4;

Returns
Type Description
int

getDimensionsList()

public abstract List<Dimension> getDimensionsList()

The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique.

If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity.

Up to one dimension is supported for now.

repeated .google.cloud.contactcenterinsights.v1.Dimension dimensions = 4;

Returns
Type Description
List<Dimension>

getDimensionsOrBuilder(int index)

public abstract DimensionOrBuilder getDimensionsOrBuilder(int index)

The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique.

If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity.

Up to one dimension is supported for now.

repeated .google.cloud.contactcenterinsights.v1.Dimension dimensions = 4;

Parameter
Name Description
index int
Returns
Type Description
DimensionOrBuilder

getDimensionsOrBuilderList()

public abstract List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()

The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique.

If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity.

Up to one dimension is supported for now.

repeated .google.cloud.contactcenterinsights.v1.Dimension dimensions = 4;

Returns
Type Description
List<? extends com.google.cloud.contactcenterinsights.v1.DimensionOrBuilder>

getFilter()

public abstract String getFilter()

Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for filter.

getLocation()

public abstract String getLocation()

Required. The location of the data. "projects/{project}/locations/{location}"

string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The location.

getLocationBytes()

public abstract ByteString getLocationBytes()

Required. The location of the data. "projects/{project}/locations/{location}"

string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for location.

getMeasureMask()

public abstract FieldMask getMeasureMask()

Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the measure field from the response. For example, a path from a measure mask to get the conversation count is "conversation_measure.count".

.google.protobuf.FieldMask measure_mask = 5;

Returns
Type Description
FieldMask

The measureMask.

getMeasureMaskOrBuilder()

public abstract FieldMaskOrBuilder getMeasureMaskOrBuilder()

Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the measure field from the response. For example, a path from a measure mask to get the conversation count is "conversation_measure.count".

.google.protobuf.FieldMask measure_mask = 5;

Returns
Type Description
FieldMaskOrBuilder

getTimeGranularity()

public abstract QueryMetricsRequest.TimeGranularity getTimeGranularity()

The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.

.google.cloud.contactcenterinsights.v1.QueryMetricsRequest.TimeGranularity time_granularity = 3;

Returns
Type Description
QueryMetricsRequest.TimeGranularity

The timeGranularity.

getTimeGranularityValue()

public abstract int getTimeGranularityValue()

The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.

.google.cloud.contactcenterinsights.v1.QueryMetricsRequest.TimeGranularity time_granularity = 3;

Returns
Type Description
int

The enum numeric value on the wire for timeGranularity.

hasMeasureMask()

public abstract boolean hasMeasureMask()

Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the measure field from the response. For example, a path from a measure mask to get the conversation count is "conversation_measure.count".

.google.protobuf.FieldMask measure_mask = 5;

Returns
Type Description
boolean

Whether the measureMask field is set.