@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.
Constructor and Description |
---|
Pipeline() |
Modifier and Type | Method and Description |
---|---|
Pipeline |
clone() |
boolean |
equals(Object obj) |
BufferOptions |
getBufferOptions() |
Date |
getCreatedAt()
The date and time when the pipeline was created.
|
List<PipelineDestination> |
getDestinations()
Destinations to which the pipeline writes data.
|
EncryptionAtRestOptions |
getEncryptionAtRestOptions() |
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.
|
List<ServiceVpcEndpoint> |
getServiceVpcEndpoints()
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
|
String |
getStatus()
The current status of the pipeline.
|
PipelineStatusReason |
getStatusReason()
The reason for the current status of the pipeline.
|
List<Tag> |
getTags()
A list of tags associated with the given pipeline.
|
List<VpcEndpoint> |
getVpcEndpoints()
The VPC interface endpoints that have access to the pipeline.
|
String |
getVpcEndpointService()
The VPC endpoint service name for the pipeline.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBufferOptions(BufferOptions bufferOptions) |
void |
setCreatedAt(Date createdAt)
The date and time when the pipeline was created.
|
void |
setDestinations(Collection<PipelineDestination> destinations)
Destinations to which the pipeline writes data.
|
void |
setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) |
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 |
setServiceVpcEndpoints(Collection<ServiceVpcEndpoint> serviceVpcEndpoints)
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
|
void |
setStatus(String status)
The current status of the pipeline.
|
void |
setStatusReason(PipelineStatusReason statusReason)
The reason for the current status of the pipeline.
|
void |
setTags(Collection<Tag> tags)
A list of tags associated with the given pipeline.
|
void |
setVpcEndpoints(Collection<VpcEndpoint> vpcEndpoints)
The VPC interface endpoints that have access to the pipeline.
|
void |
setVpcEndpointService(String vpcEndpointService)
The VPC endpoint service name for the pipeline.
|
String |
toString()
Returns a string representation of this object.
|
Pipeline |
withBufferOptions(BufferOptions bufferOptions) |
Pipeline |
withCreatedAt(Date createdAt)
The date and time when the pipeline was created.
|
Pipeline |
withDestinations(Collection<PipelineDestination> destinations)
Destinations to which the pipeline writes data.
|
Pipeline |
withDestinations(PipelineDestination... destinations)
Destinations to which the pipeline writes data.
|
Pipeline |
withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) |
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 |
withServiceVpcEndpoints(Collection<ServiceVpcEndpoint> serviceVpcEndpoints)
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
|
Pipeline |
withServiceVpcEndpoints(ServiceVpcEndpoint... serviceVpcEndpoints)
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
|
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 |
withTags(Collection<Tag> tags)
A list of tags associated with the given pipeline.
|
Pipeline |
withTags(Tag... tags)
A list of tags associated with the given 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.
|
Pipeline |
withVpcEndpointService(String vpcEndpointService)
The VPC endpoint service name for the pipeline.
|
public void setPipelineName(String pipelineName)
The name of the pipeline.
pipelineName
- The name of the pipeline.public String getPipelineName()
The name of the pipeline.
public Pipeline withPipelineName(String pipelineName)
The name of the pipeline.
pipelineName
- The name of the pipeline.public void setPipelineArn(String pipelineArn)
The Amazon Resource Name (ARN) of the pipeline.
pipelineArn
- The Amazon Resource Name (ARN) of the pipeline.public String getPipelineArn()
The Amazon Resource Name (ARN) of the pipeline.
public Pipeline withPipelineArn(String pipelineArn)
The Amazon Resource Name (ARN) of the pipeline.
pipelineArn
- The Amazon Resource Name (ARN) of the pipeline.public void setMinUnits(Integer minUnits)
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
minUnits
- The minimum pipeline capacity, in Ingestion Compute Units (ICUs).public Integer getMinUnits()
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
public Pipeline withMinUnits(Integer minUnits)
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
minUnits
- The minimum pipeline capacity, in Ingestion Compute Units (ICUs).public void setMaxUnits(Integer maxUnits)
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
maxUnits
- The maximum pipeline capacity, in Ingestion Compute Units (ICUs).public Integer getMaxUnits()
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
public Pipeline withMaxUnits(Integer maxUnits)
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
maxUnits
- The maximum pipeline capacity, in Ingestion Compute Units (ICUs).public void setStatus(String status)
The current status of the pipeline.
status
- The current status of the pipeline.PipelineStatus
public String getStatus()
The current status of the pipeline.
PipelineStatus
public Pipeline withStatus(String status)
The current status of the pipeline.
status
- The current status of the pipeline.PipelineStatus
public Pipeline withStatus(PipelineStatus status)
The current status of the pipeline.
status
- The current status of the pipeline.PipelineStatus
public void setStatusReason(PipelineStatusReason statusReason)
The reason for the current status of the pipeline.
statusReason
- The reason for the current status of the pipeline.public PipelineStatusReason getStatusReason()
The reason for the current status of the pipeline.
public Pipeline withStatusReason(PipelineStatusReason statusReason)
The reason for the current status of the pipeline.
statusReason
- The reason for the current status of the pipeline.public void setPipelineConfigurationBody(String pipelineConfigurationBody)
The Data Prepper pipeline configuration in YAML format.
pipelineConfigurationBody
- The Data Prepper pipeline configuration in YAML format.public String getPipelineConfigurationBody()
The Data Prepper pipeline configuration in YAML format.
public Pipeline withPipelineConfigurationBody(String pipelineConfigurationBody)
The Data Prepper pipeline configuration in YAML format.
pipelineConfigurationBody
- The Data Prepper pipeline configuration in YAML format.public void setCreatedAt(Date createdAt)
The date and time when the pipeline was created.
createdAt
- The date and time when the pipeline was created.public Date getCreatedAt()
The date and time when the pipeline was created.
public Pipeline withCreatedAt(Date createdAt)
The date and time when the pipeline was created.
createdAt
- The date and time when the pipeline was created.public void setLastUpdatedAt(Date lastUpdatedAt)
The date and time when the pipeline was last updated.
lastUpdatedAt
- The date and time when the pipeline was last updated.public Date getLastUpdatedAt()
The date and time when the pipeline was last updated.
public Pipeline withLastUpdatedAt(Date lastUpdatedAt)
The date and time when the pipeline was last updated.
lastUpdatedAt
- The date and time when the pipeline was last updated.public List<String> getIngestEndpointUrls()
The ingestion endpoints for the pipeline, which you can send data to.
public void setIngestEndpointUrls(Collection<String> ingestEndpointUrls)
The ingestion endpoints for the pipeline, which you can send data to.
ingestEndpointUrls
- The ingestion endpoints for the pipeline, which you can send data to.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.
ingestEndpointUrls
- The ingestion endpoints for the pipeline, which you can send data to.public Pipeline withIngestEndpointUrls(Collection<String> ingestEndpointUrls)
The ingestion endpoints for the pipeline, which you can send data to.
ingestEndpointUrls
- The ingestion endpoints for the pipeline, which you can send data to.public void setLogPublishingOptions(LogPublishingOptions logPublishingOptions)
Key-value pairs that represent log publishing settings.
logPublishingOptions
- Key-value pairs that represent log publishing settings.public LogPublishingOptions getLogPublishingOptions()
Key-value pairs that represent log publishing settings.
public Pipeline withLogPublishingOptions(LogPublishingOptions logPublishingOptions)
Key-value pairs that represent log publishing settings.
logPublishingOptions
- Key-value pairs that represent log publishing settings.public List<VpcEndpoint> getVpcEndpoints()
The VPC interface endpoints that have access to the pipeline.
public void setVpcEndpoints(Collection<VpcEndpoint> vpcEndpoints)
The VPC interface endpoints that have access to the pipeline.
vpcEndpoints
- The VPC interface endpoints that have access to the pipeline.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.
vpcEndpoints
- The VPC interface endpoints that have access to the pipeline.public Pipeline withVpcEndpoints(Collection<VpcEndpoint> vpcEndpoints)
The VPC interface endpoints that have access to the pipeline.
vpcEndpoints
- The VPC interface endpoints that have access to the pipeline.public void setBufferOptions(BufferOptions bufferOptions)
bufferOptions
- public BufferOptions getBufferOptions()
public Pipeline withBufferOptions(BufferOptions bufferOptions)
bufferOptions
- public void setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)
encryptionAtRestOptions
- public EncryptionAtRestOptions getEncryptionAtRestOptions()
public Pipeline withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions)
encryptionAtRestOptions
- public void setVpcEndpointService(String vpcEndpointService)
The VPC endpoint service name for the pipeline.
vpcEndpointService
- The VPC endpoint service name for the pipeline.public String getVpcEndpointService()
The VPC endpoint service name for the pipeline.
public Pipeline withVpcEndpointService(String vpcEndpointService)
The VPC endpoint service name for the pipeline.
vpcEndpointService
- The VPC endpoint service name for the pipeline.public List<ServiceVpcEndpoint> getServiceVpcEndpoints()
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
public void setServiceVpcEndpoints(Collection<ServiceVpcEndpoint> serviceVpcEndpoints)
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
serviceVpcEndpoints
- A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.public Pipeline withServiceVpcEndpoints(ServiceVpcEndpoint... serviceVpcEndpoints)
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
NOTE: This method appends the values to the existing list (if any). Use
setServiceVpcEndpoints(java.util.Collection)
or withServiceVpcEndpoints(java.util.Collection)
if you want to override the existing values.
serviceVpcEndpoints
- A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.public Pipeline withServiceVpcEndpoints(Collection<ServiceVpcEndpoint> serviceVpcEndpoints)
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
serviceVpcEndpoints
- A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.public List<PipelineDestination> getDestinations()
Destinations to which the pipeline writes data.
public void setDestinations(Collection<PipelineDestination> destinations)
Destinations to which the pipeline writes data.
destinations
- Destinations to which the pipeline writes data.public Pipeline withDestinations(PipelineDestination... destinations)
Destinations to which the pipeline writes data.
NOTE: This method appends the values to the existing list (if any). Use
setDestinations(java.util.Collection)
or withDestinations(java.util.Collection)
if you want to
override the existing values.
destinations
- Destinations to which the pipeline writes data.public Pipeline withDestinations(Collection<PipelineDestination> destinations)
Destinations to which the pipeline writes data.
destinations
- Destinations to which the pipeline writes data.public List<Tag> getTags()
A list of tags associated with the given pipeline.
public void setTags(Collection<Tag> tags)
A list of tags associated with the given pipeline.
tags
- A list of tags associated with the given pipeline.public Pipeline withTags(Tag... tags)
A list of tags associated with the given pipeline.
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.
tags
- A list of tags associated with the given pipeline.public Pipeline withTags(Collection<Tag> tags)
A list of tags associated with the given pipeline.
tags
- A list of tags associated with the given pipeline.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.