Class DescribePipelineExecutionResponse

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

Response structure for DescribePipelineExecution operation.

  • Method Details

    • pipelineExecutionId

      public final String pipelineExecutionId()

      The unique identifier of the pipeline execution.

      Returns:
      The unique identifier of the pipeline execution.

    • pipelineName

      public final String pipelineName()

      The name of the pipeline.

      Returns:
      The name of the pipeline.

    • workspaceName

      public final String workspaceName()

      The name of the workspace.

      Returns:
      The name of the workspace.

    • pipelineVersion

      public final String pipelineVersion()

      The pipeline version this execution ran against.

      Returns:
      The pipeline version this execution ran against.

    • status

      public final PipelineExecutionStatus status()

      The current execution status of the pipeline.

      Returns:
      The current execution status of the pipeline.

    • startTime

      public final Instant startTime()

      The time the pipeline execution started, in Unix epoch time.

      Returns:
      The time the pipeline execution started, in Unix epoch time.

    • endTime

      public final Instant endTime()

      The time the pipeline execution completed, in Unix epoch time.

      Returns:
      The time the pipeline execution completed, in Unix epoch time.

    • requestEnvironmentVariables

      public final ExecutionEnvironmentVariables requestEnvironmentVariables()

      The environment variables provided as input for the pipeline execution.

      Returns:
      The environment variables provided as input for the pipeline execution.

    • executionPriority

      public final Integer executionPriority()

      Scheduling priority for the execution. When not specified, defaults to lowest priority.

      Returns:
      Scheduling priority for the execution. When not specified, defaults to lowest priority.

    • hasComputeNodeExecutionDetails

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

    • computeNodeExecutionDetails

      public final List<ComputeNodeExecutionDetails> computeNodeExecutionDetails()

      A list of compute node execution details within this pipeline execution.

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

      Returns:
      A list of compute node execution details within this pipeline execution.

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

    • toBuilder

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

    • builder

      public static DescribePipelineExecutionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribePipelineExecutionResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.