software.amazon.awssdk.services.sagemaker.model.SourceIpConfig Maven / Gradle / Ivy
Show all versions of sagemaker 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.sagemaker.model;
import java.beans.Transient;
import java.io.Serializable;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* A list of IP address ranges (CIDRs).
* Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their
* worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP
* addresses.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SourceIpConfig implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> CIDRS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Cidrs")
.getter(getter(SourceIpConfig::cidrs))
.setter(setter(Builder::cidrs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Cidrs").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CIDRS_FIELD));
private static final long serialVersionUID = 1L;
private final List cidrs;
private SourceIpConfig(BuilderImpl builder) {
this.cidrs = builder.cidrs;
}
/**
* For responses, this returns true if the service returned a value for the Cidrs 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 hasCidrs() {
return cidrs != null && !(cidrs instanceof SdkAutoConstructList);
}
/**
*
* A list of one to ten Classless
* Inter-Domain Routing (CIDR) values.
*
*
* Maximum: Ten CIDR values
*
*
*
* The following Length Constraints apply to individual CIDR values in the CIDR value list.
*
*
*
* 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 #hasCidrs} method.
*
*
* @return A list of one to ten Classless Inter-Domain
* Routing (CIDR) values.
*
* Maximum: Ten CIDR values
*
*
*
* The following Length Constraints apply to individual CIDR values in the CIDR value list.
*
*/
public final List cidrs() {
return cidrs;
}
@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 + Objects.hashCode(hasCidrs() ? cidrs() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SourceIpConfig)) {
return false;
}
SourceIpConfig other = (SourceIpConfig) obj;
return hasCidrs() == other.hasCidrs() && Objects.equals(cidrs(), other.cidrs());
}
/**
* 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("SourceIpConfig").add("Cidrs", hasCidrs() ? cidrs() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Cidrs":
return Optional.ofNullable(clazz.cast(cidrs()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SourceIpConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of one to ten Classless
* Inter-Domain Routing (CIDR) values.
*
*
* Maximum: Ten CIDR values
*
*
*
* The following Length Constraints apply to individual CIDR values in the CIDR value list.
*
*
*
* @param cidrs
* A list of one to ten Classless Inter-Domain
* Routing (CIDR) values.
*
* Maximum: Ten CIDR values
*
*
*
* The following Length Constraints apply to individual CIDR values in the CIDR value list.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cidrs(Collection cidrs);
/**
*
* A list of one to ten Classless
* Inter-Domain Routing (CIDR) values.
*
*
* Maximum: Ten CIDR values
*
*
*
* The following Length Constraints apply to individual CIDR values in the CIDR value list.
*
*
*
* @param cidrs
* A list of one to ten Classless Inter-Domain
* Routing (CIDR) values.
*
* Maximum: Ten CIDR values
*
*
*
* The following Length Constraints apply to individual CIDR values in the CIDR value list.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cidrs(String... cidrs);
}
static final class BuilderImpl implements Builder {
private List cidrs = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SourceIpConfig model) {
cidrs(model.cidrs);
}
public final Collection getCidrs() {
if (cidrs instanceof SdkAutoConstructList) {
return null;
}
return cidrs;
}
public final void setCidrs(Collection cidrs) {
this.cidrs = CidrsCopier.copy(cidrs);
}
@Override
@Transient
public final Builder cidrs(Collection cidrs) {
this.cidrs = CidrsCopier.copy(cidrs);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder cidrs(String... cidrs) {
cidrs(Arrays.asList(cidrs));
return this;
}
@Override
public SourceIpConfig build() {
return new SourceIpConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}