software.amazon.awssdk.services.s3.model.CORSConfiguration Maven / Gradle / Ivy
Show all versions of s3 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.s3.model;
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.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.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.traits.RequiredTrait;
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;
/**
*
* Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the
* Amazon S3 User Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CORSConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> CORS_RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CORSRules")
.getter(getter(CORSConfiguration::corsRules))
.setter(setter(Builder::corsRules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CORSRule")
.unmarshallLocationName("CORSRule").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CORSRule::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").unmarshallLocationName("member").build()).build())
.isFlattened(true).build(), RequiredTrait.create()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CORS_RULES_FIELD));
private static final long serialVersionUID = 1L;
private final List corsRules;
private CORSConfiguration(BuilderImpl builder) {
this.corsRules = builder.corsRules;
}
/**
* For responses, this returns true if the service returned a value for the CORSRules 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 hasCorsRules() {
return corsRules != null && !(corsRules instanceof SdkAutoConstructList);
}
/**
*
* A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the
* configuration.
*
*
* 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 #hasCorsRules} method.
*
*
* @return A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to
* the configuration.
*/
public final List corsRules() {
return corsRules;
}
@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(hasCorsRules() ? corsRules() : 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 CORSConfiguration)) {
return false;
}
CORSConfiguration other = (CORSConfiguration) obj;
return hasCorsRules() == other.hasCorsRules() && Objects.equals(corsRules(), other.corsRules());
}
/**
* 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("CORSConfiguration").add("CORSRules", hasCorsRules() ? corsRules() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CORSRules":
return Optional.ofNullable(clazz.cast(corsRules()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CORSConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the
* configuration.
*
*
* @param corsRules
* A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules
* to the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder corsRules(Collection corsRules);
/**
*
* A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the
* configuration.
*
*
* @param corsRules
* A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules
* to the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder corsRules(CORSRule... corsRules);
/**
*
* A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the
* configuration.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.s3.model.CORSRule.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.s3.model.CORSRule#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.s3.model.CORSRule.Builder#build()} is called immediately and its
* result is passed to {@link #corsRules(List)}.
*
* @param corsRules
* a consumer that will call methods on {@link software.amazon.awssdk.services.s3.model.CORSRule.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #corsRules(java.util.Collection)
*/
Builder corsRules(Consumer... corsRules);
}
static final class BuilderImpl implements Builder {
private List corsRules = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CORSConfiguration model) {
corsRules(model.corsRules);
}
public final List getCorsRules() {
List result = CORSRulesCopier.copyToBuilder(this.corsRules);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCorsRules(Collection corsRules) {
this.corsRules = CORSRulesCopier.copyFromBuilder(corsRules);
}
@Override
public final Builder corsRules(Collection corsRules) {
this.corsRules = CORSRulesCopier.copy(corsRules);
return this;
}
@Override
@SafeVarargs
public final Builder corsRules(CORSRule... corsRules) {
corsRules(Arrays.asList(corsRules));
return this;
}
@Override
@SafeVarargs
public final Builder corsRules(Consumer... corsRules) {
corsRules(Stream.of(corsRules).map(c -> CORSRule.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public CORSConfiguration build() {
return new CORSConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}