software.amazon.awssdk.services.s3.model.WebsiteConfiguration Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies website configuration parameters for an Amazon S3 bucket.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class WebsiteConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ERROR_DOCUMENT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(WebsiteConfiguration::errorDocument))
.setter(setter(Builder::errorDocument))
.constructor(ErrorDocument::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ErrorDocument")
.unmarshallLocationName("ErrorDocument").build()).build();
private static final SdkField INDEX_DOCUMENT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(WebsiteConfiguration::indexDocument))
.setter(setter(Builder::indexDocument))
.constructor(IndexDocument::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndexDocument")
.unmarshallLocationName("IndexDocument").build()).build();
private static final SdkField REDIRECT_ALL_REQUESTS_TO_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(WebsiteConfiguration::redirectAllRequestsTo))
.setter(setter(Builder::redirectAllRequestsTo))
.constructor(RedirectAllRequestsTo::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RedirectAllRequestsTo")
.unmarshallLocationName("RedirectAllRequestsTo").build()).build();
private static final SdkField> ROUTING_RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(WebsiteConfiguration::routingRules))
.setter(setter(Builder::routingRules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoutingRules")
.unmarshallLocationName("RoutingRules").build(),
ListTrait
.builder()
.memberLocationName("RoutingRule")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RoutingRule::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("RoutingRule").unmarshallLocationName("RoutingRule").build())
.build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ERROR_DOCUMENT_FIELD,
INDEX_DOCUMENT_FIELD, REDIRECT_ALL_REQUESTS_TO_FIELD, ROUTING_RULES_FIELD));
private static final long serialVersionUID = 1L;
private final ErrorDocument errorDocument;
private final IndexDocument indexDocument;
private final RedirectAllRequestsTo redirectAllRequestsTo;
private final List routingRules;
private WebsiteConfiguration(BuilderImpl builder) {
this.errorDocument = builder.errorDocument;
this.indexDocument = builder.indexDocument;
this.redirectAllRequestsTo = builder.redirectAllRequestsTo;
this.routingRules = builder.routingRules;
}
/**
*
* The name of the error document for the website.
*
*
* @return The name of the error document for the website.
*/
public ErrorDocument errorDocument() {
return errorDocument;
}
/**
*
* The name of the index document for the website.
*
*
* @return The name of the index document for the website.
*/
public IndexDocument indexDocument() {
return indexDocument;
}
/**
*
* The redirect behavior for every request to this bucket's website endpoint.
*
*
*
* If you specify this property, you can't specify any other property.
*
*
*
* @return The redirect behavior for every request to this bucket's website endpoint.
*
* If you specify this property, you can't specify any other property.
*
*/
public RedirectAllRequestsTo redirectAllRequestsTo() {
return redirectAllRequestsTo;
}
/**
*
* Rules that define when a redirect is applied and the redirect behavior.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return Rules that define when a redirect is applied and the redirect behavior.
*/
public List routingRules() {
return routingRules;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(errorDocument());
hashCode = 31 * hashCode + Objects.hashCode(indexDocument());
hashCode = 31 * hashCode + Objects.hashCode(redirectAllRequestsTo());
hashCode = 31 * hashCode + Objects.hashCode(routingRules());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof WebsiteConfiguration)) {
return false;
}
WebsiteConfiguration other = (WebsiteConfiguration) obj;
return Objects.equals(errorDocument(), other.errorDocument()) && Objects.equals(indexDocument(), other.indexDocument())
&& Objects.equals(redirectAllRequestsTo(), other.redirectAllRequestsTo())
&& Objects.equals(routingRules(), other.routingRules());
}
/**
* 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 String toString() {
return ToString.builder("WebsiteConfiguration").add("ErrorDocument", errorDocument())
.add("IndexDocument", indexDocument()).add("RedirectAllRequestsTo", redirectAllRequestsTo())
.add("RoutingRules", routingRules()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ErrorDocument":
return Optional.ofNullable(clazz.cast(errorDocument()));
case "IndexDocument":
return Optional.ofNullable(clazz.cast(indexDocument()));
case "RedirectAllRequestsTo":
return Optional.ofNullable(clazz.cast(redirectAllRequestsTo()));
case "RoutingRules":
return Optional.ofNullable(clazz.cast(routingRules()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((WebsiteConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the error document for the website.
*
*
* @param errorDocument
* The name of the error document for the website.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorDocument(ErrorDocument errorDocument);
/**
*
* The name of the error document for the website.
*
* This is a convenience that creates an instance of the {@link ErrorDocument.Builder} avoiding the need to
* create one manually via {@link ErrorDocument#builder()}.
*
* When the {@link Consumer} completes, {@link ErrorDocument.Builder#build()} is called immediately and its
* result is passed to {@link #errorDocument(ErrorDocument)}.
*
* @param errorDocument
* a consumer that will call methods on {@link ErrorDocument.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #errorDocument(ErrorDocument)
*/
default Builder errorDocument(Consumer errorDocument) {
return errorDocument(ErrorDocument.builder().applyMutation(errorDocument).build());
}
/**
*
* The name of the index document for the website.
*
*
* @param indexDocument
* The name of the index document for the website.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder indexDocument(IndexDocument indexDocument);
/**
*
* The name of the index document for the website.
*
* This is a convenience that creates an instance of the {@link IndexDocument.Builder} avoiding the need to
* create one manually via {@link IndexDocument#builder()}.
*
* When the {@link Consumer} completes, {@link IndexDocument.Builder#build()} is called immediately and its
* result is passed to {@link #indexDocument(IndexDocument)}.
*
* @param indexDocument
* a consumer that will call methods on {@link IndexDocument.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #indexDocument(IndexDocument)
*/
default Builder indexDocument(Consumer indexDocument) {
return indexDocument(IndexDocument.builder().applyMutation(indexDocument).build());
}
/**
*
* The redirect behavior for every request to this bucket's website endpoint.
*
*
*
* If you specify this property, you can't specify any other property.
*
*
*
* @param redirectAllRequestsTo
* The redirect behavior for every request to this bucket's website endpoint.
*
* If you specify this property, you can't specify any other property.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder redirectAllRequestsTo(RedirectAllRequestsTo redirectAllRequestsTo);
/**
*
* The redirect behavior for every request to this bucket's website endpoint.
*
*
*
* If you specify this property, you can't specify any other property.
*
* This is a convenience that creates an instance of the {@link RedirectAllRequestsTo.Builder}
* avoiding the need to create one manually via {@link RedirectAllRequestsTo#builder()}.
*
* When the {@link Consumer} completes, {@link RedirectAllRequestsTo.Builder#build()} is called immediately and
* its result is passed to {@link #redirectAllRequestsTo(RedirectAllRequestsTo)}.
*
* @param redirectAllRequestsTo
* a consumer that will call methods on {@link RedirectAllRequestsTo.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #redirectAllRequestsTo(RedirectAllRequestsTo)
*/
default Builder redirectAllRequestsTo(Consumer redirectAllRequestsTo) {
return redirectAllRequestsTo(RedirectAllRequestsTo.builder().applyMutation(redirectAllRequestsTo).build());
}
/**
*
* Rules that define when a redirect is applied and the redirect behavior.
*
*
* @param routingRules
* Rules that define when a redirect is applied and the redirect behavior.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder routingRules(Collection routingRules);
/**
*
* Rules that define when a redirect is applied and the redirect behavior.
*
*
* @param routingRules
* Rules that define when a redirect is applied and the redirect behavior.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder routingRules(RoutingRule... routingRules);
/**
*
* Rules that define when a redirect is applied and the redirect behavior.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #routingRules(List)}.
*
* @param routingRules
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #routingRules(List)
*/
Builder routingRules(Consumer... routingRules);
}
static final class BuilderImpl implements Builder {
private ErrorDocument errorDocument;
private IndexDocument indexDocument;
private RedirectAllRequestsTo redirectAllRequestsTo;
private List routingRules = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(WebsiteConfiguration model) {
errorDocument(model.errorDocument);
indexDocument(model.indexDocument);
redirectAllRequestsTo(model.redirectAllRequestsTo);
routingRules(model.routingRules);
}
public final ErrorDocument.Builder getErrorDocument() {
return errorDocument != null ? errorDocument.toBuilder() : null;
}
@Override
public final Builder errorDocument(ErrorDocument errorDocument) {
this.errorDocument = errorDocument;
return this;
}
public final void setErrorDocument(ErrorDocument.BuilderImpl errorDocument) {
this.errorDocument = errorDocument != null ? errorDocument.build() : null;
}
public final IndexDocument.Builder getIndexDocument() {
return indexDocument != null ? indexDocument.toBuilder() : null;
}
@Override
public final Builder indexDocument(IndexDocument indexDocument) {
this.indexDocument = indexDocument;
return this;
}
public final void setIndexDocument(IndexDocument.BuilderImpl indexDocument) {
this.indexDocument = indexDocument != null ? indexDocument.build() : null;
}
public final RedirectAllRequestsTo.Builder getRedirectAllRequestsTo() {
return redirectAllRequestsTo != null ? redirectAllRequestsTo.toBuilder() : null;
}
@Override
public final Builder redirectAllRequestsTo(RedirectAllRequestsTo redirectAllRequestsTo) {
this.redirectAllRequestsTo = redirectAllRequestsTo;
return this;
}
public final void setRedirectAllRequestsTo(RedirectAllRequestsTo.BuilderImpl redirectAllRequestsTo) {
this.redirectAllRequestsTo = redirectAllRequestsTo != null ? redirectAllRequestsTo.build() : null;
}
public final Collection getRoutingRules() {
return routingRules != null ? routingRules.stream().map(RoutingRule::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder routingRules(Collection routingRules) {
this.routingRules = RoutingRulesCopier.copy(routingRules);
return this;
}
@Override
@SafeVarargs
public final Builder routingRules(RoutingRule... routingRules) {
routingRules(Arrays.asList(routingRules));
return this;
}
@Override
@SafeVarargs
public final Builder routingRules(Consumer... routingRules) {
routingRules(Stream.of(routingRules).map(c -> RoutingRule.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setRoutingRules(Collection routingRules) {
this.routingRules = RoutingRulesCopier.copyFromBuilder(routingRules);
}
@Override
public WebsiteConfiguration build() {
return new WebsiteConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy