com.amazonaws.services.simpleemail.model.AddHeaderAction Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ses 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.simpleemail.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* When included in a receipt rule, this action adds a header to the received email.
*
*
* For information about adding a header using a receipt rule, see the Amazon SES Developer
* Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AddHeaderAction implements Serializable, Cloneable {
/**
*
* The name of the header to add to the incoming message. The name must contain at least one character, and can
* contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
*
*/
private String headerName;
/**
*
* The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (
* \n) or carriage return (\r) characters.
*
*/
private String headerValue;
/**
*
* The name of the header to add to the incoming message. The name must contain at least one character, and can
* contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
*
*
* @param headerName
* The name of the header to add to the incoming message. The name must contain at least one character, and
* can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
*/
public void setHeaderName(String headerName) {
this.headerName = headerName;
}
/**
*
* The name of the header to add to the incoming message. The name must contain at least one character, and can
* contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
*
*
* @return The name of the header to add to the incoming message. The name must contain at least one character, and
* can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
*/
public String getHeaderName() {
return this.headerName;
}
/**
*
* The name of the header to add to the incoming message. The name must contain at least one character, and can
* contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
*
*
* @param headerName
* The name of the header to add to the incoming message. The name must contain at least one character, and
* can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AddHeaderAction withHeaderName(String headerName) {
setHeaderName(headerName);
return this;
}
/**
*
* The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (
* \n) or carriage return (\r) characters.
*
*
* @param headerValue
* The content to include in the header. This value can contain up to 2048 characters. It can't contain
* newline (\n) or carriage return (\r) characters.
*/
public void setHeaderValue(String headerValue) {
this.headerValue = headerValue;
}
/**
*
* The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (
* \n) or carriage return (\r) characters.
*
*
* @return The content to include in the header. This value can contain up to 2048 characters. It can't contain
* newline (\n) or carriage return (\r) characters.
*/
public String getHeaderValue() {
return this.headerValue;
}
/**
*
* The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (
* \n) or carriage return (\r) characters.
*
*
* @param headerValue
* The content to include in the header. This value can contain up to 2048 characters. It can't contain
* newline (\n) or carriage return (\r) characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AddHeaderAction withHeaderValue(String headerValue) {
setHeaderValue(headerValue);
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 (getHeaderName() != null)
sb.append("HeaderName: ").append(getHeaderName()).append(",");
if (getHeaderValue() != null)
sb.append("HeaderValue: ").append(getHeaderValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AddHeaderAction == false)
return false;
AddHeaderAction other = (AddHeaderAction) obj;
if (other.getHeaderName() == null ^ this.getHeaderName() == null)
return false;
if (other.getHeaderName() != null && other.getHeaderName().equals(this.getHeaderName()) == false)
return false;
if (other.getHeaderValue() == null ^ this.getHeaderValue() == null)
return false;
if (other.getHeaderValue() != null && other.getHeaderValue().equals(this.getHeaderValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getHeaderName() == null) ? 0 : getHeaderName().hashCode());
hashCode = prime * hashCode + ((getHeaderValue() == null) ? 0 : getHeaderValue().hashCode());
return hashCode;
}
@Override
public AddHeaderAction clone() {
try {
return (AddHeaderAction) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}