Package software.amazon.awssdk.services.swf.model

Class ListClosedWorkflowExecutionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.swf.model.SwfRequest
software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListClosedWorkflowExecutionsRequest extends SwfRequest implements ToCopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>

  • Method Details

    • domain

      public final String domain()

      The name of the domain that contains the workflow executions to list.

      Returns:
      The name of the domain that contains the workflow executions to list.

    • startTimeFilter

      public final ExecutionTimeFilter startTimeFilter()

      If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

      Returns:
      If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    • closeTimeFilter

      public final ExecutionTimeFilter closeTimeFilter()

      If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

      Returns:
      If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    • executionFilter

      public final WorkflowExecutionFilter executionFilter()

      If specified, only workflow executions matching the workflow ID specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      Returns:
      If specified, only workflow executions matching the workflow ID specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    • closeStatusFilter

      public final CloseStatusFilter closeStatusFilter()

      If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      Returns:
      If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    • typeFilter

      public final WorkflowTypeFilter typeFilter()

      If specified, only executions of the type specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      Returns:
      If specified, only executions of the type specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    • tagFilter

      public final TagFilter tagFilter()

      If specified, only executions that have the matching tag are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      Returns:
      If specified, only executions that have the matching tag are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    • nextPageToken

      public final String nextPageToken()

      If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

      Returns:
      If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

    • maximumPageSize

      public final Integer maximumPageSize()

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

      Returns:
      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    • reverseOrder

      public final Boolean reverseOrder()

      When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

      Returns:
      When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

    • toBuilder

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

    • builder

      public static ListClosedWorkflowExecutionsRequest.Builder builder()

    • serializableBuilderClass

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