com.amazonaws.services.simpleemail.model.PutIdentityPolicyRequest 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an
* Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutIdentityPolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identity to which that the policy applies. You can specify an identity by using its name or by using its
* Amazon Resource Name (ARN). Examples: [email protected], example.com,
* arn:aws:ses:us-east-1:123456789012:identity/example.com.
*
*
* To successfully call this operation, you must own the identity.
*
*/
private String identity;
/**
*
* The name of the policy.
*
*
* The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and
* underscores.
*
*/
private String policyName;
/**
*
* The text of the policy in JSON format. The policy cannot exceed 4 KB.
*
*
* For information about the syntax of sending authorization policies, see the Amazon SES Developer
* Guide.
*
*/
private String policy;
/**
*
* The identity to which that the policy applies. You can specify an identity by using its name or by using its
* Amazon Resource Name (ARN). Examples: [email protected], example.com,
* arn:aws:ses:us-east-1:123456789012:identity/example.com.
*
*
* To successfully call this operation, you must own the identity.
*
*
* @param identity
* The identity to which that the policy applies. You can specify an identity by using its name or by using
* its Amazon Resource Name (ARN). Examples: [email protected], example.com,
* arn:aws:ses:us-east-1:123456789012:identity/example.com.
*
* To successfully call this operation, you must own the identity.
*/
public void setIdentity(String identity) {
this.identity = identity;
}
/**
*
* The identity to which that the policy applies. You can specify an identity by using its name or by using its
* Amazon Resource Name (ARN). Examples: [email protected], example.com,
* arn:aws:ses:us-east-1:123456789012:identity/example.com.
*
*
* To successfully call this operation, you must own the identity.
*
*
* @return The identity to which that the policy applies. You can specify an identity by using its name or by using
* its Amazon Resource Name (ARN). Examples: [email protected], example.com,
* arn:aws:ses:us-east-1:123456789012:identity/example.com.
*
* To successfully call this operation, you must own the identity.
*/
public String getIdentity() {
return this.identity;
}
/**
*
* The identity to which that the policy applies. You can specify an identity by using its name or by using its
* Amazon Resource Name (ARN). Examples: [email protected], example.com,
* arn:aws:ses:us-east-1:123456789012:identity/example.com.
*
*
* To successfully call this operation, you must own the identity.
*
*
* @param identity
* The identity to which that the policy applies. You can specify an identity by using its name or by using
* its Amazon Resource Name (ARN). Examples: [email protected], example.com,
* arn:aws:ses:us-east-1:123456789012:identity/example.com.
*
* To successfully call this operation, you must own the identity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIdentityPolicyRequest withIdentity(String identity) {
setIdentity(identity);
return this;
}
/**
*
* The name of the policy.
*
*
* The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and
* underscores.
*
*
* @param policyName
* The name of the policy.
*
* The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and
* underscores.
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
*
* The name of the policy.
*
*
* The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and
* underscores.
*
*
* @return The name of the policy.
*
* The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and
* underscores.
*/
public String getPolicyName() {
return this.policyName;
}
/**
*
* The name of the policy.
*
*
* The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and
* underscores.
*
*
* @param policyName
* The name of the policy.
*
* The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and
* underscores.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIdentityPolicyRequest withPolicyName(String policyName) {
setPolicyName(policyName);
return this;
}
/**
*
* The text of the policy in JSON format. The policy cannot exceed 4 KB.
*
*
* For information about the syntax of sending authorization policies, see the Amazon SES Developer
* Guide.
*
*
* @param policy
* The text of the policy in JSON format. The policy cannot exceed 4 KB.
*
* For information about the syntax of sending authorization policies, see the Amazon SES Developer
* Guide.
*/
public void setPolicy(String policy) {
this.policy = policy;
}
/**
*
* The text of the policy in JSON format. The policy cannot exceed 4 KB.
*
*
* For information about the syntax of sending authorization policies, see the Amazon SES Developer
* Guide.
*
*
* @return The text of the policy in JSON format. The policy cannot exceed 4 KB.
*
* For information about the syntax of sending authorization policies, see the Amazon SES Developer
* Guide.
*/
public String getPolicy() {
return this.policy;
}
/**
*
* The text of the policy in JSON format. The policy cannot exceed 4 KB.
*
*
* For information about the syntax of sending authorization policies, see the Amazon SES Developer
* Guide.
*
*
* @param policy
* The text of the policy in JSON format. The policy cannot exceed 4 KB.
*
* For information about the syntax of sending authorization policies, see the Amazon SES Developer
* Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutIdentityPolicyRequest withPolicy(String policy) {
setPolicy(policy);
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 (getIdentity() != null)
sb.append("Identity: ").append(getIdentity()).append(",");
if (getPolicyName() != null)
sb.append("PolicyName: ").append(getPolicyName()).append(",");
if (getPolicy() != null)
sb.append("Policy: ").append(getPolicy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutIdentityPolicyRequest == false)
return false;
PutIdentityPolicyRequest other = (PutIdentityPolicyRequest) obj;
if (other.getIdentity() == null ^ this.getIdentity() == null)
return false;
if (other.getIdentity() != null && other.getIdentity().equals(this.getIdentity()) == false)
return false;
if (other.getPolicyName() == null ^ this.getPolicyName() == null)
return false;
if (other.getPolicyName() != null && other.getPolicyName().equals(this.getPolicyName()) == false)
return false;
if (other.getPolicy() == null ^ this.getPolicy() == null)
return false;
if (other.getPolicy() != null && other.getPolicy().equals(this.getPolicy()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIdentity() == null) ? 0 : getIdentity().hashCode());
hashCode = prime * hashCode + ((getPolicyName() == null) ? 0 : getPolicyName().hashCode());
hashCode = prime * hashCode + ((getPolicy() == null) ? 0 : getPolicy().hashCode());
return hashCode;
}
@Override
public PutIdentityPolicyRequest clone() {
return (PutIdentityPolicyRequest) super.clone();
}
}