software.amazon.awssdk.services.kinesisanalytics.model.SourceSchema Maven / Gradle / Ivy
Show all versions of kinesisanalytics 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.kinesisanalytics.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.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 format of the data in the streaming source, and how each data element maps to corresponding columns
* created in the in-application stream.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SourceSchema implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField RECORD_FORMAT_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("RecordFormat").getter(getter(SourceSchema::recordFormat)).setter(setter(Builder::recordFormat))
.constructor(RecordFormat::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecordFormat").build()).build();
private static final SdkField RECORD_ENCODING_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RecordEncoding").getter(getter(SourceSchema::recordEncoding)).setter(setter(Builder::recordEncoding))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecordEncoding").build()).build();
private static final SdkField> RECORD_COLUMNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("RecordColumns")
.getter(getter(SourceSchema::recordColumns))
.setter(setter(Builder::recordColumns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecordColumns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RecordColumn::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RECORD_FORMAT_FIELD,
RECORD_ENCODING_FIELD, RECORD_COLUMNS_FIELD));
private static final long serialVersionUID = 1L;
private final RecordFormat recordFormat;
private final String recordEncoding;
private final List recordColumns;
private SourceSchema(BuilderImpl builder) {
this.recordFormat = builder.recordFormat;
this.recordEncoding = builder.recordEncoding;
this.recordColumns = builder.recordColumns;
}
/**
*
* Specifies the format of the records on the streaming source.
*
*
* @return Specifies the format of the records on the streaming source.
*/
public final RecordFormat recordFormat() {
return recordFormat;
}
/**
*
* Specifies the encoding of the records in the streaming source. For example, UTF-8.
*
*
* @return Specifies the encoding of the records in the streaming source. For example, UTF-8.
*/
public final String recordEncoding() {
return recordEncoding;
}
/**
* For responses, this returns true if the service returned a value for the RecordColumns 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 hasRecordColumns() {
return recordColumns != null && !(recordColumns instanceof SdkAutoConstructList);
}
/**
*
* A list of RecordColumn objects.
*
*
* 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 #hasRecordColumns} method.
*
*
* @return A list of RecordColumn objects.
*/
public final List recordColumns() {
return recordColumns;
}
@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(recordFormat());
hashCode = 31 * hashCode + Objects.hashCode(recordEncoding());
hashCode = 31 * hashCode + Objects.hashCode(hasRecordColumns() ? recordColumns() : 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 SourceSchema)) {
return false;
}
SourceSchema other = (SourceSchema) obj;
return Objects.equals(recordFormat(), other.recordFormat()) && Objects.equals(recordEncoding(), other.recordEncoding())
&& hasRecordColumns() == other.hasRecordColumns() && Objects.equals(recordColumns(), other.recordColumns());
}
/**
* 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("SourceSchema").add("RecordFormat", recordFormat()).add("RecordEncoding", recordEncoding())
.add("RecordColumns", hasRecordColumns() ? recordColumns() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RecordFormat":
return Optional.ofNullable(clazz.cast(recordFormat()));
case "RecordEncoding":
return Optional.ofNullable(clazz.cast(recordEncoding()));
case "RecordColumns":
return Optional.ofNullable(clazz.cast(recordColumns()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SourceSchema) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Specifies the format of the records on the streaming source.
*
*
* @param recordFormat
* Specifies the format of the records on the streaming source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recordFormat(RecordFormat recordFormat);
/**
*
* Specifies the format of the records on the streaming source.
*
* This is a convenience method that creates an instance of the {@link RecordFormat.Builder} avoiding the need
* to create one manually via {@link RecordFormat#builder()}.
*
*
* When the {@link Consumer} completes, {@link RecordFormat.Builder#build()} is called immediately and its
* result is passed to {@link #recordFormat(RecordFormat)}.
*
* @param recordFormat
* a consumer that will call methods on {@link RecordFormat.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #recordFormat(RecordFormat)
*/
default Builder recordFormat(Consumer recordFormat) {
return recordFormat(RecordFormat.builder().applyMutation(recordFormat).build());
}
/**
*
* Specifies the encoding of the records in the streaming source. For example, UTF-8.
*
*
* @param recordEncoding
* Specifies the encoding of the records in the streaming source. For example, UTF-8.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recordEncoding(String recordEncoding);
/**
*
* A list of RecordColumn objects.
*
*
* @param recordColumns
* A list of RecordColumn objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recordColumns(Collection recordColumns);
/**
*
* A list of RecordColumn objects.
*
*
* @param recordColumns
* A list of RecordColumn objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recordColumns(RecordColumn... recordColumns);
/**
*
* A list of RecordColumn objects.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.kinesisanalytics.model.RecordColumn.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.kinesisanalytics.model.RecordColumn#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.kinesisanalytics.model.RecordColumn.Builder#build()} is called
* immediately and its result is passed to {@link #recordColumns(List)}.
*
* @param recordColumns
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.kinesisanalytics.model.RecordColumn.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #recordColumns(java.util.Collection)
*/
Builder recordColumns(Consumer... recordColumns);
}
static final class BuilderImpl implements Builder {
private RecordFormat recordFormat;
private String recordEncoding;
private List recordColumns = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SourceSchema model) {
recordFormat(model.recordFormat);
recordEncoding(model.recordEncoding);
recordColumns(model.recordColumns);
}
public final RecordFormat.Builder getRecordFormat() {
return recordFormat != null ? recordFormat.toBuilder() : null;
}
public final void setRecordFormat(RecordFormat.BuilderImpl recordFormat) {
this.recordFormat = recordFormat != null ? recordFormat.build() : null;
}
@Override
public final Builder recordFormat(RecordFormat recordFormat) {
this.recordFormat = recordFormat;
return this;
}
public final String getRecordEncoding() {
return recordEncoding;
}
public final void setRecordEncoding(String recordEncoding) {
this.recordEncoding = recordEncoding;
}
@Override
public final Builder recordEncoding(String recordEncoding) {
this.recordEncoding = recordEncoding;
return this;
}
public final List getRecordColumns() {
List result = RecordColumnsCopier.copyToBuilder(this.recordColumns);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRecordColumns(Collection recordColumns) {
this.recordColumns = RecordColumnsCopier.copyFromBuilder(recordColumns);
}
@Override
public final Builder recordColumns(Collection recordColumns) {
this.recordColumns = RecordColumnsCopier.copy(recordColumns);
return this;
}
@Override
@SafeVarargs
public final Builder recordColumns(RecordColumn... recordColumns) {
recordColumns(Arrays.asList(recordColumns));
return this;
}
@Override
@SafeVarargs
public final Builder recordColumns(Consumer... recordColumns) {
recordColumns(Stream.of(recordColumns).map(c -> RecordColumn.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public SourceSchema build() {
return new SourceSchema(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}