Pipeline (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.osis.model.Pipeline

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Pipeline
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about an existing OpenSearch Ingestion pipeline.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Pipeline()

Constructors
Constructor and Description
`Pipeline()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Pipeline`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedAt()` The date and time when the pipeline was created.
`List<String>`	`getIngestEndpointUrls()` The ingestion endpoints for the pipeline, which you can send data to.
`Date`	`getLastUpdatedAt()` The date and time when the pipeline was last updated.
`LogPublishingOptions`	`getLogPublishingOptions()` Key-value pairs that represent log publishing settings.
`Integer`	`getMaxUnits()` The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
`Integer`	`getMinUnits()` The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
`String`	`getPipelineArn()` The Amazon Resource Name (ARN) of the pipeline.
`String`	`getPipelineConfigurationBody()` The Data Prepper pipeline configuration in YAML format.
`String`	`getPipelineName()` The name of the pipeline.
`String`	`getStatus()` The current status of the pipeline.
`PipelineStatusReason`	`getStatusReason()` The reason for the current status of the pipeline.
`List<VpcEndpoint>`	`getVpcEndpoints()` The VPC interface endpoints that have access to the pipeline.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreatedAt(Date createdAt)` The date and time when the pipeline was created.
`void`	`setIngestEndpointUrls(Collection<String> ingestEndpointUrls)` The ingestion endpoints for the pipeline, which you can send data to.
`void`	`setLastUpdatedAt(Date lastUpdatedAt)` The date and time when the pipeline was last updated.
`void`	`setLogPublishingOptions(LogPublishingOptions logPublishingOptions)` Key-value pairs that represent log publishing settings.
`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`	`setPipelineArn(String pipelineArn)` The Amazon Resource Name (ARN) of the pipeline.
`void`	`setPipelineConfigurationBody(String pipelineConfigurationBody)` The Data Prepper pipeline configuration in YAML format.
`void`	`setPipelineName(String pipelineName)` The name of the pipeline.
`void`	`setStatus(String status)` The current status of the pipeline.
`void`	`setStatusReason(PipelineStatusReason statusReason)` The reason for the current status of the pipeline.
`void`	`setVpcEndpoints(Collection<VpcEndpoint> vpcEndpoints)` The VPC interface endpoints that have access to the pipeline.
`String`	`toString()` Returns a string representation of this object.
`Pipeline`	`withCreatedAt(Date createdAt)` The date and time when the pipeline was created.
`Pipeline`	`withIngestEndpointUrls(Collection<String> ingestEndpointUrls)` The ingestion endpoints for the pipeline, which you can send data to.
`Pipeline`	`withIngestEndpointUrls(String... ingestEndpointUrls)` The ingestion endpoints for the pipeline, which you can send data to.
`Pipeline`	`withLastUpdatedAt(Date lastUpdatedAt)` The date and time when the pipeline was last updated.
`Pipeline`	`withLogPublishingOptions(LogPublishingOptions logPublishingOptions)` Key-value pairs that represent log publishing settings.
`Pipeline`	`withMaxUnits(Integer maxUnits)` The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
`Pipeline`	`withMinUnits(Integer minUnits)` The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
`Pipeline`	`withPipelineArn(String pipelineArn)` The Amazon Resource Name (ARN) of the pipeline.
`Pipeline`	`withPipelineConfigurationBody(String pipelineConfigurationBody)` The Data Prepper pipeline configuration in YAML format.
`Pipeline`	`withPipelineName(String pipelineName)` The name of the pipeline.
`Pipeline`	`withStatus(PipelineStatus status)` The current status of the pipeline.
`Pipeline`	`withStatus(String status)` The current status of the pipeline.
`Pipeline`	`withStatusReason(PipelineStatusReason statusReason)` The reason for the current status of the pipeline.
`Pipeline`	`withVpcEndpoints(Collection<VpcEndpoint> vpcEndpoints)` The VPC interface endpoints that have access to the pipeline.
`Pipeline`	`withVpcEndpoints(VpcEndpoint... vpcEndpoints)` The VPC interface endpoints that have access to the pipeline.

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

- Constructor Detail
  - Pipeline
```
public Pipeline()
```
- Method Detail
  - setPipelineName
```
public void setPipelineName(String pipelineName)
```
    The name of the pipeline.
    
    Parameters:
    
    pipelineName - The name of the pipeline.
  - getPipelineName
```
public String getPipelineName()
```
    The name of the pipeline.
    
    Returns:
    
    The name of the pipeline.
  - withPipelineName
```
public Pipeline withPipelineName(String pipelineName)
```
    The name of the pipeline.
    
    Parameters:
    
    pipelineName - The name of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineArn
```
public void setPipelineArn(String pipelineArn)
```
    The Amazon Resource Name (ARN) of the pipeline.
    
    Parameters:
    
    pipelineArn - The Amazon Resource Name (ARN) of the pipeline.
  - getPipelineArn
```
public String getPipelineArn()
```
    The Amazon Resource Name (ARN) of the pipeline.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the pipeline.
  - withPipelineArn
```
public Pipeline withPipelineArn(String pipelineArn)
```
    The Amazon Resource Name (ARN) of the pipeline.
    
    Parameters:
    
    pipelineArn - The Amazon Resource Name (ARN) of the pipeline.
    
    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 Pipeline 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 Pipeline 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.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the pipeline.
    
    Parameters:
    
    status - The current status of the pipeline.
    
    See Also:
    
    PipelineStatus
  - getStatus
```
public String getStatus()
```
    The current status of the pipeline.
    
    Returns:
    
    The current status of the pipeline.
    
    See Also:
    
    PipelineStatus
  - withStatus
```
public Pipeline withStatus(String status)
```
    The current status of the pipeline.
    
    Parameters:
    
    status - The current status of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipelineStatus
  - withStatus
```
public Pipeline withStatus(PipelineStatus status)
```
    The current status of the pipeline.
    
    Parameters:
    
    status - The current status of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipelineStatus
  - setStatusReason
```
public void setStatusReason(PipelineStatusReason statusReason)
```
    The reason for the current status of the pipeline.
    
    Parameters:
    
    statusReason - The reason for the current status of the pipeline.
  - getStatusReason
```
public PipelineStatusReason getStatusReason()
```
    The reason for the current status of the pipeline.
    
    Returns:
    
    The reason for the current status of the pipeline.
  - withStatusReason
```
public Pipeline withStatusReason(PipelineStatusReason statusReason)
```
    The reason for the current status of the pipeline.
    
    Parameters:
    
    statusReason - The reason for the current status of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineConfigurationBody
```
public void setPipelineConfigurationBody(String pipelineConfigurationBody)
```
    The Data Prepper pipeline configuration in YAML format.
    
    Parameters:
    
    pipelineConfigurationBody - The Data Prepper pipeline configuration in YAML format.
  - getPipelineConfigurationBody
```
public String getPipelineConfigurationBody()
```
    The Data Prepper pipeline configuration in YAML format.
    
    Returns:
    
    The Data Prepper pipeline configuration in YAML format.
  - withPipelineConfigurationBody
```
public Pipeline withPipelineConfigurationBody(String pipelineConfigurationBody)
```
    The Data Prepper pipeline configuration in YAML format.
    
    Parameters:
    
    pipelineConfigurationBody - The Data Prepper pipeline configuration in YAML format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date and time when the pipeline was created.
    
    Parameters:
    
    createdAt - The date and time when the pipeline was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The date and time when the pipeline was created.
    
    Returns:
    
    The date and time when the pipeline was created.
  - withCreatedAt
```
public Pipeline withCreatedAt(Date createdAt)
```
    The date and time when the pipeline was created.
    
    Parameters:
    
    createdAt - The date and time when the pipeline was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(Date lastUpdatedAt)
```
    The date and time when the pipeline was last updated.
    
    Parameters:
    
    lastUpdatedAt - The date and time when the pipeline was last updated.
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    The date and time when the pipeline was last updated.
    
    Returns:
    
    The date and time when the pipeline was last updated.
  - withLastUpdatedAt
```
public Pipeline withLastUpdatedAt(Date lastUpdatedAt)
```
    The date and time when the pipeline was last updated.
    
    Parameters:
    
    lastUpdatedAt - The date and time when the pipeline was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIngestEndpointUrls
```
public List<String> getIngestEndpointUrls()
```
    The ingestion endpoints for the pipeline, which you can send data to.
    
    Returns:
    
    The ingestion endpoints for the pipeline, which you can send data to.
  - setIngestEndpointUrls
```
public void setIngestEndpointUrls(Collection<String> ingestEndpointUrls)
```
    The ingestion endpoints for the pipeline, which you can send data to.
    
    Parameters:
    
    ingestEndpointUrls - The ingestion endpoints for the pipeline, which you can send data to.
  - withIngestEndpointUrls
```
public Pipeline withIngestEndpointUrls(String... ingestEndpointUrls)
```
    The ingestion endpoints for the pipeline, which you can send data to.
    
    NOTE: This method appends the values to the existing list (if any). Use setIngestEndpointUrls(java.util.Collection) or withIngestEndpointUrls(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ingestEndpointUrls - The ingestion endpoints for the pipeline, which you can send data to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIngestEndpointUrls
```
public Pipeline withIngestEndpointUrls(Collection<String> ingestEndpointUrls)
```
    The ingestion endpoints for the pipeline, which you can send data to.
    
    Parameters:
    
    ingestEndpointUrls - The ingestion endpoints for the pipeline, which you can send data to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogPublishingOptions
```
public void setLogPublishingOptions(LogPublishingOptions logPublishingOptions)
```
    Key-value pairs that represent log publishing settings.
    
    Parameters:
    
    logPublishingOptions - Key-value pairs that represent log publishing settings.
  - getLogPublishingOptions
```
public LogPublishingOptions getLogPublishingOptions()
```
    Key-value pairs that represent log publishing settings.
    
    Returns:
    
    Key-value pairs that represent log publishing settings.
  - withLogPublishingOptions
```
public Pipeline withLogPublishingOptions(LogPublishingOptions logPublishingOptions)
```
    Key-value pairs that represent log publishing settings.
    
    Parameters:
    
    logPublishingOptions - Key-value pairs that represent log publishing settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcEndpoints
```
public List<VpcEndpoint> getVpcEndpoints()
```
    The VPC interface endpoints that have access to the pipeline.
    
    Returns:
    
    The VPC interface endpoints that have access to the pipeline.
  - setVpcEndpoints
```
public void setVpcEndpoints(Collection<VpcEndpoint> vpcEndpoints)
```
    The VPC interface endpoints that have access to the pipeline.
    
    Parameters:
    
    vpcEndpoints - The VPC interface endpoints that have access to the pipeline.
  - withVpcEndpoints
```
public Pipeline withVpcEndpoints(VpcEndpoint... vpcEndpoints)
```
    The VPC interface endpoints that have access to the pipeline.
    
    NOTE: This method appends the values to the existing list (if any). Use setVpcEndpoints(java.util.Collection) or withVpcEndpoints(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    vpcEndpoints - The VPC interface endpoints that have access to the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVpcEndpoints
```
public Pipeline withVpcEndpoints(Collection<VpcEndpoint> vpcEndpoints)
```
    The VPC interface endpoints that have access to the pipeline.
    
    Parameters:
    
    vpcEndpoints - The VPC interface endpoints that have access to the pipeline.
    
    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 Pipeline clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.531

Class Pipeline

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Pipeline

Method Detail

setPipelineName

getPipelineName

withPipelineName

setPipelineArn

getPipelineArn

withPipelineArn

setMinUnits

getMinUnits

withMinUnits

setMaxUnits

getMaxUnits

withMaxUnits

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setPipelineConfigurationBody

getPipelineConfigurationBody

withPipelineConfigurationBody

setCreatedAt

getCreatedAt

withCreatedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

getIngestEndpointUrls

setIngestEndpointUrls

withIngestEndpointUrls

withIngestEndpointUrls

setLogPublishingOptions

getLogPublishingOptions

withLogPublishingOptions

getVpcEndpoints

setVpcEndpoints

withVpcEndpoints

withVpcEndpoints

toString

equals

hashCode

clone

marshall