public final class QueryMetricsRequest extends GeneratedMessageV3 implements QueryMetricsRequestOrBuilder
The request for querying metrics.
Protobuf type google.cloud.contactcenterinsights.v1.QueryMetricsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DIMENSIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MEASURE_MASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TIME_GRANULARITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static QueryMetricsRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static QueryMetricsRequest.Builder newBuilder()
public static QueryMetricsRequest.Builder newBuilder(QueryMetricsRequest prototype)
public static QueryMetricsRequest parseDelimitedFrom(InputStream input)
public static QueryMetricsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryMetricsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static QueryMetricsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryMetricsRequest parseFrom(ByteString data)
public static QueryMetricsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryMetricsRequest parseFrom(CodedInputStream input)
public static QueryMetricsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryMetricsRequest parseFrom(InputStream input)
public static QueryMetricsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryMetricsRequest parseFrom(ByteBuffer data)
public static QueryMetricsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<QueryMetricsRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public QueryMetricsRequest getDefaultInstanceForType()
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
|
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 |
|
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;
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
|
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> |
|
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.
|
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.
|
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.
|
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.
|
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.
|
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;
public Parser<QueryMetricsRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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;
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public QueryMetricsRequest.Builder newBuilderForType()
protected QueryMetricsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public QueryMetricsRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
