DescribePipeResponse (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribePipeResponse
extends PipesResponse
implements ToCopyableBuilder<DescribePipeResponse.Builder,DescribePipeResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribePipeResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribePipeResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The ARN of the pipe.
`static DescribePipeResponse.Builder`	`builder()`
`Instant`	`creationTime()` The time the pipe was created.
`PipeState`	`currentState()` The state the pipe is in.
`String`	`currentStateAsString()` The state the pipe is in.
`String`	`description()` A description of the pipe.
`RequestedPipeStateDescribeResponse`	`desiredState()` The state the pipe should be in.
`String`	`desiredStateAsString()` The state the pipe should be in.
`String`	`enrichment()` The ARN of the enrichment resource.
`PipeEnrichmentParameters`	`enrichmentParameters()` The parameters required to set up enrichment on your pipe.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Instant`	`lastModifiedTime()` When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
`String`	`name()` The name of the pipe.
`String`	`roleArn()` The ARN of the role that allows the pipe to send data to the target.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribePipeResponse.Builder>`	`serializableBuilderClass()`
`String`	`source()` The ARN of the source resource.
`PipeSourceParameters`	`sourceParameters()` The parameters required to set up a source for your pipe.
`String`	`stateReason()` The reason the pipe is in its current state.
`Map<String,String>`	`tags()` The list of key-value pairs to associate with the pipe.
`String`	`target()` The ARN of the target resource.
`PipeTargetParameters`	`targetParameters()` The parameters required to set up a target for your pipe.
`DescribePipeResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.pipes.model.PipesResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The ARN of the pipe.
    
    Returns:
    
    The ARN of the pipe.
  - creationTime
```
public final Instant creationTime()
```
    The time the pipe was created.
    
    Returns:
    
    The time the pipe was created.
  - 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:
    
    PipeState
  - 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:
    
    PipeState
  - 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:
    
    RequestedPipeStateDescribeResponse
  - 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:
    
    RequestedPipeStateDescribeResponse
  - 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.
  - 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).
  - name
```
public final String name()
```
    The name of the pipe.
    
    Returns:
    
    The name of the pipe.
  - 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.
  - 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.
  - stateReason
```
public final String stateReason()
```
    The reason the pipe is in its current state.
    
    Returns:
    
    The reason the pipe is in its current state.
  - 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.
  - 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.
    
    Returns:
    
    The parameters required to set up a target for your pipe.
  - toBuilder
```
public DescribePipeResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribePipeResponse.Builder,DescribePipeResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribePipeResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.pipes.model.PipesResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

creationTime

currentState

currentStateAsString

description

desiredState

desiredStateAsString

enrichment

enrichmentParameters

lastModifiedTime

name

roleArn

source

sourceParameters

stateReason

hasTags

tags

target

targetParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields