Class ListRealtimeContactAnalysisSegmentsV2Request
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListRealtimeContactAnalysisSegmentsV2Request.Builder,
ListRealtimeContactAnalysisSegmentsV2Request>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The identifier of the contact in this instance of Amazon Connect.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SegmentTypes property.final String
The identifier of the Amazon Connect instance.final Integer
The maximum number of results to return per page.final String
The token for the next set of results.The Contact Lens output type to be returned.final String
The Contact Lens output type to be returned.Enum with segment types .Enum with segment types .static Class
<? extends ListRealtimeContactAnalysisSegmentsV2Request.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The identifier of the contact in this instance of Amazon Connect.
- Returns:
- The identifier of the contact in this instance of Amazon Connect.
-
maxResults
The maximum number of results to return per page.
- Returns:
- The maximum number of results to return per page.
-
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.
-
outputType
The Contact Lens output type to be returned.
If the service returns an enum value that is not available in the current SDK version,
outputType
will returnRealTimeContactAnalysisOutputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputTypeAsString()
.- Returns:
- The Contact Lens output type to be returned.
- See Also:
-
outputTypeAsString
The Contact Lens output type to be returned.
If the service returns an enum value that is not available in the current SDK version,
outputType
will returnRealTimeContactAnalysisOutputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputTypeAsString()
.- Returns:
- The Contact Lens output type to be returned.
- See Also:
-
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 theisEmpty()
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
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListRealtimeContactAnalysisSegmentsV2Request.Builder,
ListRealtimeContactAnalysisSegmentsV2Request> - Specified by:
toBuilder
in classConnectRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ListRealtimeContactAnalysisSegmentsV2Request.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-