Class ListPipelineExecutionsRequest

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

Request structure for ListPipelineExecutions operation.

  • Method Details

    • workspaceName

      public final String workspaceName()

      The name of the workspace.

      Returns:
      The name of the workspace.

    • pipelineName

      public final String pipelineName()

      The name of the pipeline.

      Returns:
      The name of the pipeline.

    • nextToken

      public final String nextToken()

      The token to be used for the next set of paginated results.

      Returns:
      The token to be used for the next set of paginated results.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50.

      Returns:
      The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50.

    • state

      public final PipelineExecutionState state()

      Filter by execution state. If not specified, executions in all states are returned.

      If the service returns an enum value that is not available in the current SDK version, state will return PipelineExecutionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Filter by execution state. If not specified, executions in all states are returned.
      See Also:

    • stateAsString

      public final String stateAsString()

      Filter by execution state. If not specified, executions in all states are returned.

      If the service returns an enum value that is not available in the current SDK version, state will return PipelineExecutionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Filter by execution state. If not specified, executions in all states are returned.
      See Also:

    • startTimeAfter

      public final Instant startTimeAfter()

      Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.

      Returns:
      Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.

    • startTimeBefore

      public final Instant startTimeBefore()

      Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.

      Returns:
      Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.

    • endTimeAfter

      public final Instant endTimeAfter()

      Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

      Returns:
      Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

    • endTimeBefore

      public final Instant endTimeBefore()

      Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

      Returns:
      Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

    • toBuilder

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

    • builder

      public static ListPipelineExecutionsRequest.Builder builder()

    • serializableBuilderClass

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