java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingRequest
    - - software.amazon.awssdk.services.partnercentralselling.model.ListEngagementsRequest

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

@Generated("software.amazon.awssdk:codegen")
public final class ListEngagementsRequest
extends PartnerCentralSellingRequest
implements ToCopyableBuilder<ListEngagementsRequest.Builder,ListEngagementsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListEngagementsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListEngagementsRequest.Builder`	`builder()`
`String`	`catalog()`	Specifies the catalog related to the request.
`List<String>`	`createdBy()`	A list of AWS account IDs.
`List<String>`	`engagementIdentifier()`	An array of strings representing engagement identifiers to retrieve.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`excludeCreatedBy()`	An array of strings representing AWS Account IDs.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCreatedBy()`	For responses, this returns true if the service returned a value for the CreatedBy property.
`boolean`	`hasEngagementIdentifier()`	For responses, this returns true if the service returned a value for the EngagementIdentifier property.
`boolean`	`hasExcludeCreatedBy()`	For responses, this returns true if the service returned a value for the ExcludeCreatedBy property.
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of results to return in a single call.
`String`	`nextToken()`	The token for the next set of results.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListEngagementsRequest.Builder>`	`serializableBuilderClass()`
`EngagementSort`	`sort()`	An object that specifies the sort order of the results.
`ListEngagementsRequest.Builder`	`toBuilder()`
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - catalog
```
public final String catalog()
```
    Specifies the catalog related to the request.
    
    Returns:
    
    Specifies the catalog related to the request.
  - hasCreatedBy
```
public final boolean hasCreatedBy()
```
    For responses, this returns true if the service returned a value for the CreatedBy 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.
  - createdBy
```
public final List<String> createdBy()
```
    A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.
    
    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 hasCreatedBy() method.
    
    Returns:
    
    A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.
  - hasEngagementIdentifier
```
public final boolean hasEngagementIdentifier()
```
    For responses, this returns true if the service returned a value for the EngagementIdentifier 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.
  - engagementIdentifier
```
public final List<String> engagementIdentifier()
```
    An array of strings representing engagement identifiers to retrieve.
    
    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 hasEngagementIdentifier() method.
    
    Returns:
    
    An array of strings representing engagement identifiers to retrieve.
  - hasExcludeCreatedBy
```
public final boolean hasExcludeCreatedBy()
```
    For responses, this returns true if the service returned a value for the ExcludeCreatedBy 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.
  - excludeCreatedBy
```
public final List<String> excludeCreatedBy()
```
    An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.
    
    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 hasExcludeCreatedBy() method.
    
    Returns:
    
    An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return in a single call.
    
    Returns:
    
    The maximum number of results to return in a single call.
  - nextToken
```
public final String nextToken()
```
    The token for the next set of results. This value is returned from a previous call.
    
    Returns:
    
    The token for the next set of results. This value is returned from a previous call.
  - sort
```
public final EngagementSort sort()
```
    An object that specifies the sort order of the results.
    
    Returns:
    
    An object that specifies the sort order of the results.
  - toBuilder
```
public ListEngagementsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListEngagementsRequest.Builder,ListEngagementsRequest>
    
    Specified by:
    
    toBuilder in class PartnerCentralSellingRequest
  - builder
```
public static ListEngagementsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListEngagementsRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListEngagementsRequest

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

catalog

hasCreatedBy

createdBy

hasEngagementIdentifier

engagementIdentifier

hasExcludeCreatedBy

excludeCreatedBy

maxResults

nextToken

sort

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField