com.amazonaws.services.osis.model.CreatePipelineRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osis Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.osis.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreatePipelineRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String pipelineName;
/**
*
* The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
*
*/
private Integer minUnits;
/**
*
* The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
*
*/
private Integer maxUnits;
/**
*
* 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.
*
*/
private String pipelineConfigurationBody;
/**
*
* Key-value pairs to configure log publishing.
*
*/
private LogPublishingOptions logPublishingOptions;
/**
*
* 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.
*
*/
private VpcOptions vpcOptions;
/**
*
* Key-value pairs to configure persistent buffering for the pipeline.
*
*/
private BufferOptions bufferOptions;
/**
*
* Key-value pairs to configure encryption for data that is written to a persistent buffer.
*
*/
private EncryptionAtRestOptions encryptionAtRestOptions;
/**
*
* List of tags to add to the pipeline upon creation.
*
*/
private java.util.List tags;
/**
*
* 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.
*
*
* @param 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.
*/
public void setPipelineName(String pipelineName) {
this.pipelineName = 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.
*
*
* @return 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.
*/
public String getPipelineName() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withPipelineName(String pipelineName) {
setPipelineName(pipelineName);
return this;
}
/**
*
* The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
*
*
* @param minUnits
* The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
*/
public void setMinUnits(Integer minUnits) {
this.minUnits = minUnits;
}
/**
*
* The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
*
*
* @return The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
*/
public Integer getMinUnits() {
return this.minUnits;
}
/**
*
* The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
*
*
* @param minUnits
* The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withMinUnits(Integer minUnits) {
setMinUnits(minUnits);
return this;
}
/**
*
* The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
*
*
* @param maxUnits
* The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
*/
public void setMaxUnits(Integer maxUnits) {
this.maxUnits = maxUnits;
}
/**
*
* The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
*
*
* @return The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
*/
public Integer getMaxUnits() {
return this.maxUnits;
}
/**
*
* The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
*
*
* @param maxUnits
* The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withMaxUnits(Integer maxUnits) {
setMaxUnits(maxUnits);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPipelineConfigurationBody(String pipelineConfigurationBody) {
this.pipelineConfigurationBody = 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.
*
*
* @return 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.
*/
public String getPipelineConfigurationBody() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withPipelineConfigurationBody(String pipelineConfigurationBody) {
setPipelineConfigurationBody(pipelineConfigurationBody);
return this;
}
/**
*
* Key-value pairs to configure log publishing.
*
*
* @param logPublishingOptions
* Key-value pairs to configure log publishing.
*/
public void setLogPublishingOptions(LogPublishingOptions logPublishingOptions) {
this.logPublishingOptions = logPublishingOptions;
}
/**
*
* Key-value pairs to configure log publishing.
*
*
* @return Key-value pairs to configure log publishing.
*/
public LogPublishingOptions getLogPublishingOptions() {
return this.logPublishingOptions;
}
/**
*
* Key-value pairs to configure log publishing.
*
*
* @param logPublishingOptions
* Key-value pairs to configure log publishing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withLogPublishingOptions(LogPublishingOptions logPublishingOptions) {
setLogPublishingOptions(logPublishingOptions);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setVpcOptions(VpcOptions vpcOptions) {
this.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.
*
*
* @return 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.
*/
public VpcOptions getVpcOptions() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withVpcOptions(VpcOptions vpcOptions) {
setVpcOptions(vpcOptions);
return this;
}
/**
*
* Key-value pairs to configure persistent buffering for the pipeline.
*
*
* @param bufferOptions
* Key-value pairs to configure persistent buffering for the pipeline.
*/
public void setBufferOptions(BufferOptions bufferOptions) {
this.bufferOptions = bufferOptions;
}
/**
*
* Key-value pairs to configure persistent buffering for the pipeline.
*
*
* @return Key-value pairs to configure persistent buffering for the pipeline.
*/
public BufferOptions getBufferOptions() {
return this.bufferOptions;
}
/**
*
* Key-value pairs to configure persistent buffering for the pipeline.
*
*
* @param bufferOptions
* Key-value pairs to configure persistent buffering for the pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withBufferOptions(BufferOptions bufferOptions) {
setBufferOptions(bufferOptions);
return this;
}
/**
*
* Key-value pairs to configure encryption for data that is written to a persistent buffer.
*
*
* @param encryptionAtRestOptions
* Key-value pairs to configure encryption for data that is written to a persistent buffer.
*/
public void setEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) {
this.encryptionAtRestOptions = encryptionAtRestOptions;
}
/**
*
* Key-value pairs to configure encryption for data that is written to a persistent buffer.
*
*
* @return Key-value pairs to configure encryption for data that is written to a persistent buffer.
*/
public EncryptionAtRestOptions getEncryptionAtRestOptions() {
return this.encryptionAtRestOptions;
}
/**
*
* Key-value pairs to configure encryption for data that is written to a persistent buffer.
*
*
* @param encryptionAtRestOptions
* Key-value pairs to configure encryption for data that is written to a persistent buffer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withEncryptionAtRestOptions(EncryptionAtRestOptions encryptionAtRestOptions) {
setEncryptionAtRestOptions(encryptionAtRestOptions);
return this;
}
/**
*
* List of tags to add to the pipeline upon creation.
*
*
* @return List of tags to add to the pipeline upon creation.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* List of tags to add to the pipeline upon creation.
*
*
* @param tags
* List of tags to add to the pipeline upon creation.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* List of tags to add to the pipeline upon creation.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* List of tags to add to the pipeline upon creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* List of tags to add to the pipeline upon creation.
*
*
* @param tags
* List of tags to add to the pipeline upon creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePipelineRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPipelineName() != null)
sb.append("PipelineName: ").append(getPipelineName()).append(",");
if (getMinUnits() != null)
sb.append("MinUnits: ").append(getMinUnits()).append(",");
if (getMaxUnits() != null)
sb.append("MaxUnits: ").append(getMaxUnits()).append(",");
if (getPipelineConfigurationBody() != null)
sb.append("PipelineConfigurationBody: ").append(getPipelineConfigurationBody()).append(",");
if (getLogPublishingOptions() != null)
sb.append("LogPublishingOptions: ").append(getLogPublishingOptions()).append(",");
if (getVpcOptions() != null)
sb.append("VpcOptions: ").append(getVpcOptions()).append(",");
if (getBufferOptions() != null)
sb.append("BufferOptions: ").append(getBufferOptions()).append(",");
if (getEncryptionAtRestOptions() != null)
sb.append("EncryptionAtRestOptions: ").append(getEncryptionAtRestOptions()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreatePipelineRequest == false)
return false;
CreatePipelineRequest other = (CreatePipelineRequest) obj;
if (other.getPipelineName() == null ^ this.getPipelineName() == null)
return false;
if (other.getPipelineName() != null && other.getPipelineName().equals(this.getPipelineName()) == false)
return false;
if (other.getMinUnits() == null ^ this.getMinUnits() == null)
return false;
if (other.getMinUnits() != null && other.getMinUnits().equals(this.getMinUnits()) == false)
return false;
if (other.getMaxUnits() == null ^ this.getMaxUnits() == null)
return false;
if (other.getMaxUnits() != null && other.getMaxUnits().equals(this.getMaxUnits()) == false)
return false;
if (other.getPipelineConfigurationBody() == null ^ this.getPipelineConfigurationBody() == null)
return false;
if (other.getPipelineConfigurationBody() != null && other.getPipelineConfigurationBody().equals(this.getPipelineConfigurationBody()) == false)
return false;
if (other.getLogPublishingOptions() == null ^ this.getLogPublishingOptions() == null)
return false;
if (other.getLogPublishingOptions() != null && other.getLogPublishingOptions().equals(this.getLogPublishingOptions()) == false)
return false;
if (other.getVpcOptions() == null ^ this.getVpcOptions() == null)
return false;
if (other.getVpcOptions() != null && other.getVpcOptions().equals(this.getVpcOptions()) == false)
return false;
if (other.getBufferOptions() == null ^ this.getBufferOptions() == null)
return false;
if (other.getBufferOptions() != null && other.getBufferOptions().equals(this.getBufferOptions()) == false)
return false;
if (other.getEncryptionAtRestOptions() == null ^ this.getEncryptionAtRestOptions() == null)
return false;
if (other.getEncryptionAtRestOptions() != null && other.getEncryptionAtRestOptions().equals(this.getEncryptionAtRestOptions()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPipelineName() == null) ? 0 : getPipelineName().hashCode());
hashCode = prime * hashCode + ((getMinUnits() == null) ? 0 : getMinUnits().hashCode());
hashCode = prime * hashCode + ((getMaxUnits() == null) ? 0 : getMaxUnits().hashCode());
hashCode = prime * hashCode + ((getPipelineConfigurationBody() == null) ? 0 : getPipelineConfigurationBody().hashCode());
hashCode = prime * hashCode + ((getLogPublishingOptions() == null) ? 0 : getLogPublishingOptions().hashCode());
hashCode = prime * hashCode + ((getVpcOptions() == null) ? 0 : getVpcOptions().hashCode());
hashCode = prime * hashCode + ((getBufferOptions() == null) ? 0 : getBufferOptions().hashCode());
hashCode = prime * hashCode + ((getEncryptionAtRestOptions() == null) ? 0 : getEncryptionAtRestOptions().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreatePipelineRequest clone() {
return (CreatePipelineRequest) super.clone();
}
}