Class ListProspectingFromEngagementTasksRequest

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.ListProspectingFromEngagementTasksRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListProspectingFromEngagementTasksRequest.Builder,ListProspectingFromEngagementTasksRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListProspectingFromEngagementTasksRequest extends PartnerCentralSellingRequest implements ToCopyableBuilder<ListProspectingFromEngagementTasksRequest.Builder,ListProspectingFromEngagementTasksRequest>

Represents the request structure for listing prospecting tasks. All filter parameters are optional. Results are paginated — uses NextToken from the response to retrieve subsequent pages.

  • Method Details

    • catalog

      public final String catalog()

      Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes.

      Returns:
      Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in a single page. If additional results exist, the response includes a NextToken value for retrieving the next page. If omitted, the API uses a service-defined default page size.

      Returns:
      The maximum number of results to return in a single page. If additional results exist, the response includes a NextToken value for retrieving the next page. If omitted, the API uses a service-defined default page size.

    • nextToken

      public final String nextToken()

      The pagination token from a previous call to this API. Include this value to retrieve the next page of results. If omitted, the first page is returned.

      Returns:
      The pagination token from a previous call to this API. Include this value to retrieve the next page of results. If omitted, the first page is returned.

    • 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 the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.

      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 the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.

    • hasTaskName

      public final boolean hasTaskName()
      For responses, this returns true if the service returned a value for the TaskName 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.

    • taskName

      public final List<String> taskName()

      Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.

      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 hasTaskName() method.

      Returns:
      Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.

    • startAfter

      public final Instant startAfter()

      Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation.

      Returns:
      Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation.

    • startBefore

      public final Instant startBefore()

      Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation.

      Returns:
      Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation.

    • sort

      public final ProspectingFromEngagementTaskSort sort()

      Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.

      Returns:
      Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.

    • toBuilder

      public ListProspectingFromEngagementTasksRequest.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<ListProspectingFromEngagementTasksRequest.Builder,ListProspectingFromEngagementTasksRequest>
      Specified by:
      toBuilder in class PartnerCentralSellingRequest
      Returns:
      a builder for type T

    • builder

      public static ListProspectingFromEngagementTasksRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListProspectingFromEngagementTasksRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.