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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListEngagementFromOpportunityTasksRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListEngagementFromOpportunityTasksRequest.Builder`	`builder()`
`String`	`catalog()`	Specifies the catalog related to the request.
`List<String>`	`engagementIdentifier()`	Filters tasks by the identifiers of the engagements they created or are associated with.
`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`	`hasOpportunityIdentifier()`	For responses, this returns true if the service returned a value for the OpportunityIdentifier property.
`boolean`	`hasTaskIdentifier()`	For responses, this returns true if the service returned a value for the TaskIdentifier property.
`boolean`	`hasTaskStatus()`	For responses, this returns true if the service returned a value for the TaskStatus property.
`Integer`	`maxResults()`	Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
`String`	`nextToken()`	The token for requesting the next page of results.
`List<String>`	`opportunityIdentifier()`	The identifier of the original opportunity associated with this task.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListEngagementFromOpportunityTasksRequest.Builder>`	`serializableBuilderClass()`
`ListTasksSortBase`	`sort()`	Specifies the sorting criteria for the returned results.
`List<String>`	`taskIdentifier()`	Filters tasks by their unique identifiers.
`List<TaskStatus>`	`taskStatus()`	Filters the tasks based on their current status.
`List<String>`	`taskStatusAsStrings()`	Filters the tasks based on their current status.
`ListEngagementFromOpportunityTasksRequest.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. Valid values are:
    
    AWS: Retrieves the request from the production AWS environment.
    
    Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
    Returns:
    
    Specifies the catalog related to the request. Valid values are:
    
    AWS: Retrieves the request from the production AWS environment.
    
    Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
  - 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()
```
    Filters tasks by the identifiers of the engagements they created or are associated with.
    
    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:
    
    Filters tasks by the identifiers of the engagements they created or are associated with.
  - maxResults
```
public final Integer maxResults()
```
    Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
    
    Returns:
    
    Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
  - nextToken
```
public final String nextToken()
```
    The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
    
    Returns:
    
    The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
  - hasOpportunityIdentifier
```
public final boolean hasOpportunityIdentifier()
```
    For responses, this returns true if the service returned a value for the OpportunityIdentifier 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.
  - opportunityIdentifier
```
public final List<String> opportunityIdentifier()
```
    The identifier of the original opportunity associated with this task.
    
    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 hasOpportunityIdentifier() method.
    
    Returns:
    
    The identifier of the original opportunity associated with this task.
  - sort
```
public final ListTasksSortBase sort()
```
    Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
    
    Returns:
    
    Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
  - hasTaskIdentifier
```
public final boolean hasTaskIdentifier()
```
    For responses, this returns true if the service returned a value for the TaskIdentifier 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.
  - taskIdentifier
```
public final List<String> taskIdentifier()
```
    Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
    
    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 hasTaskIdentifier() method.
    
    Returns:
    
    Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
  - taskStatus
```
public final List<TaskStatus> taskStatus()
```
    Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
    
    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 hasTaskStatus() method.
    
    Returns:
    
    Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
  - hasTaskStatus
```
public final boolean hasTaskStatus()
```
    For responses, this returns true if the service returned a value for the TaskStatus 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.
  - taskStatusAsStrings
```
public final List<String> taskStatusAsStrings()
```
    Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
    
    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 hasTaskStatus() method.
    
    Returns:
    
    Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
  - toBuilder
```
public ListEngagementFromOpportunityTasksRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListEngagementFromOpportunityTasksRequest.Builder,ListEngagementFromOpportunityTasksRequest>
    
    Specified by:
    
    toBuilder in class PartnerCentralSellingRequest
  - builder
```
public static ListEngagementFromOpportunityTasksRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListEngagementFromOpportunityTasksRequest.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 ListEngagementFromOpportunityTasksRequest

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

hasOpportunityIdentifier

opportunityIdentifier

sort

hasTaskIdentifier

taskIdentifier

taskStatus

hasTaskStatus

taskStatusAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField