com.amazonaws.services.osis.model

Class CreatePipelineRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.osis.model.CreatePipelineRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePipelineRequest
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
CreatePipelineRequest()

Method Summary

Modifier and Type	Method and Description
CreatePipelineRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
BufferOptions	getBufferOptions() Key-value pairs to configure persistent buffering for the pipeline.
EncryptionAtRestOptions	getEncryptionAtRestOptions() Key-value pairs to configure encryption for data that is written to a persistent buffer.
LogPublishingOptions	getLogPublishingOptions() Key-value pairs to configure log publishing.
Integer	getMaxUnits() The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
Integer	getMinUnits() The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
String	getPipelineConfigurationBody() The pipeline configuration in YAML format.
String	getPipelineName() The name of the OpenSearch Ingestion pipeline to create.
List<Tag>	getTags() List of tags to add to the pipeline upon creation.
VpcOptions	getVpcOptions() Container for the values required to configure VPC access for the pipeline.
int	hashCode()
void	setBufferOptions(BufferOptions bufferOptions) Key-value pairs to configure persistent buffering for the pipeline.
void	setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) Key-value pairs to configure encryption for data that is written to a persistent buffer.
void	setLogPublishingOptions(LogPublishingOptions logPublishingOptions) Key-value pairs to configure log publishing.
void	setMaxUnits(Integer maxUnits) The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
void	setMinUnits(Integer minUnits) The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
void	setPipelineConfigurationBody(String pipelineConfigurationBody) The pipeline configuration in YAML format.
void	setPipelineName(String pipelineName) The name of the OpenSearch Ingestion pipeline to create.
void	setTags(Collection<Tag> tags) List of tags to add to the pipeline upon creation.
void	setVpcOptions(VpcOptions vpcOptions) Container for the values required to configure VPC access for the pipeline.
String	toString() Returns a string representation of this object.
CreatePipelineRequest	withBufferOptions(BufferOptions bufferOptions) Key-value pairs to configure persistent buffering for the pipeline.
CreatePipelineRequest	withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) Key-value pairs to configure encryption for data that is written to a persistent buffer.
CreatePipelineRequest	withLogPublishingOptions(LogPublishingOptions logPublishingOptions) Key-value pairs to configure log publishing.
CreatePipelineRequest	withMaxUnits(Integer maxUnits) The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
CreatePipelineRequest	withMinUnits(Integer minUnits) The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
CreatePipelineRequest	withPipelineConfigurationBody(String pipelineConfigurationBody) The pipeline configuration in YAML format.
CreatePipelineRequest	withPipelineName(String pipelineName) The name of the OpenSearch Ingestion pipeline to create.
CreatePipelineRequest	withTags(Collection<Tag> tags) List of tags to add to the pipeline upon creation.
CreatePipelineRequest	withTags(Tag... tags) List of tags to add to the pipeline upon creation.
CreatePipelineRequest	withVpcOptions(VpcOptions vpcOptions) Container for the values required to configure VPC access for the pipeline.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreatePipelineRequest

public CreatePipelineRequest()

Method Detail

setPipelineName

public void setPipelineName(String pipelineName)

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

Parameters:

pipelineName - The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

getPipelineName

public String getPipelineName()

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

Returns:

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

withPipelineName

public CreatePipelineRequest withPipelineName(String pipelineName)

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

Parameters:

pipelineName - The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMinUnits

public void setMinUnits(Integer minUnits)

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Parameters:

minUnits - The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

getMinUnits

public Integer getMinUnits()

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

withMinUnits

public CreatePipelineRequest withMinUnits(Integer minUnits)

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Parameters:

minUnits - The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxUnits

public void setMaxUnits(Integer maxUnits)

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Parameters:

maxUnits - The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

getMaxUnits

public Integer getMaxUnits()

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

withMaxUnits

public CreatePipelineRequest withMaxUnits(Integer maxUnits)

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Parameters:

maxUnits - The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

Returns a reference to this object so that method calls can be chained together.

setPipelineConfigurationBody

public void setPipelineConfigurationBody(String pipelineConfigurationBody)

The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

Parameters:

pipelineConfigurationBody - The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

getPipelineConfigurationBody

public String getPipelineConfigurationBody()

The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

Returns:

The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

withPipelineConfigurationBody

public CreatePipelineRequest withPipelineConfigurationBody(String pipelineConfigurationBody)

The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

Parameters:

pipelineConfigurationBody - The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLogPublishingOptions

public void setLogPublishingOptions(LogPublishingOptions logPublishingOptions)

Key-value pairs to configure log publishing.

Parameters:

logPublishingOptions - Key-value pairs to configure log publishing.

getLogPublishingOptions

public LogPublishingOptions getLogPublishingOptions()

Key-value pairs to configure log publishing.

Returns:

Key-value pairs to configure log publishing.

withLogPublishingOptions

public CreatePipelineRequest withLogPublishingOptions(LogPublishingOptions logPublishingOptions)

Key-value pairs to configure log publishing.

Parameters:

logPublishingOptions - Key-value pairs to configure log publishing.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcOptions

public void setVpcOptions(VpcOptions vpcOptions)

Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

Parameters:

vpcOptions - Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

getVpcOptions

public VpcOptions getVpcOptions()

Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

Returns:

Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

withVpcOptions

public CreatePipelineRequest withVpcOptions(VpcOptions vpcOptions)

Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

Parameters:

vpcOptions - Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBufferOptions

public void setBufferOptions(BufferOptions bufferOptions)

Key-value pairs to configure persistent buffering for the pipeline.

Parameters:

bufferOptions - Key-value pairs to configure persistent buffering for the pipeline.

getBufferOptions

public BufferOptions getBufferOptions()

Key-value pairs to configure persistent buffering for the pipeline.

Returns:

Key-value pairs to configure persistent buffering for the pipeline.

withBufferOptions

public CreatePipelineRequest withBufferOptions(BufferOptions bufferOptions)

Key-value pairs to configure persistent buffering for the pipeline.

Parameters:

bufferOptions - Key-value pairs to configure persistent buffering for the pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncryptionAtRestOptions

public void setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)

Key-value pairs to configure encryption for data that is written to a persistent buffer.

Parameters:

encryptionAtRestOptions - Key-value pairs to configure encryption for data that is written to a persistent buffer.

getEncryptionAtRestOptions

public EncryptionAtRestOptions getEncryptionAtRestOptions()

Key-value pairs to configure encryption for data that is written to a persistent buffer.

Returns:

Key-value pairs to configure encryption for data that is written to a persistent buffer.

withEncryptionAtRestOptions

public CreatePipelineRequest withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)

Key-value pairs to configure encryption for data that is written to a persistent buffer.

Parameters:

encryptionAtRestOptions - Key-value pairs to configure encryption for data that is written to a persistent buffer.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

List of tags to add to the pipeline upon creation.

Returns:

List of tags to add to the pipeline upon creation.

setTags

public void setTags(Collection<Tag> tags)

List of tags to add to the pipeline upon creation.

Parameters:

tags - List of tags to add to the pipeline upon creation.

withTags

public CreatePipelineRequest withTags(Tag... tags)

List of tags to add to the pipeline upon creation.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - List of tags to add to the pipeline upon creation.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreatePipelineRequest withTags(Collection<Tag> tags)

List of tags to add to the pipeline upon creation.

Parameters:

tags - List of tags to add to the pipeline upon creation.

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 CreatePipelineRequest 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()