Class ListDurableExecutionsByFunctionRequest

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

  • Method Details

    • functionName

      public final String functionName()

      The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.

      Returns:
      The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.

    • qualifier

      public final String qualifier()

      The function version or alias. If not specified, lists executions for the $LATEST version.

      Returns:
      The function version or alias. If not specified, lists executions for the $LATEST version.

    • durableExecutionName

      public final String durableExecutionName()

      Filter executions by name. Only executions with names that contain this string are returned.

      Returns:
      Filter executions by name. Only executions with names that contain this string are returned.

    • statuses

      public final List<ExecutionStatus> statuses()

      Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.

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

      Returns:
      Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.

    • hasStatuses

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

    • statusesAsStrings

      public final List<String> statusesAsStrings()

      Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.

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

      Returns:
      Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.

    • startedAfter

      public final Instant startedAfter()

      Filter executions that started after this timestamp (ISO 8601 format).

      Returns:
      Filter executions that started after this timestamp (ISO 8601 format).

    • startedBefore

      public final Instant startedBefore()

      Filter executions that started before this timestamp (ISO 8601 format).

      Returns:
      Filter executions that started before this timestamp (ISO 8601 format).

    • reverseOrder

      public final Boolean reverseOrder()

      Set to true to return results in reverse chronological order (newest first). Default is false.

      Returns:
      Set to true to return results in reverse chronological order (newest first). Default is false.

    • marker

      public final String marker()

      Pagination token from a previous request to continue retrieving results.

      Returns:
      Pagination token from a previous request to continue retrieving results.

    • maxItems

      public final Integer maxItems()

      Maximum number of executions to return (1-1000). Default is 100.

      Returns:
      Maximum number of executions to return (1-1000). Default is 100.

    • toBuilder

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

    • builder

      public static ListDurableExecutionsByFunctionRequest.Builder builder()

    • serializableBuilderClass

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