DescribePipeResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.pipes.model.DescribePipeResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribePipeResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribePipeResult()

Constructors
Constructor and Description
`DescribePipeResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribePipeResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`DescribePipeResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`DescribePipeResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The ARN of the pipe.
`Date`	`getCreationTime()` The time the pipe was created.
`String`	`getCurrentState()` The state the pipe is in.
`String`	`getDescription()` A description of the pipe.
`String`	`getDesiredState()` The state the pipe should be in.
`String`	`getEnrichment()` The ARN of the enrichment resource.
`PipeEnrichmentParameters`	`getEnrichmentParameters()` The parameters required to set up enrichment on your pipe.
`Date`	`getLastModifiedTime()` When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
`PipeLogConfiguration`	`getLogConfiguration()` The logging configuration settings for the pipe.
`String`	`getName()` The name of the pipe.
`String`	`getRoleArn()` The ARN of the role that allows the pipe to send data to the target.
`String`	`getSource()` The ARN of the source resource.
`PipeSourceParameters`	`getSourceParameters()` The parameters required to set up a source for your pipe.
`String`	`getStateReason()` The reason the pipe is in its current state.
`Map<String,String>`	`getTags()` The list of key-value pairs to associate with the pipe.
`String`	`getTarget()` The ARN of the target resource.
`PipeTargetParameters`	`getTargetParameters()` The parameters required to set up a target for your pipe.
`int`	`hashCode()`
`void`	`setArn(String arn)` The ARN of the pipe.
`void`	`setCreationTime(Date creationTime)` The time the pipe was created.
`void`	`setCurrentState(String currentState)` The state the pipe is in.
`void`	`setDescription(String description)` A description of the pipe.
`void`	`setDesiredState(String desiredState)` The state the pipe should be in.
`void`	`setEnrichment(String enrichment)` The ARN of the enrichment resource.
`void`	`setEnrichmentParameters(PipeEnrichmentParameters enrichmentParameters)` The parameters required to set up enrichment on your pipe.
`void`	`setLastModifiedTime(Date lastModifiedTime)` When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
`void`	`setLogConfiguration(PipeLogConfiguration logConfiguration)` The logging configuration settings for the pipe.
`void`	`setName(String name)` The name of the pipe.
`void`	`setRoleArn(String roleArn)` The ARN of the role that allows the pipe to send data to the target.
`void`	`setSource(String source)` The ARN of the source resource.
`void`	`setSourceParameters(PipeSourceParameters sourceParameters)` The parameters required to set up a source for your pipe.
`void`	`setStateReason(String stateReason)` The reason the pipe is in its current state.
`void`	`setTags(Map<String,String> tags)` The list of key-value pairs to associate with the pipe.
`void`	`setTarget(String target)` The ARN of the target resource.
`void`	`setTargetParameters(PipeTargetParameters targetParameters)` The parameters required to set up a target for your pipe.
`String`	`toString()` Returns a string representation of this object.
`DescribePipeResult`	`withArn(String arn)` The ARN of the pipe.
`DescribePipeResult`	`withCreationTime(Date creationTime)` The time the pipe was created.
`DescribePipeResult`	`withCurrentState(PipeState currentState)` The state the pipe is in.
`DescribePipeResult`	`withCurrentState(String currentState)` The state the pipe is in.
`DescribePipeResult`	`withDescription(String description)` A description of the pipe.
`DescribePipeResult`	`withDesiredState(RequestedPipeStateDescribeResponse desiredState)` The state the pipe should be in.
`DescribePipeResult`	`withDesiredState(String desiredState)` The state the pipe should be in.
`DescribePipeResult`	`withEnrichment(String enrichment)` The ARN of the enrichment resource.
`DescribePipeResult`	`withEnrichmentParameters(PipeEnrichmentParameters enrichmentParameters)` The parameters required to set up enrichment on your pipe.
`DescribePipeResult`	`withLastModifiedTime(Date lastModifiedTime)` When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
`DescribePipeResult`	`withLogConfiguration(PipeLogConfiguration logConfiguration)` The logging configuration settings for the pipe.
`DescribePipeResult`	`withName(String name)` The name of the pipe.
`DescribePipeResult`	`withRoleArn(String roleArn)` The ARN of the role that allows the pipe to send data to the target.
`DescribePipeResult`	`withSource(String source)` The ARN of the source resource.
`DescribePipeResult`	`withSourceParameters(PipeSourceParameters sourceParameters)` The parameters required to set up a source for your pipe.
`DescribePipeResult`	`withStateReason(String stateReason)` The reason the pipe is in its current state.
`DescribePipeResult`	`withTags(Map<String,String> tags)` The list of key-value pairs to associate with the pipe.
`DescribePipeResult`	`withTarget(String target)` The ARN of the target resource.
`DescribePipeResult`	`withTargetParameters(PipeTargetParameters targetParameters)` The parameters required to set up a target for your pipe.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribePipeResult
```
public DescribePipeResult()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The ARN of the pipe.
    
    Parameters:
    
    arn - The ARN of the pipe.
  - getArn
