Class CalculateStatsResponse (2.55.0)

public final class CalculateStatsResponse extends GeneratedMessageV3 implements CalculateStatsResponseOrBuilder

The response for calculating conversation statistics.

Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsResponse

Static Fields

AVERAGE_DURATION_FIELD_NUMBER

public static final int AVERAGE_DURATION_FIELD_NUMBER
Field Value
Type Description
int

AVERAGE_TURN_COUNT_FIELD_NUMBER

public static final int AVERAGE_TURN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

CONVERSATION_COUNT_FIELD_NUMBER

public static final int CONVERSATION_COUNT_FIELD_NUMBER
Field Value
Type Description
int

CONVERSATION_COUNT_TIME_SERIES_FIELD_NUMBER

public static final int CONVERSATION_COUNT_TIME_SERIES_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_HIGHLIGHTER_MATCHES_FIELD_NUMBER

public static final int CUSTOM_HIGHLIGHTER_MATCHES_FIELD_NUMBER
Field Value
Type Description
int

ISSUE_MATCHES_FIELD_NUMBER

public static final int ISSUE_MATCHES_FIELD_NUMBER
Field Value
Type Description
int

ISSUE_MATCHES_STATS_FIELD_NUMBER

public static final int ISSUE_MATCHES_STATS_FIELD_NUMBER
Field Value
Type Description
int

SMART_HIGHLIGHTER_MATCHES_FIELD_NUMBER

public static final int SMART_HIGHLIGHTER_MATCHES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CalculateStatsResponse getDefaultInstance()
Returns
Type Description
CalculateStatsResponse

getDescriptor()

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

newBuilder()

public static CalculateStatsResponse.Builder newBuilder()
Returns
Type Description
CalculateStatsResponse.Builder

newBuilder(CalculateStatsResponse prototype)

public static CalculateStatsResponse.Builder newBuilder(CalculateStatsResponse prototype)
Parameter
Name Description
prototype CalculateStatsResponse
Returns
Type Description
CalculateStatsResponse.Builder

parseDelimitedFrom(InputStream input)

public static CalculateStatsResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CalculateStatsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CalculateStatsResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CalculateStatsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CalculateStatsResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CalculateStatsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CalculateStatsResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CalculateStatsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CalculateStatsResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CalculateStatsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CalculateStatsResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CalculateStatsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CalculateStatsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CalculateStatsResponse> parser()
Returns
Type Description
Parser<CalculateStatsResponse>

Methods

containsCustomHighlighterMatches(String key)

public boolean containsCustomHighlighterMatches(String key)

A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.

map<string, int32> custom_highlighter_matches = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsIssueMatches(String key) (deprecated)

public boolean containsIssueMatches(String key)

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID> Deprecated, use issue_matches_stats field instead.

map<string, int32> issue_matches = 6 [deprecated = true];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsIssueMatchesStats(String key)

public boolean containsIssueMatchesStats(String key)

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>

map<string, .google.cloud.contactcenterinsights.v1.IssueModelLabelStats.IssueStats> issue_matches_stats = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsSmartHighlighterMatches(String key)

public boolean containsSmartHighlighterMatches(String key)

A map associating each smart highlighter display name with its respective number of matches in the set of conversations.

map<string, int32> smart_highlighter_matches = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAverageDuration()

public Duration getAverageDuration()

The average duration of all conversations. The average is calculated using only conversations that have a time duration.

.google.protobuf.Duration average_duration = 1;

Returns
Type Description
Duration

The averageDuration.

getAverageDurationOrBuilder()

public DurationOrBuilder getAverageDurationOrBuilder()

The average duration of all conversations. The average is calculated using only conversations that have a time duration.

.google.protobuf.Duration average_duration = 1;

Returns
Type Description
DurationOrBuilder

getAverageTurnCount()

public int getAverageTurnCount()

The average number of turns per conversation.

int32 average_turn_count = 2;

Returns
Type Description
int

The averageTurnCount.

getConversationCount()

public int getConversationCount()

The total number of conversations.

int32 conversation_count = 3;

Returns
Type Description
int

The conversationCount.

getConversationCountTimeSeries()

public CalculateStatsResponse.TimeSeries getConversationCountTimeSeries()

A time series representing the count of conversations created over time that match that requested filter criteria.

.google.cloud.contactcenterinsights.v1.CalculateStatsResponse.TimeSeries conversation_count_time_series = 7;

Returns
Type Description
CalculateStatsResponse.TimeSeries

The conversationCountTimeSeries.

getConversationCountTimeSeriesOrBuilder()

public CalculateStatsResponse.TimeSeriesOrBuilder getConversationCountTimeSeriesOrBuilder()

A time series representing the count of conversations created over time that match that requested filter criteria.

.google.cloud.contactcenterinsights.v1.CalculateStatsResponse.TimeSeries conversation_count_time_series = 7;

Returns
Type Description
CalculateStatsResponse.TimeSeriesOrBuilder

getCustomHighlighterMatches() (deprecated)

public Map<String,Integer> getCustomHighlighterMatches()
Returns
Type Description
Map<String,Integer>

getCustomHighlighterMatchesCount()

public int getCustomHighlighterMatchesCount()

A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.

map<string, int32> custom_highlighter_matches = 5;

Returns
Type Description
int

getCustomHighlighterMatchesMap()

public Map<String,Integer> getCustomHighlighterMatchesMap()

A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.

map<string, int32> custom_highlighter_matches = 5;

Returns
Type Description
Map<String,Integer>

getCustomHighlighterMatchesOrDefault(String key, int defaultValue)

public int getCustomHighlighterMatchesOrDefault(String key, int defaultValue)

A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.

map<string, int32> custom_highlighter_matches = 5;

Parameters
Name Description
key String
defaultValue int
Returns
Type Description
int

