@Generated(value="software.amazon.awssdk:codegen") public final class GetTranscriptRequest extends ConnectParticipantRequest implements ToCopyableBuilder<GetTranscriptRequest.Builder,GetTranscriptRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetTranscriptRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetTranscriptRequest.Builder |
builder() |
String |
connectionToken()
The authentication token associated with the participant's connection.
|
String |
contactId()
The contactId from the current contact chain for which transcript is needed.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
maxResults()
The maximum number of results to return in the page.
|
String |
nextToken()
The pagination token.
|
ScanDirection |
scanDirection()
The direction from StartPosition from which to retrieve message.
|
String |
scanDirectionAsString()
The direction from StartPosition from which to retrieve message.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetTranscriptRequest.Builder> |
serializableBuilderClass() |
SortKey |
sortOrder()
The sort order for the records.
|
String |
sortOrderAsString()
The sort order for the records.
|
StartPosition |
startPosition()
A filtering option for where to start.
|
GetTranscriptRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String contactId()
The contactId from the current contact chain for which transcript is needed.
public final Integer maxResults()
The maximum number of results to return in the page. Default: 10.
public final String nextToken()
The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
public final ScanDirection scanDirection()
The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
If the service returns an enum value that is not available in the current SDK version, scanDirection
will return ScanDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
scanDirectionAsString()
.
ScanDirection
public final String scanDirectionAsString()
The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
If the service returns an enum value that is not available in the current SDK version, scanDirection
will return ScanDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
scanDirectionAsString()
.
ScanDirection
public final SortKey sortOrder()
The sort order for the records. Default: DESCENDING.
If the service returns an enum value that is not available in the current SDK version, sortOrder
will
return SortKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
sortOrderAsString()
.
SortKey
public final String sortOrderAsString()
The sort order for the records. Default: DESCENDING.
If the service returns an enum value that is not available in the current SDK version, sortOrder
will
return SortKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
sortOrderAsString()
.
SortKey
public final StartPosition startPosition()
A filtering option for where to start.
public final String connectionToken()
The authentication token associated with the participant's connection.
public GetTranscriptRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetTranscriptRequest.Builder,GetTranscriptRequest>
toBuilder
in class ConnectParticipantRequest
public static GetTranscriptRequest.Builder builder()
public static Class<? extends GetTranscriptRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.