```
public String getArn()
```
    The ARN of the pipe.
    
    Returns:
    
    The ARN of the pipe.
  - withArn
```
public DescribePipeResult withArn(String arn)
```
    The ARN of the pipe.
    
    Parameters:
    
    arn - The ARN of the pipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the pipe.
    
    Parameters:
    
    name - The name of the pipe.
  - getName
```
public String getName()
```
    The name of the pipe.
    
    Returns:
    
    The name of the pipe.
  - withName
```
public DescribePipeResult withName(String name)
```
    The name of the pipe.
    
    Parameters:
    
    name - The name of the pipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the pipe.
    
    Parameters:
    
    description - A description of the pipe.
  - getDescription
```
public String getDescription()
```
    A description of the pipe.
    
    Returns:
    
    A description of the pipe.
  - withDescription
```
public DescribePipeResult withDescription(String description)
```
    A description of the pipe.
    
    Parameters:
    
    description - A description of the pipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredState
```
public void setDesiredState(String desiredState)
```
    The state the pipe should be in.
    
    Parameters:
    
    desiredState - The state the pipe should be in.
    
    See Also:
    
    RequestedPipeStateDescribeResponse
  - getDesiredState
```
public String getDesiredState()
```
    The state the pipe should be in.
    
    Returns:
    
    The state the pipe should be in.
    
    See Also:
    
    RequestedPipeStateDescribeResponse
  - withDesiredState
```
public DescribePipeResult withDesiredState(String desiredState)
```
    The state the pipe should be in.
    
    Parameters:
    
    desiredState - The state the pipe should be in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequestedPipeStateDescribeResponse
  - withDesiredState
```
public DescribePipeResult withDesiredState(RequestedPipeStateDescribeResponse desiredState)
```
    The state the pipe should be in.
    
    Parameters:
    
    desiredState - The state the pipe should be in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequestedPipeStateDescribeResponse
  - setCurrentState
```
public void setCurrentState(String currentState)
```
    The state the pipe is in.
    
    Parameters:
    
    currentState - The state the pipe is in.
    
    See Also:
    
    PipeState
  - getCurrentState
```
public String getCurrentState()
```
    The state the pipe is in.
    
    Returns:
    
    The state the pipe is in.
    
    See Also:
    
    PipeState
  - withCurrentState
```
public DescribePipeResult withCurrentState(String currentState)
```
    The state the pipe is in.
    
    Parameters:
    
    currentState - The state the pipe is in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipeState
  - withCurrentState
```
public DescribePipeResult withCurrentState(PipeState currentState)
```
    The state the pipe is in.
    
    Parameters:
    
    currentState - The state the pipe is in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipeState
  - setStateReason
```
public void setStateReason(String stateReason)
```
    The reason the pipe is in its current state.
    
    Parameters:
    
    stateReason - The reason the pipe is in its current state.
  - getStateReason
```
public String getStateReason()
```
    The reason the pipe is in its current state.
    
    Returns:
    
    The reason the pipe is in its current state.
  - withStateReason
```
public DescribePipeResult withStateReason(String stateReason)
```
    The reason the pipe is in its current state.
    
    Parameters:
    
    stateReason - The reason the pipe is in its current state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSource
```
public void setSource(String source)
```
    The ARN of the source resource.
    
    Parameters:
    
    source - The ARN of the source resource.
  - getSource
```
public String getSource()
```
    The ARN of the source resource.
    
    Returns:
    
    The ARN of the source resource.
  - withSource
```
public DescribePipeResult withSource(String source)
```
    The ARN of the source resource.
    
    Parameters:
    
    source - The ARN of the source resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceParameters
```
public void setSourceParameters(PipeSourceParameters sourceParameters)
```
    The parameters required to set up a source for your pipe.
    
    Parameters:
    
    sourceParameters - The parameters required to set up a source for your pipe.
  - getSourceParameters
```
public PipeSourceParameters getSourceParameters()
```
    The parameters required to set up a source for your pipe.
    
    Returns:
    
    The parameters required to set up a source for your pipe.
  - withSourceParameters
```
public DescribePipeResult withSourceParameters(PipeSourceParameters sourceParameters)
```
    The parameters required to set up a source for your pipe.
    
    Parameters:
    
    sourceParameters - The parameters required to set up a source for your pipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnrichment
```
public void setEnrichment(String enrichment)
```
    The ARN of the enrichment resource.
    
    Parameters:
    
    enrichment - The ARN of the enrichment resource.
  - getEnrichment
