Class DescribePipelineResponse

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.DescribePipelineResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribePipelineResponse.Builder,DescribePipelineResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribePipelineResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribePipelineResponse.Builder,DescribePipelineResponse>

Response structure for DescribePipeline operation.

  • Method Details

    • pipelineName

      public final String pipelineName()

      A unique name of the pipeline within the workspace.

      Returns:
      A unique name of the pipeline within the workspace.

    • workspaceName

      public final String workspaceName()

      The name of the workspace.

      Returns:
      The name of the workspace.

    • description

      public final String description()

      The description of the pipeline.

      Returns:
      The description of the pipeline.

    • pipelineArn

      public final String pipelineArn()

      The ARN of the pipeline.

      Returns:
      The ARN of the pipeline.

    • version

      public final String version()

      The version of the pipeline.

      Returns:
      The version of the pipeline.

    • hasEnvironmentVariables

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

    • environmentVariables

      public final Map<String,String> environmentVariables()

      The environment variables shared across all compute nodes in the pipeline.

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

      Returns:
      The environment variables shared across all compute nodes in the pipeline.

    • hasComputations

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

    • computations

      public final List<ComputeNode> computations()

      The list of compute nodes that form the pipeline DAG.

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

      Returns:
      The list of compute nodes that form the pipeline DAG.

    • status

      public final ResourceStatus status()

      The current lifecycle status of the pipeline.

      Returns:
      The current lifecycle status of the pipeline.

    • createdAt

      public final Instant createdAt()

      The time the pipeline was created, in Unix epoch time.

      Returns:
      The time the pipeline was created, in Unix epoch time.

    • updatedAt

      public final Instant updatedAt()

      The time the pipeline was last updated, in Unix epoch time.

      Returns:
      The time the pipeline was last updated, in Unix epoch time.

    • toBuilder

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

    • builder

      public static DescribePipelineResponse.Builder builder()

    • serializableBuilderClass

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