software.amazon.awssdk.services.databrew.model.ExcelOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of databrew Show documentation
Show all versions of databrew Show documentation
The AWS Java SDK for Data Brew module holds the client classes that are used for
communicating with Data Brew.
The newest version!
/*
* 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.databrew.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*
* Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset
* from that file.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ExcelOptions implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> SHEET_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SheetNames")
.getter(getter(ExcelOptions::sheetNames))
.setter(setter(Builder::sheetNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SheetNames").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 SdkField> SHEET_INDEXES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SheetIndexes")
.getter(getter(ExcelOptions::sheetIndexes))
.setter(setter(Builder::sheetIndexes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SheetIndexes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.INTEGER)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField HEADER_ROW_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("HeaderRow").getter(getter(ExcelOptions::headerRow)).setter(setter(Builder::headerRow))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HeaderRow").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SHEET_NAMES_FIELD,
SHEET_INDEXES_FIELD, HEADER_ROW_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("SheetNames", SHEET_NAMES_FIELD);
put("SheetIndexes", SHEET_INDEXES_FIELD);
put("HeaderRow", HEADER_ROW_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final List sheetNames;
private final List sheetIndexes;
private final Boolean headerRow;
private ExcelOptions(BuilderImpl builder) {
this.sheetNames = builder.sheetNames;
this.sheetIndexes = builder.sheetIndexes;
this.headerRow = builder.headerRow;
}
/**
* For responses, this returns true if the service returned a value for the SheetNames 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 hasSheetNames() {
return sheetNames != null && !(sheetNames instanceof SdkAutoConstructList);
}
/**
*
* One or more named sheets in the Excel file that will be included in the dataset.
*
*
* 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 #hasSheetNames} method.
*
*
* @return One or more named sheets in the Excel file that will be included in the dataset.
*/
public final List sheetNames() {
return sheetNames;
}
/**
* For responses, this returns true if the service returned a value for the SheetIndexes 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 hasSheetIndexes() {
return sheetIndexes != null && !(sheetIndexes instanceof SdkAutoConstructList);
}
/**
*
* One or more sheet numbers in the Excel file that will be included in the dataset.
*
*
* 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 #hasSheetIndexes} method.
*
*
* @return One or more sheet numbers in the Excel file that will be included in the dataset.
*/
public final List sheetIndexes() {
return sheetIndexes;
}
/**
*
* A variable that specifies whether the first row in the file is parsed as the header. If this value is false,
* column names are auto-generated.
*
*
* @return A variable that specifies whether the first row in the file is parsed as the header. If this value is
* false, column names are auto-generated.
*/
public final Boolean headerRow() {
return headerRow;
}
@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(hasSheetNames() ? sheetNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSheetIndexes() ? sheetIndexes() : null);
hashCode = 31 * hashCode + Objects.hashCode(headerRow());
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 ExcelOptions)) {
return false;
}
ExcelOptions other = (ExcelOptions) obj;
return hasSheetNames() == other.hasSheetNames() && Objects.equals(sheetNames(), other.sheetNames())
&& hasSheetIndexes() == other.hasSheetIndexes() && Objects.equals(sheetIndexes(), other.sheetIndexes())
&& Objects.equals(headerRow(), other.headerRow());
}
/**
* 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("ExcelOptions").add("SheetNames", hasSheetNames() ? sheetNames() : null)
.add("SheetIndexes", hasSheetIndexes() ? sheetIndexes() : null).add("HeaderRow", headerRow()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SheetNames":
return Optional.ofNullable(clazz.cast(sheetNames()));
case "SheetIndexes":
return Optional.ofNullable(clazz.cast(sheetIndexes()));
case "HeaderRow":
return Optional.ofNullable(clazz.cast(headerRow()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((ExcelOptions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* One or more named sheets in the Excel file that will be included in the dataset.
*
*
* @param sheetNames
* One or more named sheets in the Excel file that will be included in the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sheetNames(Collection sheetNames);
/**
*
* One or more named sheets in the Excel file that will be included in the dataset.
*
*
* @param sheetNames
* One or more named sheets in the Excel file that will be included in the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sheetNames(String... sheetNames);
/**
*
* One or more sheet numbers in the Excel file that will be included in the dataset.
*
*
* @param sheetIndexes
* One or more sheet numbers in the Excel file that will be included in the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sheetIndexes(Collection sheetIndexes);
/**
*
* One or more sheet numbers in the Excel file that will be included in the dataset.
*
*
* @param sheetIndexes
* One or more sheet numbers in the Excel file that will be included in the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sheetIndexes(Integer... sheetIndexes);
/**
*
* A variable that specifies whether the first row in the file is parsed as the header. If this value is false,
* column names are auto-generated.
*
*
* @param headerRow
* A variable that specifies whether the first row in the file is parsed as the header. If this value is
* false, column names are auto-generated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder headerRow(Boolean headerRow);
}
static final class BuilderImpl implements Builder {
private List sheetNames = DefaultSdkAutoConstructList.getInstance();
private List sheetIndexes = DefaultSdkAutoConstructList.getInstance();
private Boolean headerRow;
private BuilderImpl() {
}
private BuilderImpl(ExcelOptions model) {
sheetNames(model.sheetNames);
sheetIndexes(model.sheetIndexes);
headerRow(model.headerRow);
}
public final Collection getSheetNames() {
if (sheetNames instanceof SdkAutoConstructList) {
return null;
}
return sheetNames;
}
public final void setSheetNames(Collection sheetNames) {
this.sheetNames = SheetNameListCopier.copy(sheetNames);
}
@Override
public final Builder sheetNames(Collection sheetNames) {
this.sheetNames = SheetNameListCopier.copy(sheetNames);
return this;
}
@Override
@SafeVarargs
public final Builder sheetNames(String... sheetNames) {
sheetNames(Arrays.asList(sheetNames));
return this;
}
public final Collection getSheetIndexes() {
if (sheetIndexes instanceof SdkAutoConstructList) {
return null;
}
return sheetIndexes;
}
public final void setSheetIndexes(Collection sheetIndexes) {
this.sheetIndexes = SheetIndexListCopier.copy(sheetIndexes);
}
@Override
public final Builder sheetIndexes(Collection sheetIndexes) {
this.sheetIndexes = SheetIndexListCopier.copy(sheetIndexes);
return this;
}
@Override
@SafeVarargs
public final Builder sheetIndexes(Integer... sheetIndexes) {
sheetIndexes(Arrays.asList(sheetIndexes));
return this;
}
public final Boolean getHeaderRow() {
return headerRow;
}
public final void setHeaderRow(Boolean headerRow) {
this.headerRow = headerRow;
}
@Override
public final Builder headerRow(Boolean headerRow) {
this.headerRow = headerRow;
return this;
}
@Override
public ExcelOptions build() {
return new ExcelOptions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}