getCustomHighlighterMatchesOrThrow(String key)

public int getCustomHighlighterMatchesOrThrow(String key)

A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.

map<string, int32> custom_highlighter_matches = 5;

Parameter
Name Description
key String
Returns
Type Description
int

getDefaultInstanceForType()

public CalculateStatsResponse getDefaultInstanceForType()
Returns
Type Description
CalculateStatsResponse

getIssueMatches() (deprecated)

public Map<String,Integer> getIssueMatches()

Use #getIssueMatchesMap() instead.

Returns
Type Description
Map<String,Integer>

getIssueMatchesCount() (deprecated)

public int getIssueMatchesCount()

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID> Deprecated, use issue_matches_stats field instead.

map<string, int32> issue_matches = 6 [deprecated = true];

Returns
Type Description
int

getIssueMatchesMap() (deprecated)

public Map<String,Integer> getIssueMatchesMap()

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID> Deprecated, use issue_matches_stats field instead.

map<string, int32> issue_matches = 6 [deprecated = true];

Returns
Type Description
Map<String,Integer>

getIssueMatchesOrDefault(String key, int defaultValue) (deprecated)

public int getIssueMatchesOrDefault(String key, int defaultValue)

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID> Deprecated, use issue_matches_stats field instead.

map<string, int32> issue_matches = 6 [deprecated = true];

Parameters
Name Description
key String
defaultValue int
Returns
Type Description
int

getIssueMatchesOrThrow(String key) (deprecated)

public int getIssueMatchesOrThrow(String key)

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID> Deprecated, use issue_matches_stats field instead.

map<string, int32> issue_matches = 6 [deprecated = true];

Parameter
Name Description
key String
Returns
Type Description
int

getIssueMatchesStats() (deprecated)

public Map<String,IssueModelLabelStats.IssueStats> getIssueMatchesStats()
Returns
Type Description
Map<String,IssueStats>

getIssueMatchesStatsCount()

public int getIssueMatchesStatsCount()

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>

map<string, .google.cloud.contactcenterinsights.v1.IssueModelLabelStats.IssueStats> issue_matches_stats = 8;

Returns
Type Description
int

getIssueMatchesStatsMap()

public Map<String,IssueModelLabelStats.IssueStats> getIssueMatchesStatsMap()

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>

map<string, .google.cloud.contactcenterinsights.v1.IssueModelLabelStats.IssueStats> issue_matches_stats = 8;

Returns
Type Description
Map<String,IssueStats>

getIssueMatchesStatsOrDefault(String key, IssueModelLabelStats.IssueStats defaultValue)

public IssueModelLabelStats.IssueStats getIssueMatchesStatsOrDefault(String key, IssueModelLabelStats.IssueStats defaultValue)

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>

map<string, .google.cloud.contactcenterinsights.v1.IssueModelLabelStats.IssueStats> issue_matches_stats = 8;

Parameters
Name Description
key String
defaultValue IssueModelLabelStats.IssueStats
Returns
Type Description
IssueModelLabelStats.IssueStats

getIssueMatchesStatsOrThrow(String key)

public IssueModelLabelStats.IssueStats getIssueMatchesStatsOrThrow(String key)

A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>

map<string, .google.cloud.contactcenterinsights.v1.IssueModelLabelStats.IssueStats> issue_matches_stats = 8;

Parameter
Name Description
key String
Returns
Type Description
IssueModelLabelStats.IssueStats

getParserForType()

public Parser<CalculateStatsResponse> getParserForType()
Returns
Type Description
Parser<CalculateStatsResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSmartHighlighterMatches() (deprecated)

public Map<String,Integer> getSmartHighlighterMatches()
Returns
Type Description
Map<String,Integer>

getSmartHighlighterMatchesCount()

public int getSmartHighlighterMatchesCount()

A map associating each smart highlighter display name with its respective number of matches in the set of conversations.

map<string, int32> smart_highlighter_matches = 4;

Returns
Type Description
int

getSmartHighlighterMatchesMap()

public Map<String,Integer> getSmartHighlighterMatchesMap()

A map associating each smart highlighter display name with its respective number of matches in the set of conversations.

map<string, int32> smart_highlighter_matches = 4;

Returns
Type Description
Map<String,Integer>

getSmartHighlighterMatchesOrDefault(String key, int defaultValue)

public int getSmartHighlighterMatchesOrDefault(String key, int defaultValue)

A map associating each smart highlighter display name with its respective number of matches in the set of conversations.

map<string, int32> smart_highlighter_matches = 4;

Parameters
Name Description
key String
defaultValue int
Returns
Type Description
int

getSmartHighlighterMatchesOrThrow(String key)

public int getSmartHighlighterMatchesOrThrow(String key)

A map associating each smart highlighter display name with its respective number of matches in the set of conversations.

map<string, int32> smart_highlighter_matches = 4;

Parameter
Name Description
key String
Returns
Type Description
int

hasAverageDuration()

public boolean hasAverageDuration()

The average duration of all conversations. The average is calculated using only conversations that have a time duration.

.google.protobuf.Duration average_duration = 1;

Returns
Type Description
boolean

Whether the averageDuration field is set.

hasConversationCountTimeSeries()

public boolean hasConversationCountTimeSeries()

A time series representing the count of conversations created over time that match that requested filter criteria.

.google.cloud.contactcenterinsights.v1.CalculateStatsResponse.TimeSeries conversation_count_time_series = 7;

Returns
Type Description
boolean

Whether the conversationCountTimeSeries field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CalculateStatsResponse.Builder newBuilderForType()
Returns
Type Description
CalculateStatsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CalculateStatsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CalculateStatsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CalculateStatsResponse.Builder toBuilder()
Returns
Type Description
CalculateStatsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException