Class ListRealtimeContactAnalysisSegmentsV2Request

    • Method Detail

      • instanceId

        public final String instanceId()

        The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

        Returns:
        The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      • contactId

        public final String contactId()

        The identifier of the contact in this instance of Amazon Connect.

        Returns:
        The identifier of the contact in this instance of Amazon Connect.
      • maxResults

        public final Integer maxResults()

        The maximum number of results to return per page.

        Returns:
        The maximum number of results to return per page.
      • nextToken

        public final String nextToken()

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

        Returns:
        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
      • segmentTypes

        public final List<RealTimeContactAnalysisSegmentType> segmentTypes()

        Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSegmentTypes() method.

        Returns:
        Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.
      • hasSegmentTypes

        public final boolean hasSegmentTypes()
        For responses, this returns true if the service returned a value for the SegmentTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • segmentTypesAsStrings

        public final List<String> segmentTypesAsStrings()

        Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSegmentTypes() method.

        Returns:
        Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object