```
public String getEnrichment()
```
    The ARN of the enrichment resource.
    
    Returns:
    
    The ARN of the enrichment resource.
  - withEnrichment
```
public DescribePipeResult withEnrichment(String enrichment)
```
    The ARN of the enrichment resource.
    
    Parameters:
    
    enrichment - The ARN of the enrichment resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnrichmentParameters
```
public void setEnrichmentParameters(PipeEnrichmentParameters enrichmentParameters)
```
    The parameters required to set up enrichment on your pipe.
    
    Parameters:
    
    enrichmentParameters - The parameters required to set up enrichment on your pipe.
  - getEnrichmentParameters
```
public PipeEnrichmentParameters getEnrichmentParameters()
```
    The parameters required to set up enrichment on your pipe.
    
    Returns:
    
    The parameters required to set up enrichment on your pipe.
  - withEnrichmentParameters
```
public DescribePipeResult withEnrichmentParameters(PipeEnrichmentParameters enrichmentParameters)
```
    The parameters required to set up enrichment on your pipe.
    
    Parameters:
    
    enrichmentParameters - The parameters required to set up enrichment on your pipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTarget
```
public void setTarget(String target)
```
    The ARN of the target resource.
    
    Parameters:
    
    target - The ARN of the target resource.
  - getTarget
```
public String getTarget()
```
    The ARN of the target resource.
    
    Returns:
    
    The ARN of the target resource.
  - withTarget
```
public DescribePipeResult withTarget(String target)
```
    The ARN of the target resource.
    
    Parameters:
    
    target - The ARN of the target resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetParameters
```
public void setTargetParameters(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.
    
    Parameters:
    
    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.
  - getTargetParameters
```
public PipeTargetParameters getTargetParameters()
```
    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.
  - withTargetParameters
```
public DescribePipeResult withTargetParameters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of the role that allows the pipe to send data to the target.
    
    Parameters:
    
    roleArn - The ARN of the role that allows the pipe to send data to the target.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public DescribePipeResult withRoleArn(String roleArn)
```
    The ARN of the role that allows the pipe to send data to the target.
    
    Parameters:
    
    roleArn - The ARN of the role that allows the pipe to send data to the target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The list of key-value pairs to associate with the pipe.
    
    Returns:
    
    The list of key-value pairs to associate with the pipe.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The list of key-value pairs to associate with the pipe.
    
    Parameters:
    
    tags - The list of key-value pairs to associate with the pipe.
  - withTags
```
public DescribePipeResult withTags(Map<String,String> tags)
```
    The list of key-value pairs to associate with the pipe.
    
    Parameters:
    
    tags - The list of key-value pairs to associate with the pipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public DescribePipeResult addTagsEntry(String key,
                                       String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public DescribePipeResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time the pipe was created.
    
    Parameters:
    
    creationTime - The time the pipe was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time the pipe was created.
    
    Returns:
    
    The time the pipe was created.
  - withCreationTime
```
public DescribePipeResult withCreationTime(Date creationTime)
```
    The time the pipe was created.
    
    Parameters:
    
    creationTime - The time the pipe was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    
    Parameters:
    
    lastModifiedTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    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).
  - withLastModifiedTime
```
public DescribePipeResult withLastModifiedTime(Date lastModifiedTime)
```
    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    
    Parameters:
    
    lastModifiedTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogConfiguration
```
public void setLogConfiguration(PipeLogConfiguration logConfiguration)
```
    The logging configuration settings for the pipe.
    
    Parameters:
    
    logConfiguration - The logging configuration settings for the pipe.
  - getLogConfiguration
```
public PipeLogConfiguration getLogConfiguration()
```
    The logging configuration settings for the pipe.
    
    Returns:
    
    The logging configuration settings for the pipe.
  - withLogConfiguration
```
public DescribePipeResult withLogConfiguration(PipeLogConfiguration logConfiguration)
```
    The logging configuration settings for the pipe.
    
    Parameters:
    
    logConfiguration - The logging configuration settings for the pipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribePipeResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.772

Class DescribePipeResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribePipeResult

Method Detail

setArn

getArn

withArn

setName

getName

withName

setDescription

getDescription

withDescription

setDesiredState

getDesiredState

withDesiredState

withDesiredState

setCurrentState

getCurrentState

withCurrentState

withCurrentState

setStateReason

getStateReason

withStateReason

setSource

getSource

withSource

setSourceParameters

getSourceParameters

withSourceParameters

setEnrichment

getEnrichment

withEnrichment

setEnrichmentParameters

getEnrichmentParameters

withEnrichmentParameters

setTarget

getTarget

withTarget

setTargetParameters

getTargetParameters

withTargetParameters

setRoleArn

getRoleArn

withRoleArn

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setCreationTime

getCreationTime

withCreationTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setLogConfiguration

getLogConfiguration

withLogConfiguration

toString

equals

hashCode

clone