Class DescribePipeResponse

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

  • Method Details

    • arn

      public final String arn()

      The ARN of the pipe.

      Returns:
      The ARN of the pipe.

    • name

      public final String name()

      The name of the pipe.

      Returns:
      The name of the pipe.

    • description

      public final String description()

      A description of the pipe.

      Returns:
      A description of the pipe.

    • desiredState

      public final RequestedPipeStateDescribeResponse desiredState()

      The state the pipe should be in.

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

      Returns:
      The state the pipe should be in.
      See Also:

    • desiredStateAsString

      public final String desiredStateAsString()

      The state the pipe should be in.

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

      Returns:
      The state the pipe should be in.
      See Also:

    • currentState

      public final PipeState currentState()

      The state the pipe is in.

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

      Returns:
      The state the pipe is in.
      See Also:

    • currentStateAsString

      public final String currentStateAsString()

      The state the pipe is in.

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

      Returns:
      The state the pipe is in.
      See Also:

    • stateReason

      public final String stateReason()

      The reason the pipe is in its current state.

      Returns:
      The reason the pipe is in its current state.

    • source

      public final String source()

      The ARN of the source resource.

      Returns:
      The ARN of the source resource.

    • sourceParameters

      public final PipeSourceParameters sourceParameters()

      The parameters required to set up a source for your pipe.

      Returns:
      The parameters required to set up a source for your pipe.

    • enrichment

      public final String enrichment()

      The ARN of the enrichment resource.

      Returns:
      The ARN of the enrichment resource.

    • enrichmentParameters

      public final PipeEnrichmentParameters enrichmentParameters()

      The parameters required to set up enrichment on your pipe.

      Returns:
      The parameters required to set up enrichment on your pipe.

    • target

      public final String target()

      The ARN of the target resource.

      Returns:
      The ARN of the target resource.

    • targetParameters

      public final PipeTargetParameters targetParameters()

      The parameters required to set up a target for your pipe.

      For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

      Returns:
      The parameters required to set up a target for your pipe.

      For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

    • roleArn

      public final String roleArn()

      The ARN of the role that allows the pipe to send data to the target.

      Returns:
      The ARN of the role that allows the pipe to send data to the target.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The list of key-value pairs to associate with the pipe.

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

      Returns:
      The list of key-value pairs to associate with the pipe.

    • creationTime

      public final Instant creationTime()

      The time the pipe was created.

      Returns:
      The time the pipe was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

      Returns:
      When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    • logConfiguration

      public final PipeLogConfiguration logConfiguration()

      The logging configuration settings for the pipe.

      Returns:
      The logging configuration settings for the pipe.

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.

      For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

      Returns:
      The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.

      For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    • toBuilder

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

    • builder

      public static DescribePipeResponse.Builder builder()

    • serializableBuilderClass

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