software.amazon.awssdk.services.qldb.model.S3ExportConfiguration Maven / Gradle / Ivy
Show all versions of qldb Show documentation
/*
* 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.qldb.model;
import java.io.Serializable;
import java.util.Arrays;
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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal
* contents.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class S3ExportConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField BUCKET_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(S3ExportConfiguration::bucket)).setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Bucket").build()).build();
private static final SdkField PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(S3ExportConfiguration::prefix)).setter(setter(Builder::prefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Prefix").build()).build();
private static final SdkField ENCRYPTION_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(S3ExportConfiguration::encryptionConfiguration)).setter(setter(Builder::encryptionConfiguration))
.constructor(S3EncryptionConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EncryptionConfiguration").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BUCKET_FIELD, PREFIX_FIELD,
ENCRYPTION_CONFIGURATION_FIELD));
private static final long serialVersionUID = 1L;
private final String bucket;
private final String prefix;
private final S3EncryptionConfiguration encryptionConfiguration;
private S3ExportConfiguration(BuilderImpl builder) {
this.bucket = builder.bucket;
this.prefix = builder.prefix;
this.encryptionConfiguration = builder.encryptionConfiguration;
}
/**
*
* The Amazon S3 bucket name in which a journal export job writes the journal contents.
*
*
* The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and
* Limitations in the Amazon S3 Developer Guide.
*
*
* @return The Amazon S3 bucket name in which a journal export job writes the journal contents.
*
* The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and
* Limitations in the Amazon S3 Developer Guide.
*/
public String bucket() {
return bucket;
}
/**
*
* The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.
*
*
* The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the
* Amazon S3 Developer Guide.
*
*
* The following are examples of valid Prefix values:
*
*
* -
*
* JournalExports-ForMyLedger/Testing/
*
*
* -
*
* JournalExports
*
*
* -
*
* My:Tests/
*
*
*
*
* @return The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.
*
* The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in
* the Amazon S3 Developer Guide.
*
*
* The following are examples of valid Prefix values:
*
*
* -
*
* JournalExports-ForMyLedger/Testing/
*
*
* -
*
* JournalExports
*
*
* -
*
* My:Tests/
*
*
*/
public String prefix() {
return prefix;
}
/**
*
* The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
*
*
* @return The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
*/
public S3EncryptionConfiguration encryptionConfiguration() {
return encryptionConfiguration;
}
@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(bucket());
hashCode = 31 * hashCode + Objects.hashCode(prefix());
hashCode = 31 * hashCode + Objects.hashCode(encryptionConfiguration());
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 S3ExportConfiguration)) {
return false;
}
S3ExportConfiguration other = (S3ExportConfiguration) obj;
return Objects.equals(bucket(), other.bucket()) && Objects.equals(prefix(), other.prefix())
&& Objects.equals(encryptionConfiguration(), other.encryptionConfiguration());
}
/**
* 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("S3ExportConfiguration").add("Bucket", bucket()).add("Prefix", prefix())
.add("EncryptionConfiguration", encryptionConfiguration()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Bucket":
return Optional.ofNullable(clazz.cast(bucket()));
case "Prefix":
return Optional.ofNullable(clazz.cast(prefix()));
case "EncryptionConfiguration":
return Optional.ofNullable(clazz.cast(encryptionConfiguration()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((S3ExportConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon S3 bucket name in which a journal export job writes the journal contents.
*
*
* The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and
* Limitations in the Amazon S3 Developer Guide.
*
*
* @param bucket
* The Amazon S3 bucket name in which a journal export job writes the journal contents.
*
* The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and
* Limitations in the Amazon S3 Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucket(String bucket);
/**
*
* The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.
*
*
* The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the
* Amazon S3 Developer Guide.
*
*
* The following are examples of valid Prefix values:
*
*
* -
*
* JournalExports-ForMyLedger/Testing/
*
*
* -
*
* JournalExports
*
*
* -
*
* My:Tests/
*
*
*
*
* @param prefix
* The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.
*
* The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata
* in the Amazon S3 Developer Guide.
*
*
* The following are examples of valid Prefix values:
*
*
* -
*
* JournalExports-ForMyLedger/Testing/
*
*
* -
*
* JournalExports
*
*
* -
*
* My:Tests/
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder prefix(String prefix);
/**
*
* The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
*
*
* @param encryptionConfiguration
* The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionConfiguration(S3EncryptionConfiguration encryptionConfiguration);
/**
*
* The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
*
* This is a convenience that creates an instance of the {@link S3EncryptionConfiguration.Builder} avoiding the
* need to create one manually via {@link S3EncryptionConfiguration#builder()}.
*
* When the {@link Consumer} completes, {@link S3EncryptionConfiguration.Builder#build()} is called immediately
* and its result is passed to {@link #encryptionConfiguration(S3EncryptionConfiguration)}.
*
* @param encryptionConfiguration
* a consumer that will call methods on {@link S3EncryptionConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #encryptionConfiguration(S3EncryptionConfiguration)
*/
default Builder encryptionConfiguration(Consumer encryptionConfiguration) {
return encryptionConfiguration(S3EncryptionConfiguration.builder().applyMutation(encryptionConfiguration).build());
}
}
static final class BuilderImpl implements Builder {
private String bucket;
private String prefix;
private S3EncryptionConfiguration encryptionConfiguration;
private BuilderImpl() {
}
private BuilderImpl(S3ExportConfiguration model) {
bucket(model.bucket);
prefix(model.prefix);
encryptionConfiguration(model.encryptionConfiguration);
}
public final String getBucket() {
return bucket;
}
@Override
public final Builder bucket(String bucket) {
this.bucket = bucket;
return this;
}
public final void setBucket(String bucket) {
this.bucket = bucket;
}
public final String getPrefix() {
return prefix;
}
@Override
public final Builder prefix(String prefix) {
this.prefix = prefix;
return this;
}
public final void setPrefix(String prefix) {
this.prefix = prefix;
}
public final S3EncryptionConfiguration.Builder getEncryptionConfiguration() {
return encryptionConfiguration != null ? encryptionConfiguration.toBuilder() : null;
}
@Override
public final Builder encryptionConfiguration(S3EncryptionConfiguration encryptionConfiguration) {
this.encryptionConfiguration = encryptionConfiguration;
return this;
}
public final void setEncryptionConfiguration(S3EncryptionConfiguration.BuilderImpl encryptionConfiguration) {
this.encryptionConfiguration = encryptionConfiguration != null ? encryptionConfiguration.build() : null;
}
@Override
public S3ExportConfiguration build() {
return new S3ExportConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}