com.google.cloud.contactcenterinsights.v1

Interface QueryMetricsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

QueryMetricsRequest, QueryMetricsRequest.Builder

public interface QueryMetricsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Dimension	getDimensions(int index) The dimensions that determine the grouping key for the query.
int	getDimensionsCount() The dimensions that determine the grouping key for the query.
List<Dimension>	getDimensionsList() The dimensions that determine the grouping key for the query.
DimensionOrBuilder	getDimensionsOrBuilder(int index) The dimensions that determine the grouping key for the query.
List<? extends DimensionOrBuilder>	getDimensionsOrBuilderList() The dimensions that determine the grouping key for the query.
String	getFilter() Required.
com.google.protobuf.ByteString	getFilterBytes() Required.
String	getLocation() Required.
com.google.protobuf.ByteString	getLocationBytes() Required.
com.google.protobuf.FieldMask	getMeasureMask() Measures to return.
com.google.protobuf.FieldMaskOrBuilder	getMeasureMaskOrBuilder() Measures to return.
QueryMetricsRequest.TimeGranularity	getTimeGranularity() The time granularity of each data point in the time series.
int	getTimeGranularityValue() The time granularity of each data point in the time series.
boolean	hasMeasureMask() Measures to return.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getLocation

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:

The location.

getLocationBytes

com.google.protobuf.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:

The bytes for location.

getFilter

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:

The filter.

getFilterBytes

com.google.protobuf.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:

The bytes for filter.

getTimeGranularityValue

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:

The enum numeric value on the wire for timeGranularity.

getTimeGranularity

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:

The timeGranularity.

getDimensionsList

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;

getDimensions

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;

getDimensionsCount

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;

getDimensionsOrBuilderList

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;

getDimensionsOrBuilder

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;

hasMeasureMask

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:

Whether the measureMask field is set.

getMeasureMask

com.google.protobuf.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:

The measureMask.

getMeasureMaskOrBuilder

com.google.protobuf.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;