software.amazon.awssdk.services.workspacesweb.model.UpdateIpAccessSettingsRequest Maven / Gradle / Ivy
Show all versions of workspacesweb 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.workspacesweb.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 UpdateIpAccessSettingsRequest extends WorkSpacesWebRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(UpdateIpAccessSettingsRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(UpdateIpAccessSettingsRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("displayName").getter(getter(UpdateIpAccessSettingsRequest::displayName))
.setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("displayName").build()).build();
private static final SdkField IP_ACCESS_SETTINGS_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ipAccessSettingsArn").getter(getter(UpdateIpAccessSettingsRequest::ipAccessSettingsArn))
.setter(setter(Builder::ipAccessSettingsArn))
.traits(LocationTrait.builder().location(MarshallLocation.GREEDY_PATH).locationName("ipAccessSettingsArn").build())
.build();
private static final SdkField> IP_RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ipRules")
.getter(getter(UpdateIpAccessSettingsRequest::ipRules))
.setter(setter(Builder::ipRules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ipRules").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(IpRule::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,
DESCRIPTION_FIELD, DISPLAY_NAME_FIELD, IP_ACCESS_SETTINGS_ARN_FIELD, IP_RULES_FIELD));
private final String clientToken;
private final String description;
private final String displayName;
private final String ipAccessSettingsArn;
private final List ipRules;
private UpdateIpAccessSettingsRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.description = builder.description;
this.displayName = builder.displayName;
this.ipAccessSettingsArn = builder.ipAccessSettingsArn;
this.ipRules = builder.ipRules;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency
* ensures that an API request completes only once. With an idempotent request, if the original request completes
* successfully, subsequent retries with the same client token return the result from the original successful
* request.
*
*
* If you do not specify a client token, one is automatically generated by the AWS SDK.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
* Idempotency ensures that an API request completes only once. With an idempotent request, if the original
* request completes successfully, subsequent retries with the same client token return the result from the
* original successful request.
*
* If you do not specify a client token, one is automatically generated by the AWS SDK.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* The description of the IP access settings.
*
*
* @return The description of the IP access settings.
*/
public final String description() {
return description;
}
/**
*
* The display name of the IP access settings.
*
*
* @return The display name of the IP access settings.
*/
public final String displayName() {
return displayName;
}
/**
*
* The ARN of the IP access settings.
*
*
* @return The ARN of the IP access settings.
*/
public final String ipAccessSettingsArn() {
return ipAccessSettingsArn;
}
/**
* For responses, this returns true if the service returned a value for the IpRules 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 hasIpRules() {
return ipRules != null && !(ipRules instanceof SdkAutoConstructList);
}
/**
*
* The updated IP rules of the IP access settings.
*
*
* 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 #hasIpRules} method.
*
*
* @return The updated IP rules of the IP access settings.
*/
public final List ipRules() {
return ipRules;
}
@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(description());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(ipAccessSettingsArn());
hashCode = 31 * hashCode + Objects.hashCode(hasIpRules() ? ipRules() : 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 UpdateIpAccessSettingsRequest)) {
return false;
}
UpdateIpAccessSettingsRequest other = (UpdateIpAccessSettingsRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(description(), other.description())
&& Objects.equals(displayName(), other.displayName())
&& Objects.equals(ipAccessSettingsArn(), other.ipAccessSettingsArn()) && hasIpRules() == other.hasIpRules()
&& Objects.equals(ipRules(), other.ipRules());
}
/**
* 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("UpdateIpAccessSettingsRequest").add("ClientToken", clientToken())
.add("Description", description() == null ? null : "*** Sensitive Data Redacted ***")
.add("DisplayName", displayName() == null ? null : "*** Sensitive Data Redacted ***")
.add("IpAccessSettingsArn", ipAccessSettingsArn())
.add("IpRules", ipRules() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "displayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "ipAccessSettingsArn":
return Optional.ofNullable(clazz.cast(ipAccessSettingsArn()));
case "ipRules":
return Optional.ofNullable(clazz.cast(ipRules()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateIpAccessSettingsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkSpacesWebRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency
* ensures that an API request completes only once. With an idempotent request, if the original request
* completes successfully, subsequent retries with the same client token return the result from the original
* successful request.
*
*
* If you do not specify a client token, one is automatically generated by the AWS SDK.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
* Idempotency ensures that an API request completes only once. With an idempotent request, if the
* original request completes successfully, subsequent retries with the same client token return the
* result from the original successful request.
*
* If you do not specify a client token, one is automatically generated by the AWS SDK.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* The description of the IP access settings.
*
*
* @param description
* The description of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The display name of the IP access settings.
*
*
* @param displayName
* The display name of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* The ARN of the IP access settings.
*
*
* @param ipAccessSettingsArn
* The ARN of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ipAccessSettingsArn(String ipAccessSettingsArn);
/**
*
* The updated IP rules of the IP access settings.
*
*
* @param ipRules
* The updated IP rules of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ipRules(Collection ipRules);
/**
*
* The updated IP rules of the IP access settings.
*
*
* @param ipRules
* The updated IP rules of the IP access settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ipRules(IpRule... ipRules);
/**
*
* The updated IP rules of the IP access settings.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workspacesweb.model.IpRule.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.workspacesweb.model.IpRule#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workspacesweb.model.IpRule.Builder#build()} is called immediately and
* its result is passed to {@link #ipRules(List)}.
*
* @param ipRules
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workspacesweb.model.IpRule.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #ipRules(java.util.Collection)
*/
Builder ipRules(Consumer... ipRules);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WorkSpacesWebRequest.BuilderImpl implements Builder {
private String clientToken;
private String description;
private String displayName;
private String ipAccessSettingsArn;
private List ipRules = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpdateIpAccessSettingsRequest model) {
super(model);
clientToken(model.clientToken);
description(model.description);
displayName(model.displayName);
ipAccessSettingsArn(model.ipAccessSettingsArn);
ipRules(model.ipRules);
}
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 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 String getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final String getIpAccessSettingsArn() {
return ipAccessSettingsArn;
}
public final void setIpAccessSettingsArn(String ipAccessSettingsArn) {
this.ipAccessSettingsArn = ipAccessSettingsArn;
}
@Override
public final Builder ipAccessSettingsArn(String ipAccessSettingsArn) {
this.ipAccessSettingsArn = ipAccessSettingsArn;
return this;
}
public final List getIpRules() {
List result = IpRuleListCopier.copyToBuilder(this.ipRules);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setIpRules(Collection ipRules) {
this.ipRules = IpRuleListCopier.copyFromBuilder(ipRules);
}
@Override
public final Builder ipRules(Collection ipRules) {
this.ipRules = IpRuleListCopier.copy(ipRules);
return this;
}
@Override
@SafeVarargs
public final Builder ipRules(IpRule... ipRules) {
ipRules(Arrays.asList(ipRules));
return this;
}
@Override
@SafeVarargs
public final Builder ipRules(Consumer... ipRules) {
ipRules(Stream.of(ipRules).map(c -> IpRule.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 UpdateIpAccessSettingsRequest build() {
return new UpdateIpAccessSettingsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}