Class ListEngagementByAcceptingInvitationTasksRequest

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

      • hasEngagementInvitationIdentifier

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

        public final List<String> engagementInvitationIdentifier()

        Filters tasks by the identifiers of the engagement invitations they are processing.

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

        Returns:
        Filters tasks by the identifiers of the engagement invitations they are processing.
      • maxResults

        public final Integer maxResults()

        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:
        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()

        Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.

        Returns:
        Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.
      • 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()

        Filters tasks by the identifiers of the opportunities 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 hasOpportunityIdentifier() method.

        Returns:
        Filters tasks by the identifiers of the opportunities they created or are associated with.
      • 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.
      • 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