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.ListEngagementInvitationsRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListEngagementInvitationsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListEngagementInvitationsRequest.Builder`	`builder()`
`String`	`catalog()`	Specifies the catalog from which to list the engagement invitations.
`List<String>`	`engagementIdentifier()`	Retrieves a list of engagement invitation summaries based on specified filters.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEngagementIdentifier()`	For responses, this returns true if the service returned a value for the EngagementIdentifier property.
`int`	`hashCode()`
`boolean`	`hasPayloadType()`	For responses, this returns true if the service returned a value for the PayloadType property.
`boolean`	`hasSenderAwsAccountId()`	For responses, this returns true if the service returned a value for the SenderAwsAccountId property.
`boolean`	`hasStatus()`	For responses, this returns true if the service returned a value for the Status property.
`Integer`	`maxResults()`	Specifies the maximum number of engagement invitations to return in the response.
`String`	`nextToken()`	A pagination token used to retrieve additional pages of results when the response to a previous request was truncated.
`ParticipantType`	`participantType()`	Specifies the type of participant for which to list engagement invitations.
`String`	`participantTypeAsString()`	Specifies the type of participant for which to list engagement invitations.
`List<EngagementInvitationPayloadType>`	`payloadType()`	Defines the type of payload associated with the engagement invitations to be listed.
`List<String>`	`payloadTypeAsStrings()`	Defines the type of payload associated with the engagement invitations to be listed.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`senderAwsAccountId()`	List of sender AWS account IDs to filter the invitations.
`static Class<? extends ListEngagementInvitationsRequest.Builder>`	`serializableBuilderClass()`
`OpportunityEngagementInvitationSort`	`sort()`	Specifies the sorting options for listing engagement invitations.
`List<InvitationStatus>`	`status()`	Status values to filter the invitations.
`List<String>`	`statusAsStrings()`	Status values to filter the invitations.
`ListEngagementInvitationsRequest.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 from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.
    
    Returns:
    
    Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.
  - 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()
```
    Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.
    
    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:
    
    Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.
  - maxResults
```
public final Integer maxResults()
```
    Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
    
    Returns:
    
    Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
  - nextToken
```
public final String nextToken()
```
    A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.
    
    Returns:
    
    A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.
  - participantType
```
public final ParticipantType participantType()
```
    Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
    
    If the service returns an enum value that is not available in the current SDK version, participantType will return ParticipantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from participantTypeAsString().
    
    Returns:
    
    Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
    
    See Also:
    
    ParticipantType
  - participantTypeAsString
```
public final String participantTypeAsString()
```
    Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
    
    If the service returns an enum value that is not available in the current SDK version, participantType will return ParticipantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from participantTypeAsString().
    
    Returns:
    
    Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
    
    See Also:
    
    ParticipantType
  - payloadType
```
public final List<EngagementInvitationPayloadType> payloadType()
```
    Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
    
    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 hasPayloadType() method.
    
    Returns:
    
    Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
  - hasPayloadType
```
public final boolean hasPayloadType()
```
    For responses, this returns true if the service returned a value for the PayloadType 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.
  - payloadTypeAsStrings
```
public final List<String> payloadTypeAsStrings()
```
    Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
    
    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 hasPayloadType() method.
    
    Returns:
    
    Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
  - hasSenderAwsAccountId
```
public final boolean hasSenderAwsAccountId()
```
    For responses, this returns true if the service returned a value for the SenderAwsAccountId 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.
  - senderAwsAccountId
```
public final List<String> senderAwsAccountId()
```
    List of sender AWS account IDs to filter the invitations.
    
    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 hasSenderAwsAccountId() method.
    
    Returns:
    
    List of sender AWS account IDs to filter the invitations.
  - sort
```
public final OpportunityEngagementInvitationSort sort()
```
    Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.
    
    Returns:
    
    Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.
  - status
```
public final List<InvitationStatus> status()
```
    Status values to filter the invitations.
    
    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 hasStatus() method.
    
    Returns:
    
    Status values to filter the invitations.
  - hasStatus
```
public final boolean hasStatus()
```
    For responses, this returns true if the service returned a value for the Status 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.
  - statusAsStrings
```
public final List<String> statusAsStrings()
```
    Status values to filter the invitations.
    
    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 hasStatus() method.
    
    Returns:
    
    Status values to filter the invitations.
  - toBuilder
```
public ListEngagementInvitationsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListEngagementInvitationsRequest.Builder,ListEngagementInvitationsRequest>
    
    Specified by:
    
    toBuilder in class PartnerCentralSellingRequest
  - builder
```
public static ListEngagementInvitationsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListEngagementInvitationsRequest.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 ListEngagementInvitationsRequest

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

hasEngagementIdentifier

engagementIdentifier

maxResults

nextToken

participantType

participantTypeAsString

payloadType

hasPayloadType

payloadTypeAsStrings

hasSenderAwsAccountId

senderAwsAccountId

sort

status

hasStatus

statusAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField