software.amazon.awssdk.services.connect.model.UpdateAuthenticationProfileRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connect Show documentation
Show all versions of connect Show documentation
The AWS Java SDK for Connect module holds the client classes that are used for
communicating with Connect.
/*
* 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.connect.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 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.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 UpdateAuthenticationProfileRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField AUTHENTICATION_PROFILE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthenticationProfileId").getter(getter(UpdateAuthenticationProfileRequest::authenticationProfileId))
.setter(setter(Builder::authenticationProfileId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("AuthenticationProfileId").build())
.build();
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(UpdateAuthenticationProfileRequest::instanceId))
.setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(UpdateAuthenticationProfileRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(UpdateAuthenticationProfileRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> ALLOWED_IPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AllowedIps")
.getter(getter(UpdateAuthenticationProfileRequest::allowedIps))
.setter(setter(Builder::allowedIps))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllowedIps").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> BLOCKED_IPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("BlockedIps")
.getter(getter(UpdateAuthenticationProfileRequest::blockedIps))
.setter(setter(Builder::blockedIps))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BlockedIps").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField PERIODIC_SESSION_DURATION_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("PeriodicSessionDuration").getter(getter(UpdateAuthenticationProfileRequest::periodicSessionDuration))
.setter(setter(Builder::periodicSessionDuration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PeriodicSessionDuration").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
AUTHENTICATION_PROFILE_ID_FIELD, INSTANCE_ID_FIELD, NAME_FIELD, DESCRIPTION_FIELD, ALLOWED_IPS_FIELD,
BLOCKED_IPS_FIELD, PERIODIC_SESSION_DURATION_FIELD));
private final String authenticationProfileId;
private final String instanceId;
private final String name;
private final String description;
private final List allowedIps;
private final List blockedIps;
private final Integer periodicSessionDuration;
private UpdateAuthenticationProfileRequest(BuilderImpl builder) {
super(builder);
this.authenticationProfileId = builder.authenticationProfileId;
this.instanceId = builder.instanceId;
this.name = builder.name;
this.description = builder.description;
this.allowedIps = builder.allowedIps;
this.blockedIps = builder.blockedIps;
this.periodicSessionDuration = builder.periodicSessionDuration;
}
/**
*
* A unique identifier for the authentication profile.
*
*
* @return A unique identifier for the authentication profile.
*/
public final String authenticationProfileId() {
return authenticationProfileId;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The name for the authentication profile.
*
*
* @return The name for the authentication profile.
*/
public final String name() {
return name;
}
/**
*
* The description for the authentication profile.
*
*
* @return The description for the authentication profile.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the AllowedIps 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 hasAllowedIps() {
return allowedIps != null && !(allowedIps instanceof SdkAutoConstructList);
}
/**
*
* A list of IP address range strings that are allowed to access the instance. For more information on how to
* configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
*
*
* 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 #hasAllowedIps} method.
*
*
* @return A list of IP address range strings that are allowed to access the instance. For more information on how
* to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
*/
public final List allowedIps() {
return allowedIps;
}
/**
* For responses, this returns true if the service returned a value for the BlockedIps 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 hasBlockedIps() {
return blockedIps != null && !(blockedIps instanceof SdkAutoConstructList);
}
/**
*
* A list of IP address range strings that are blocked from accessing the instance. For more information on how to
* configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
*
*
* 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 #hasBlockedIps} method.
*
*
* @return A list of IP address range strings that are blocked from accessing the instance. For more information on
* how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
*/
public final List blockedIps() {
return blockedIps;
}
/**
*
* The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value
* determines the maximum possible time before an agent is authenticated. For more information, For more information
* on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
*
*
* @return The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This
* value determines the maximum possible time before an agent is authenticated. For more information, For
* more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
*/
public final Integer periodicSessionDuration() {
return periodicSessionDuration;
}
@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(authenticationProfileId());
hashCode = 31 * hashCode + Objects.hashCode(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasAllowedIps() ? allowedIps() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasBlockedIps() ? blockedIps() : null);
hashCode = 31 * hashCode + Objects.hashCode(periodicSessionDuration());
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 UpdateAuthenticationProfileRequest)) {
return false;
}
UpdateAuthenticationProfileRequest other = (UpdateAuthenticationProfileRequest) obj;
return Objects.equals(authenticationProfileId(), other.authenticationProfileId())
&& Objects.equals(instanceId(), other.instanceId()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description()) && hasAllowedIps() == other.hasAllowedIps()
&& Objects.equals(allowedIps(), other.allowedIps()) && hasBlockedIps() == other.hasBlockedIps()
&& Objects.equals(blockedIps(), other.blockedIps())
&& Objects.equals(periodicSessionDuration(), other.periodicSessionDuration());
}
/**
* 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("UpdateAuthenticationProfileRequest").add("AuthenticationProfileId", authenticationProfileId())
.add("InstanceId", instanceId()).add("Name", name()).add("Description", description())
.add("AllowedIps", hasAllowedIps() ? allowedIps() : null)
.add("BlockedIps", hasBlockedIps() ? blockedIps() : null)
.add("PeriodicSessionDuration", periodicSessionDuration()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AuthenticationProfileId":
return Optional.ofNullable(clazz.cast(authenticationProfileId()));
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "AllowedIps":
return Optional.ofNullable(clazz.cast(allowedIps()));
case "BlockedIps":
return Optional.ofNullable(clazz.cast(blockedIps()));
case "PeriodicSessionDuration":
return Optional.ofNullable(clazz.cast(periodicSessionDuration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateAuthenticationProfileRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* A unique identifier for the authentication profile.
*
*
* @param authenticationProfileId
* A unique identifier for the authentication profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authenticationProfileId(String authenticationProfileId);
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The name for the authentication profile.
*
*
* @param name
* The name for the authentication profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The description for the authentication profile.
*
*
* @param description
* The description for the authentication profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* A list of IP address range strings that are allowed to access the instance. For more information on how to
* configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
*
*
* @param allowedIps
* A list of IP address range strings that are allowed to access the instance. For more information on
* how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedIps(Collection allowedIps);
/**
*
* A list of IP address range strings that are allowed to access the instance. For more information on how to
* configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
*
*
* @param allowedIps
* A list of IP address range strings that are allowed to access the instance. For more information on
* how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedIps(String... allowedIps);
/**
*
* A list of IP address range strings that are blocked from accessing the instance. For more information on how
* to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
*
*
* @param blockedIps
* A list of IP address range strings that are blocked from accessing the instance. For more information
* on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blockedIps(Collection blockedIps);
/**
*
* A list of IP address range strings that are blocked from accessing the instance. For more information on how
* to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
*
*
* @param blockedIps
* A list of IP address range strings that are blocked from accessing the instance. For more information
* on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blockedIps(String... blockedIps);
/**
*
* The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value
* determines the maximum possible time before an agent is authenticated. For more information, For more
* information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
*
*
* @param periodicSessionDuration
* The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This
* value determines the maximum possible time before an agent is authenticated. For more information, For
* more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder periodicSessionDuration(Integer periodicSessionDuration);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String authenticationProfileId;
private String instanceId;
private String name;
private String description;
private List allowedIps = DefaultSdkAutoConstructList.getInstance();
private List blockedIps = DefaultSdkAutoConstructList.getInstance();
private Integer periodicSessionDuration;
private BuilderImpl() {
}
private BuilderImpl(UpdateAuthenticationProfileRequest model) {
super(model);
authenticationProfileId(model.authenticationProfileId);
instanceId(model.instanceId);
name(model.name);
description(model.description);
allowedIps(model.allowedIps);
blockedIps(model.blockedIps);
periodicSessionDuration(model.periodicSessionDuration);
}
public final String getAuthenticationProfileId() {
return authenticationProfileId;
}
public final void setAuthenticationProfileId(String authenticationProfileId) {
this.authenticationProfileId = authenticationProfileId;
}
@Override
public final Builder authenticationProfileId(String authenticationProfileId) {
this.authenticationProfileId = authenticationProfileId;
return this;
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
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 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 Collection getAllowedIps() {
if (allowedIps instanceof SdkAutoConstructList) {
return null;
}
return allowedIps;
}
public final void setAllowedIps(Collection allowedIps) {
this.allowedIps = IpCidrListCopier.copy(allowedIps);
}
@Override
public final Builder allowedIps(Collection allowedIps) {
this.allowedIps = IpCidrListCopier.copy(allowedIps);
return this;
}
@Override
@SafeVarargs
public final Builder allowedIps(String... allowedIps) {
allowedIps(Arrays.asList(allowedIps));
return this;
}
public final Collection getBlockedIps() {
if (blockedIps instanceof SdkAutoConstructList) {
return null;
}
return blockedIps;
}
public final void setBlockedIps(Collection blockedIps) {
this.blockedIps = IpCidrListCopier.copy(blockedIps);
}
@Override
public final Builder blockedIps(Collection blockedIps) {
this.blockedIps = IpCidrListCopier.copy(blockedIps);
return this;
}
@Override
@SafeVarargs
public final Builder blockedIps(String... blockedIps) {
blockedIps(Arrays.asList(blockedIps));
return this;
}
public final Integer getPeriodicSessionDuration() {
return periodicSessionDuration;
}
public final void setPeriodicSessionDuration(Integer periodicSessionDuration) {
this.periodicSessionDuration = periodicSessionDuration;
}
@Override
public final Builder periodicSessionDuration(Integer periodicSessionDuration) {
this.periodicSessionDuration = periodicSessionDuration;
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 UpdateAuthenticationProfileRequest build() {
return new UpdateAuthenticationProfileRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}