Class ListChatsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListChatsRequest.Builder,ListChatsRequest>
Request structure for listing chats
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe unique identifier for the agent space to list chats from.final ChatArchiveStatusThe archive status to filter by.final StringThe archive status to filter by.static ListChatsRequest.Builderbuilder()final booleanfinal booleanequalsBySdkFields(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 inthashCode()final IntegerMaximum number of results to returnfinal StringToken for paginationstatic Class<? extends ListChatsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final StringuserId()Deprecated.userId is managed by the service and should not be provided by the callerMethods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
agentSpaceId
The unique identifier for the agent space to list chats from.
- Returns:
- The unique identifier for the agent space to list chats from.
-
userId
Deprecated.userId is managed by the service and should not be provided by the callerThe user identifier to list chats for. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.
- Returns:
- The user identifier to list chats for. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.
-
maxResults
Maximum number of results to return
- Returns:
- Maximum number of results to return
-
nextToken
-
archiveStatus
The archive status to filter by. Use this parameter to list only archived chat executions or only active ones.
If the service returns an enum value that is not available in the current SDK version,
archiveStatuswill returnChatArchiveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromarchiveStatusAsString().- Returns:
- The archive status to filter by. Use this parameter to list only archived chat executions or only active ones.
- See Also:
-
archiveStatusAsString
The archive status to filter by. Use this parameter to list only archived chat executions or only active ones.
If the service returns an enum value that is not available in the current SDK version,
archiveStatuswill returnChatArchiveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromarchiveStatusAsString().- Returns:
- The archive status to filter by. Use this parameter to list only archived chat executions or only active ones.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ListChatsRequest.Builder,ListChatsRequest> - Specified by:
toBuilderin classDevOpsAgentRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
Description copied from class:SdkRequestUsed 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:
getValueForFieldin 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-