software.amazon.awssdk.services.snowball.model.KeyRange Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of snowball Show documentation
Show all versions of snowball Show documentation
The AWS Java SDK for Amazon Snowball module holds the client classes that are used for communicating
with Amazon Snowball.
/*
* 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.snowball.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.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;
/**
*
* Contains a key range. For export jobs, a S3Resource object can have an optional KeyRange
* value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an
* inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class KeyRange implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField BEGIN_MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("BeginMarker").getter(getter(KeyRange::beginMarker)).setter(setter(Builder::beginMarker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BeginMarker").build()).build();
private static final SdkField END_MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndMarker").getter(getter(KeyRange::endMarker)).setter(setter(Builder::endMarker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndMarker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BEGIN_MARKER_FIELD,
END_MARKER_FIELD));
private static final long serialVersionUID = 1L;
private final String beginMarker;
private final String endMarker;
private KeyRange(BuilderImpl builder) {
this.beginMarker = builder.beginMarker;
this.endMarker = builder.endMarker;
}
/**
*
* The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
*
*
* @return The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary
* sorted.
*/
public final String beginMarker() {
return beginMarker;
}
/**
*
* The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
*
*
* @return The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
*/
public final String endMarker() {
return endMarker;
}
@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(beginMarker());
hashCode = 31 * hashCode + Objects.hashCode(endMarker());
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 KeyRange)) {
return false;
}
KeyRange other = (KeyRange) obj;
return Objects.equals(beginMarker(), other.beginMarker()) && Objects.equals(endMarker(), other.endMarker());
}
/**
* 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("KeyRange").add("BeginMarker", beginMarker()).add("EndMarker", endMarker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "BeginMarker":
return Optional.ofNullable(clazz.cast(beginMarker()));
case "EndMarker":
return Optional.ofNullable(clazz.cast(endMarker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((KeyRange) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
*
*
* @param beginMarker
* The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary
* sorted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder beginMarker(String beginMarker);
/**
*
* The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
*
*
* @param endMarker
* The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary
* sorted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endMarker(String endMarker);
}
static final class BuilderImpl implements Builder {
private String beginMarker;
private String endMarker;
private BuilderImpl() {
}
private BuilderImpl(KeyRange model) {
beginMarker(model.beginMarker);
endMarker(model.endMarker);
}
public final String getBeginMarker() {
return beginMarker;
}
public final void setBeginMarker(String beginMarker) {
this.beginMarker = beginMarker;
}
@Override
public final Builder beginMarker(String beginMarker) {
this.beginMarker = beginMarker;
return this;
}
public final String getEndMarker() {
return endMarker;
}
public final void setEndMarker(String endMarker) {
this.endMarker = endMarker;
}
@Override
public final Builder endMarker(String endMarker) {
this.endMarker = endMarker;
return this;
}
@Override
public KeyRange build() {
return new KeyRange(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}