CreatePipeRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.pipes.model.CreatePipeRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePipeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreatePipeRequest()

Constructors
Constructor and Description
`CreatePipeRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreatePipeRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreatePipeRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreatePipeRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`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.
`PipeLogConfigurationParameters`	`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.
`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`	`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`	`setLogConfiguration(PipeLogConfigurationParameters 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`	`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.
`CreatePipeRequest`	`withDescription(String description)` A description of the pipe.
`CreatePipeRequest`	`withDesiredState(RequestedPipeState desiredState)` The state the pipe should be in.
`CreatePipeRequest`	`withDesiredState(String desiredState)` The state the pipe should be in.
`CreatePipeRequest`	`withEnrichment(String enrichment)` The ARN of the enrichment resource.
`CreatePipeRequest`	`withEnrichmentParameters(PipeEnrichmentParameters enrichmentParameters)` The parameters required to set up enrichment on your pipe.
`CreatePipeRequest`	`withLogConfiguration(PipeLogConfigurationParameters logConfiguration)` The logging configuration settings for the pipe.
`CreatePipeRequest`	`withName(String name)` The name of the pipe.
`CreatePipeRequest`	`withRoleArn(String roleArn)` The ARN of the role that allows the pipe to send data to the target.
`CreatePipeRequest`	`withSource(String source)` The ARN of the source resource.
`CreatePipeRequest`	`withSourceParameters(PipeSourceParameters sourceParameters)` The parameters required to set up a source for your pipe.
`CreatePipeRequest`	`withTags(Map<String,String> tags)` The list of key-value pairs to associate with the pipe.
`CreatePipeRequest`	`withTarget(String target)` The ARN of the target resource.
`CreatePipeRequest`	`withTargetParameters(PipeTargetParameters targetParameters)` The parameters required to set up a target for your pipe.

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

- Constructor Detail
  - CreatePipeRequest
```
public CreatePipeRequest()
```
- Method Detail
  - 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 CreatePipeRequest 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 CreatePipeRequest 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:
    
    RequestedPipeState
  - getDesiredState
```
public String getDesiredState()
```
    The state the pipe should be in.
    
    Returns:
    
    The state the pipe should be in.
    
    See Also:
    
    RequestedPipeState
  - withDesiredState
```
public CreatePipeRequest 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:
    
    RequestedPipeState
  - withDesiredState
```
public CreatePipeRequest withDesiredState(RequestedPipeState 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:
    
    RequestedPipeState
  - 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 CreatePipeRequest 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 CreatePipeRequest 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 CreatePipeRequest 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 CreatePipeRequest 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 CreatePipeRequest 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 CreatePipeRequest 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 CreatePipeRequest 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 CreatePipeRequest 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 CreatePipeRequest addTagsEntry(String key,
                                      String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreatePipeRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogConfiguration
```
public void setLogConfiguration(PipeLogConfigurationParameters logConfiguration)
```
    The logging configuration settings for the pipe.
    
    Parameters:
    
    logConfiguration - The logging configuration settings for the pipe.
  - getLogConfiguration
```
public PipeLogConfigurationParameters getLogConfiguration()
```
    The logging configuration settings for the pipe.
    
    Returns:
    
    The logging configuration settings for the pipe.
  - withLogConfiguration
```
public CreatePipeRequest withLogConfiguration(PipeLogConfigurationParameters 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 CreatePipeRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.779

Class CreatePipeRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreatePipeRequest

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setDesiredState

getDesiredState

withDesiredState

withDesiredState

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

setLogConfiguration

getLogConfiguration

withLogConfiguration

toString

equals

hashCode

clone