GetTranscriptRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.connectparticipant.model.ConnectParticipantRequest
    - - software.amazon.awssdk.services.connectparticipant.model.GetTranscriptRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetTranscriptRequest.Builder,GetTranscriptRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetTranscriptRequest
extends ConnectParticipantRequest
implements ToCopyableBuilder<GetTranscriptRequest.Builder,GetTranscriptRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetTranscriptRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetTranscriptRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - contactId
```
public final String contactId()
```
    The contactId from the current contact chain for which transcript is needed.
    
    Returns:
    
    The contactId from the current contact chain for which transcript is needed.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return in the page. Default: 10.
    
    Returns:
    
    The maximum number of results to return in the page. Default: 10.
  - nextToken
```
public final String nextToken()
```
    The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
    
    Returns:
    
    The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
  - scanDirection
```
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().
    
    Returns:
    
    The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
    
    See Also:
    
    ScanDirection
  - scanDirectionAsString
```
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().
    
    Returns:
    
    The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
    
    See Also:
    
    ScanDirection
  - sortOrder
```
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().
    
    Returns:
    
    The sort order for the records. Default: DESCENDING.
    
    See Also:
    
    SortKey
  - sortOrderAsString
```
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().
    
    Returns:
    
    The sort order for the records. Default: DESCENDING.
    
    See Also:
    
    SortKey
  - startPosition
```
public final StartPosition startPosition()
```
    A filtering option for where to start.
    
    Returns:
    
    A filtering option for where to start.
  - connectionToken
```
public final String connectionToken()
```
    The authentication token associated with the participant's connection.
    
    Returns:
    
    The authentication token associated with the participant's connection.
  - toBuilder
```
public GetTranscriptRequest.Builder 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 interface ToCopyableBuilder<GetTranscriptRequest.Builder,GetTranscriptRequest>
    
    Specified by:
    
    toBuilder in class ConnectParticipantRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetTranscriptRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetTranscriptRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    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 an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.90

Class GetTranscriptRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

contactId

maxResults

nextToken

scanDirection

scanDirectionAsString

sortOrder

sortOrderAsString

startPosition

connectionToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields