software.amazon.awssdk.services.ses.model.PutIdentityPolicyRequest Maven / Gradle / Ivy
Show all versions of ses Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.ses.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutIdentityPolicyRequest extends SesRequest implements
ToCopyableBuilder {
private static final SdkField IDENTITY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Identity").getter(getter(PutIdentityPolicyRequest::identity)).setter(setter(Builder::identity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Identity").build()).build();
private static final SdkField POLICY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PolicyName").getter(getter(PutIdentityPolicyRequest::policyName)).setter(setter(Builder::policyName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyName").build()).build();
private static final SdkField POLICY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Policy")
.getter(getter(PutIdentityPolicyRequest::policy)).setter(setter(Builder::policy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Policy").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(IDENTITY_FIELD,
POLICY_NAME_FIELD, POLICY_FIELD));
private final String identity;
private final String policyName;
private final String policy;
private PutIdentityPolicyRequest(BuilderImpl builder) {
super(builder);
this.identity = builder.identity;
this.policyName = builder.policyName;
this.policy = builder.policy;
}
/**
*
* The identity that the policy will apply to. 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 API, you must own the identity.
*
*
* @return The identity that the policy will apply to. 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 API, you must own the identity.
*/
public String identity() {
return identity;
}
/**
*
* 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 policyName() {
return 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.
*
*
* @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 policy() {
return policy;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(identity());
hashCode = 31 * hashCode + Objects.hashCode(policyName());
hashCode = 31 * hashCode + Objects.hashCode(policy());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutIdentityPolicyRequest)) {
return false;
}
PutIdentityPolicyRequest other = (PutIdentityPolicyRequest) obj;
return Objects.equals(identity(), other.identity()) && Objects.equals(policyName(), other.policyName())
&& Objects.equals(policy(), other.policy());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("PutIdentityPolicyRequest").add("Identity", identity()).add("PolicyName", policyName())
.add("Policy", policy()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Identity":
return Optional.ofNullable(clazz.cast(identity()));
case "PolicyName":
return Optional.ofNullable(clazz.cast(policyName()));
case "Policy":
return Optional.ofNullable(clazz.cast(policy()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutIdentityPolicyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SesRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identity that the policy will apply to. 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 API, you must own the identity.
*
*
* @param identity
* The identity that the policy will apply to. 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 API, you must own the identity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder identity(String identity);
/**
*
* 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.
*/
Builder policyName(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.
*
*
* @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.
*/
Builder policy(String policy);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SesRequest.BuilderImpl implements Builder {
private String identity;
private String policyName;
private String policy;
private BuilderImpl() {
}
private BuilderImpl(PutIdentityPolicyRequest model) {
super(model);
identity(model.identity);
policyName(model.policyName);
policy(model.policy);
}
public final String getIdentity() {
return identity;
}
@Override
public final Builder identity(String identity) {
this.identity = identity;
return this;
}
public final void setIdentity(String identity) {
this.identity = identity;
}
public final String getPolicyName() {
return policyName;
}
@Override
public final Builder policyName(String policyName) {
this.policyName = policyName;
return this;
}
public final void setPolicyName(String policyName) {
this.policyName = policyName;
}
public final String getPolicy() {
return policy;
}
@Override
public final Builder policy(String policy) {
this.policy = policy;
return this;
}
public final void setPolicy(String policy) {
this.policy = policy;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutIdentityPolicyRequest build() {
return new PutIdentityPolicyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}