Class CalculateStatsResponse

  • All Implemented Interfaces:
    CalculateStatsResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CalculateStatsResponse
    extends com.google.protobuf.GeneratedMessageV3
    implements CalculateStatsResponseOrBuilder
     The response for calculating conversation statistics.
     
    Protobuf type google.cloud.contactcenterinsights.v1.CalculateStatsResponse
    See Also:
    Serialized Form
    • Field Detail

      • AVERAGE_DURATION_FIELD_NUMBER

        public static final int AVERAGE_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • AVERAGE_TURN_COUNT_FIELD_NUMBER

        public static final int AVERAGE_TURN_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CONVERSATION_COUNT_FIELD_NUMBER

        public static final int CONVERSATION_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SMART_HIGHLIGHTER_MATCHES_FIELD_NUMBER

        public static final int SMART_HIGHLIGHTER_MATCHES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CUSTOM_HIGHLIGHTER_MATCHES_FIELD_NUMBER

        public static final int CUSTOM_HIGHLIGHTER_MATCHES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ISSUE_MATCHES_FIELD_NUMBER

        public static final int ISSUE_MATCHES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ISSUE_MATCHES_STATS_FIELD_NUMBER

        public static final int ISSUE_MATCHES_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CONVERSATION_COUNT_TIME_SERIES_FIELD_NUMBER

        public static final int CONVERSATION_COUNT_TIME_SERIES_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()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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;
        Specified by:
        hasAverageDuration in interface CalculateStatsResponseOrBuilder
        Returns:
        Whether the averageDuration field is set.
      • getAverageDuration

        public com.google.protobuf.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;
        Specified by:
        getAverageDuration in interface CalculateStatsResponseOrBuilder
        Returns:
        The averageDuration.
      • getAverageDurationOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getAverageDurationOrBuilder in interface CalculateStatsResponseOrBuilder
      • containsSmartHighlighterMatches

        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;
        Specified by:
        containsSmartHighlighterMatches in interface CalculateStatsResponseOrBuilder
      • getSmartHighlighterMatchesOrDefault

        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;
        Specified by:
        getSmartHighlighterMatchesOrDefault in interface CalculateStatsResponseOrBuilder
      • getSmartHighlighterMatchesOrThrow

        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;
        Specified by:
        getSmartHighlighterMatchesOrThrow in interface CalculateStatsResponseOrBuilder
      • containsCustomHighlighterMatches

        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;
        Specified by:
        containsCustomHighlighterMatches in interface CalculateStatsResponseOrBuilder
      • getCustomHighlighterMatchesOrDefault

        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;
        Specified by:
        getCustomHighlighterMatchesOrDefault in interface CalculateStatsResponseOrBuilder
      • getCustomHighlighterMatchesOrThrow

        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;
        Specified by:
        getCustomHighlighterMatchesOrThrow in interface CalculateStatsResponseOrBuilder
      • getIssueMatchesCount

        @Deprecated
        public int getIssueMatchesCount()
        Deprecated.
        Description copied from interface: CalculateStatsResponseOrBuilder
         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];
        Specified by:
        getIssueMatchesCount in interface CalculateStatsResponseOrBuilder
      • containsIssueMatches

        @Deprecated
        public boolean containsIssueMatches​(String key)
        Deprecated.
         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];
        Specified by:
        containsIssueMatches in interface CalculateStatsResponseOrBuilder
      • getIssueMatchesMap

        @Deprecated
        public Map<String,​Integer> getIssueMatchesMap()
        Deprecated.
         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];
        Specified by:
        getIssueMatchesMap in interface CalculateStatsResponseOrBuilder
      • getIssueMatchesOrDefault

        @Deprecated
        public int getIssueMatchesOrDefault​(String key,
                                            int defaultValue)
        Deprecated.
         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];
        Specified by:
        getIssueMatchesOrDefault in interface CalculateStatsResponseOrBuilder
      • getIssueMatchesOrThrow

        @Deprecated
        public int getIssueMatchesOrThrow​(String key)
        Deprecated.
         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];
        Specified by:
        getIssueMatchesOrThrow in interface CalculateStatsResponseOrBuilder
      • getIssueMatchesStatsCount

        public int getIssueMatchesStatsCount()
        Description copied from interface: CalculateStatsResponseOrBuilder
         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;
        Specified by:
        getIssueMatchesStatsCount in interface CalculateStatsResponseOrBuilder
      • containsIssueMatchesStats

        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;
        Specified by:
        containsIssueMatchesStats in interface CalculateStatsResponseOrBuilder
      • 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;
        Specified by:
        getIssueMatchesStatsMap in interface CalculateStatsResponseOrBuilder
      • getIssueMatchesStatsOrThrow

        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;
        Specified by:
        getIssueMatchesStatsOrThrow in interface CalculateStatsResponseOrBuilder
      • 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;
        Specified by:
        hasConversationCountTimeSeries in interface CalculateStatsResponseOrBuilder
        Returns:
        Whether the conversationCountTimeSeries field is set.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static CalculateStatsResponse parseFrom​(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CalculateStatsResponse parseFrom​(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CalculateStatsResponse parseFrom​(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CalculateStatsResponse parseFrom​(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CalculateStatsResponse parseFrom​(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CalculateStatsResponse parseFrom​(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public CalculateStatsResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public CalculateStatsResponse.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected CalculateStatsResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<CalculateStatsResponse> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public CalculateStatsResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder