Class QueryMetricsRequest.Builder (2.54.0) 

public static final class QueryMetricsRequest.Builder extends GeneratedMessageV3.Builder<QueryMetricsRequest.Builder> implements QueryMetricsRequestOrBuilder

The request for querying metrics.

Protobuf type google.cloud.contactcenterinsights.v1.QueryMetricsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > QueryMetricsRequest.Builder

Static Methods

getDescriptor()

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

Methods

addAllDimensions(Iterable<? extends Dimension> values)

public QueryMetricsRequest.Builder addAllDimensions(Iterable<? extends Dimension> values)

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
values Iterable<? extends com.google.cloud.contactcenterinsights.v1.Dimension>
Returns
Type Description
QueryMetricsRequest.Builder

addDimensions(Dimension value)

public QueryMetricsRequest.Builder addDimensions(Dimension value)

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
value Dimension
Returns
Type Description
QueryMetricsRequest.Builder

addDimensions(Dimension.Builder builderForValue)

public QueryMetricsRequest.Builder addDimensions(Dimension.Builder builderForValue)

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
builderForValue Dimension.Builder
Returns
Type Description
QueryMetricsRequest.Builder

addDimensions(int index, Dimension value)

public QueryMetricsRequest.Builder addDimensions(int index, Dimension value)

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;

Parameters
Name Description
index int
value Dimension
Returns
Type Description
QueryMetricsRequest.Builder

addDimensions(int index, Dimension.Builder builderForValue)

public QueryMetricsRequest.Builder addDimensions(int index, Dimension.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Dimension.Builder
Returns
Type Description
QueryMetricsRequest.Builder

addDimensionsBuilder()

public Dimension.Builder addDimensionsBuilder()

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
Dimension.Builder

addDimensionsBuilder(int index)

public Dimension.Builder addDimensionsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QueryMetricsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

build()

public QueryMetricsRequest build()
Returns
Type Description
QueryMetricsRequest

buildPartial()

public QueryMetricsRequest buildPartial()
Returns
Type Description
QueryMetricsRequest

clear()

public QueryMetricsRequest.Builder clear()
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

clearDimensions()

public QueryMetricsRequest.Builder clearDimensions()

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
QueryMetricsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public QueryMetricsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

clearFilter()

public QueryMetricsRequest.Builder clearFilter()

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
QueryMetricsRequest.Builder

This builder for chaining.

clearLocation()

public QueryMetricsRequest.Builder clearLocation()

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
QueryMetricsRequest.Builder

This builder for chaining.

clearMeasureMask()

public QueryMetricsRequest.Builder clearMeasureMask()

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
QueryMetricsRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public QueryMetricsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

clearTimeGranularity()

public QueryMetricsRequest.Builder clearTimeGranularity()

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.Builder

This builder for chaining.

clone()

public QueryMetricsRequest.Builder clone()
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

getDefaultInstanceForType()

public QueryMetricsRequest getDefaultInstanceForType()
Returns
Type Description
QueryMetricsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDimensions(int index)

public 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

getDimensionsBuilder(int index)

public Dimension.Builder getDimensionsBuilder(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.Builder

getDimensionsBuilderList()

public List<Dimension.Builder> getDimensionsBuilderList()

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<Builder>

getDimensionsCount()

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

getMeasureMaskBuilder()

public FieldMask.Builder getMeasureMaskBuilder()

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
Builder

getMeasureMaskOrBuilder()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(QueryMetricsRequest other)

public QueryMetricsRequest.Builder mergeFrom(QueryMetricsRequest other)
Parameter
Name Description
other QueryMetricsRequest
Returns
Type Description
QueryMetricsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryMetricsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryMetricsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public QueryMetricsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

mergeMeasureMask(FieldMask value)

public QueryMetricsRequest.Builder mergeMeasureMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
QueryMetricsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueryMetricsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

removeDimensions(int index)

public QueryMetricsRequest.Builder removeDimensions(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
QueryMetricsRequest.Builder

setDimensions(int index, Dimension value)

public QueryMetricsRequest.Builder setDimensions(int index, Dimension value)

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;

Parameters
Name Description
index int
value Dimension
Returns
Type Description
QueryMetricsRequest.Builder

setDimensions(int index, Dimension.Builder builderForValue)

public QueryMetricsRequest.Builder setDimensions(int index, Dimension.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Dimension.Builder
Returns
Type Description
QueryMetricsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public QueryMetricsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

setFilter(String value)

public QueryMetricsRequest.Builder setFilter(String value)

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];

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
QueryMetricsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public QueryMetricsRequest.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
QueryMetricsRequest.Builder

This builder for chaining.

setLocation(String value)

public QueryMetricsRequest.Builder setLocation(String value)

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

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

Parameter
Name Description
value String

The location to set.
Returns
Type Description
QueryMetricsRequest.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public QueryMetricsRequest.Builder setLocationBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for location to set.
Returns
Type Description
QueryMetricsRequest.Builder

This builder for chaining.

setMeasureMask(FieldMask value)

public QueryMetricsRequest.Builder setMeasureMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
QueryMetricsRequest.Builder

setMeasureMask(FieldMask.Builder builderForValue)

public QueryMetricsRequest.Builder setMeasureMask(FieldMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
QueryMetricsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public QueryMetricsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
QueryMetricsRequest.Builder
Overrides

setTimeGranularity(QueryMetricsRequest.TimeGranularity value)

public QueryMetricsRequest.Builder setTimeGranularity(QueryMetricsRequest.TimeGranularity value)

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;

Parameter
Name Description
value QueryMetricsRequest.TimeGranularity

The timeGranularity to set.
Returns
Type Description
QueryMetricsRequest.Builder

This builder for chaining.

setTimeGranularityValue(int value)

public QueryMetricsRequest.Builder setTimeGranularityValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for timeGranularity to set.
Returns
Type Description
QueryMetricsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final QueryMetricsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
QueryMetricsRequest.Builder
Overrides