QueryMetricsRequest (proto-google-cloud-contact-center-insights-v1 2.57.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.contactcenterinsights.v1.QueryMetricsRequest

All Implemented Interfaces:

QueryMetricsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class QueryMetricsRequest
extends com.google.protobuf.GeneratedMessageV3
implements QueryMetricsRequestOrBuilder
```
```
 The request for querying metrics.
 
```
Protobuf type google.cloud.contactcenterinsights.v1.QueryMetricsRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryMetricsRequest.Builder` The request for querying metrics.
`static class`	`QueryMetricsRequest.TimeGranularity` A time granularity divides the time line into discrete time periods.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DIMENSIONS_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`LOCATION_FIELD_NUMBER`
`static int`	`MEASURE_MASK_FIELD_NUMBER`
`static int`	`TIME_GRANULARITY_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static QueryMetricsRequest`	`getDefaultInstance()`
`QueryMetricsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<QueryMetricsRequest>`	`getParserForType()`
`int`	`getSerializedSize()`
`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.
`int`	`hashCode()`
`boolean`	`hasMeasureMask()` Measures to return.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static QueryMetricsRequest.Builder`	`newBuilder()`
`static QueryMetricsRequest.Builder`	`newBuilder(QueryMetricsRequest prototype)`
`QueryMetricsRequest.Builder`	`newBuilderForType()`
`protected QueryMetricsRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static QueryMetricsRequest`	`parseDelimitedFrom(InputStream input)`
`static QueryMetricsRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QueryMetricsRequest`	`parseFrom(byte[] data)`
`static QueryMetricsRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QueryMetricsRequest`	`parseFrom(ByteBuffer data)`
`static QueryMetricsRequest`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QueryMetricsRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static QueryMetricsRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QueryMetricsRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static QueryMetricsRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QueryMetricsRequest`	`parseFrom(InputStream input)`
`static QueryMetricsRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<QueryMetricsRequest>`	`parser()`
`QueryMetricsRequest.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- LOCATION_FIELD_NUMBER
```
public static final int LOCATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_FIELD_NUMBER
```
public static final int FILTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TIME_GRANULARITY_FIELD_NUMBER
```
public static final int TIME_GRANULARITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIMENSIONS_FIELD_NUMBER
```
public static final int DIMENSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MEASURE_MASK_FIELD_NUMBER
```
public static final int MEASURE_MASK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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) = { ... }
Specified by:

getLocation in interface QueryMetricsRequestOrBuilder

Returns:

The location.

getLocationBytes
```
public 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) = { ... }
Specified by:

getLocationBytes in interface QueryMetricsRequestOrBuilder

Returns:

The bytes for location.

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

Specified by:: getFilter in interface QueryMetricsRequestOrBuilder
Returns:: The filter.

getFilterBytes

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

Specified by:: getFilterBytes in interface QueryMetricsRequestOrBuilder
Returns:: The bytes for filter.

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;
Specified by:

getTimeGranularityValue in interface QueryMetricsRequestOrBuilder

Returns:

The enum numeric value on the wire for timeGranularity.

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;
Specified by:

getTimeGranularity in interface QueryMetricsRequestOrBuilder

Returns:

The timeGranularity.