software.amazon.awssdk.services.workmail.model.CreateImpersonationRoleRequest Maven / Gradle / Ivy
Show all versions of workmail 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.workmail.model;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.DefaultValueTrait;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateImpersonationRoleRequest extends WorkMailRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientToken")
.getter(getter(CreateImpersonationRoleRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField ORGANIZATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OrganizationId").getter(getter(CreateImpersonationRoleRequest::organizationId))
.setter(setter(Builder::organizationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OrganizationId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateImpersonationRoleRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(CreateImpersonationRoleRequest::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateImpersonationRoleRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Rules")
.getter(getter(CreateImpersonationRoleRequest::rules))
.setter(setter(Builder::rules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Rules").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ImpersonationRule::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
ORGANIZATION_ID_FIELD, NAME_FIELD, TYPE_FIELD, DESCRIPTION_FIELD, RULES_FIELD));
private final String clientToken;
private final String organizationId;
private final String name;
private final String type;
private final String description;
private final List rules;
private CreateImpersonationRoleRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.organizationId = builder.organizationId;
this.name = builder.name;
this.type = builder.type;
this.description = builder.description;
this.rules = builder.rules;
}
/**
*
* The idempotency token for the client request.
*
*
* @return The idempotency token for the client request.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* The WorkMail organization to create the new impersonation role within.
*
*
* @return The WorkMail organization to create the new impersonation role within.
*/
public final String organizationId() {
return organizationId;
}
/**
*
* The name of the new impersonation role.
*
*
* @return The name of the new impersonation role.
*/
public final String name() {
return name;
}
/**
*
* The impersonation role's type. The available impersonation role types are READ_ONLY or
* FULL_ACCESS.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ImpersonationRoleType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The impersonation role's type. The available impersonation role types are READ_ONLY or
* FULL_ACCESS.
* @see ImpersonationRoleType
*/
public final ImpersonationRoleType type() {
return ImpersonationRoleType.fromValue(type);
}
/**
*
* The impersonation role's type. The available impersonation role types are READ_ONLY or
* FULL_ACCESS.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ImpersonationRoleType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The impersonation role's type. The available impersonation role types are READ_ONLY or
* FULL_ACCESS.
* @see ImpersonationRoleType
*/
public final String typeAsString() {
return type;
}
/**
*
* The description of the new impersonation role.
*
*
* @return The description of the new impersonation role.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the Rules property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasRules() {
return rules != null && !(rules instanceof SdkAutoConstructList);
}
/**
*
* The list of rules for the impersonation role.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasRules} method.
*
*
* @return The list of rules for the impersonation role.
*/
public final List rules() {
return rules;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(organizationId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasRules() ? rules() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateImpersonationRoleRequest)) {
return false;
}
CreateImpersonationRoleRequest other = (CreateImpersonationRoleRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(organizationId(), other.organizationId())
&& Objects.equals(name(), other.name()) && Objects.equals(typeAsString(), other.typeAsString())
&& Objects.equals(description(), other.description()) && hasRules() == other.hasRules()
&& Objects.equals(rules(), other.rules());
}
/**
* 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 final String toString() {
return ToString.builder("CreateImpersonationRoleRequest").add("ClientToken", clientToken())
.add("OrganizationId", organizationId()).add("Name", name()).add("Type", typeAsString())
.add("Description", description()).add("Rules", hasRules() ? rules() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ClientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "OrganizationId":
return Optional.ofNullable(clazz.cast(organizationId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Rules":
return Optional.ofNullable(clazz.cast(rules()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateImpersonationRoleRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkMailRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The idempotency token for the client request.
*
*
* @param clientToken
* The idempotency token for the client request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* The WorkMail organization to create the new impersonation role within.
*
*
* @param organizationId
* The WorkMail organization to create the new impersonation role within.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder organizationId(String organizationId);
/**
*
* The name of the new impersonation role.
*
*
* @param name
* The name of the new impersonation role.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The impersonation role's type. The available impersonation role types are READ_ONLY or
* FULL_ACCESS.
*
*
* @param type
* The impersonation role's type. The available impersonation role types are READ_ONLY or
* FULL_ACCESS.
* @see ImpersonationRoleType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImpersonationRoleType
*/
Builder type(String type);
/**
*
* The impersonation role's type. The available impersonation role types are READ_ONLY or
* FULL_ACCESS.
*
*
* @param type
* The impersonation role's type. The available impersonation role types are READ_ONLY or
* FULL_ACCESS.
* @see ImpersonationRoleType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImpersonationRoleType
*/
Builder type(ImpersonationRoleType type);
/**
*
* The description of the new impersonation role.
*
*
* @param description
* The description of the new impersonation role.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The list of rules for the impersonation role.
*
*
* @param rules
* The list of rules for the impersonation role.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rules(Collection rules);
/**
*
* The list of rules for the impersonation role.
*
*
* @param rules
* The list of rules for the impersonation role.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rules(ImpersonationRule... rules);
/**
*
* The list of rules for the impersonation role.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workmail.model.ImpersonationRule.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.workmail.model.ImpersonationRule#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workmail.model.ImpersonationRule.Builder#build()} is called
* immediately and its result is passed to {@link #rules(List)}.
*
* @param rules
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workmail.model.ImpersonationRule.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #rules(java.util.Collection)
*/
Builder rules(Consumer... rules);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WorkMailRequest.BuilderImpl implements Builder {
private String clientToken;
private String organizationId;
private String name;
private String type;
private String description;
private List rules = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateImpersonationRoleRequest model) {
super(model);
clientToken(model.clientToken);
organizationId(model.organizationId);
name(model.name);
type(model.type);
description(model.description);
rules(model.rules);
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final String getOrganizationId() {
return organizationId;
}
public final void setOrganizationId(String organizationId) {
this.organizationId = organizationId;
}
@Override
public final Builder organizationId(String organizationId) {
this.organizationId = organizationId;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(ImpersonationRoleType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final List getRules() {
List result = ImpersonationRuleListCopier.copyToBuilder(this.rules);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRules(Collection rules) {
this.rules = ImpersonationRuleListCopier.copyFromBuilder(rules);
}
@Override
public final Builder rules(Collection rules) {
this.rules = ImpersonationRuleListCopier.copy(rules);
return this;
}
@Override
@SafeVarargs
public final Builder rules(ImpersonationRule... rules) {
rules(Arrays.asList(rules));
return this;
}
@Override
@SafeVarargs
public final Builder rules(Consumer... rules) {
rules(Stream.of(rules).map(c -> ImpersonationRule.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateImpersonationRoleRequest build() {
return new CreateImpersonationRoleRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}