software.amazon.awssdk.services.kinesis.model.SubscribeToShardEvent Maven / Gradle / Ivy
Show all versions of kinesis 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.kinesis.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.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;
/**
*
* After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to
* your consumer.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class SubscribeToShardEvent implements SdkPojo, Serializable,
ToCopyableBuilder, SubscribeToShardEventStream {
private static final SdkField> RECORDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Records")
.getter(getter(SubscribeToShardEvent::records))
.setter(setter(Builder::records))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Records").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Record::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CONTINUATION_SEQUENCE_NUMBER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContinuationSequenceNumber")
.getter(getter(SubscribeToShardEvent::continuationSequenceNumber))
.setter(setter(Builder::continuationSequenceNumber))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContinuationSequenceNumber").build())
.build();
private static final SdkField MILLIS_BEHIND_LATEST_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("MillisBehindLatest").getter(getter(SubscribeToShardEvent::millisBehindLatest))
.setter(setter(Builder::millisBehindLatest))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MillisBehindLatest").build())
.build();
private static final SdkField> CHILD_SHARDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ChildShards")
.getter(getter(SubscribeToShardEvent::childShards))
.setter(setter(Builder::childShards))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChildShards").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ChildShard::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RECORDS_FIELD,
CONTINUATION_SEQUENCE_NUMBER_FIELD, MILLIS_BEHIND_LATEST_FIELD, CHILD_SHARDS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Records", RECORDS_FIELD);
put("ContinuationSequenceNumber", CONTINUATION_SEQUENCE_NUMBER_FIELD);
put("MillisBehindLatest", MILLIS_BEHIND_LATEST_FIELD);
put("ChildShards", CHILD_SHARDS_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final List records;
private final String continuationSequenceNumber;
private final Long millisBehindLatest;
private final List childShards;
protected SubscribeToShardEvent(BuilderImpl builder) {
this.records = builder.records;
this.continuationSequenceNumber = builder.continuationSequenceNumber;
this.millisBehindLatest = builder.millisBehindLatest;
this.childShards = builder.childShards;
}
/**
* For responses, this returns true if the service returned a value for the Records 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 hasRecords() {
return records != null && !(records instanceof SdkAutoConstructList);
}
/**
*
*
* 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 #hasRecords} method.
*
*
* @return
*/
public final List records() {
return records;
}
/**
*
* Use this as SequenceNumber in the next call to SubscribeToShard, with
* StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use
* ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no
* data is written to the shard.
*
*
* @return Use this as SequenceNumber in the next call to SubscribeToShard, with
* StartingPosition set to AT_SEQUENCE_NUMBER or
* AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because
* it captures your shard progress even when no data is written to the shard.
*/
public final String continuationSequenceNumber() {
return continuationSequenceNumber;
}
/**
*
* The number of milliseconds the read records are from the tip of the stream, indicating how far behind current
* time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records
* to process at this moment.
*
*
* @return The number of milliseconds the read records are from the tip of the stream, indicating how far behind
* current time the consumer is. A value of zero indicates that record processing is caught up, and there
* are no new records to process at this moment.
*/
public final Long millisBehindLatest() {
return millisBehindLatest;
}
/**
* For responses, this returns true if the service returned a value for the ChildShards 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 hasChildShards() {
return childShards != null && !(childShards instanceof SdkAutoConstructList);
}
/**
*
* The list of the child shards of the current shard, returned only at the end of the current shard.
*
*
* 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 #hasChildShards} method.
*
*
* @return The list of the child shards of the current shard, returned only at the end of the current shard.
*/
public final List childShards() {
return childShards;
}
@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(hasRecords() ? records() : null);
hashCode = 31 * hashCode + Objects.hashCode(continuationSequenceNumber());
hashCode = 31 * hashCode + Objects.hashCode(millisBehindLatest());
hashCode = 31 * hashCode + Objects.hashCode(hasChildShards() ? childShards() : 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 SubscribeToShardEvent)) {
return false;
}
SubscribeToShardEvent other = (SubscribeToShardEvent) obj;
return hasRecords() == other.hasRecords() && Objects.equals(records(), other.records())
&& Objects.equals(continuationSequenceNumber(), other.continuationSequenceNumber())
&& Objects.equals(millisBehindLatest(), other.millisBehindLatest()) && hasChildShards() == other.hasChildShards()
&& Objects.equals(childShards(), other.childShards());
}
/**
* 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("SubscribeToShardEvent").add("Records", hasRecords() ? records() : null)
.add("ContinuationSequenceNumber", continuationSequenceNumber()).add("MillisBehindLatest", millisBehindLatest())
.add("ChildShards", hasChildShards() ? childShards() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Records":
return Optional.ofNullable(clazz.cast(records()));
case "ContinuationSequenceNumber":
return Optional.ofNullable(clazz.cast(continuationSequenceNumber()));
case "MillisBehindLatest":
return Optional.ofNullable(clazz.cast(millisBehindLatest()));
case "ChildShards":
return Optional.ofNullable(clazz.cast(childShards()));
default:
return Optional.empty();
}
}
@Override
public final SubscribeToShardEvent copy(Consumer modifier) {
return ToCopyableBuilder.super.copy(modifier);
}
@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((SubscribeToShardEvent) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
@Override
public SubscribeToShardEventStream.EventType sdkEventType() {
return SubscribeToShardEventStream.EventType.SUBSCRIBE_TO_SHARD_EVENT;
}
/**
* Calls the appropriate visit method depending on the subtype of {@link SubscribeToShardEvent}.
*
* @param visitor
* Visitor to invoke.
*/
@Override
public void accept(SubscribeToShardResponseHandler.Visitor visitor) {
visitor.visit(this);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
*
* @param records
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder records(Collection records);
/**
*
*
* @param records
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder records(Record... records);
/**
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.kinesis.model.Record.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.kinesis.model.Record#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.kinesis.model.Record.Builder#build()} is called immediately and its
* result is passed to {@link #records(List)}.
*
* @param records
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.kinesis.model.Record.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #records(java.util.Collection)
*/
Builder records(Consumer... records);
/**
*
* Use this as SequenceNumber in the next call to SubscribeToShard, with
* StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.
* Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even
* when no data is written to the shard.
*
*
* @param continuationSequenceNumber
* Use this as SequenceNumber in the next call to SubscribeToShard, with
* StartingPosition set to AT_SEQUENCE_NUMBER or
* AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing
* because it captures your shard progress even when no data is written to the shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder continuationSequenceNumber(String continuationSequenceNumber);
/**
*
* The number of milliseconds the read records are from the tip of the stream, indicating how far behind current
* time the consumer is. A value of zero indicates that record processing is caught up, and there are no new
* records to process at this moment.
*
*
* @param millisBehindLatest
* The number of milliseconds the read records are from the tip of the stream, indicating how far behind
* current time the consumer is. A value of zero indicates that record processing is caught up, and there
* are no new records to process at this moment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder millisBehindLatest(Long millisBehindLatest);
/**
*
* The list of the child shards of the current shard, returned only at the end of the current shard.
*
*
* @param childShards
* The list of the child shards of the current shard, returned only at the end of the current shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder childShards(Collection childShards);
/**
*
* The list of the child shards of the current shard, returned only at the end of the current shard.
*
*
* @param childShards
* The list of the child shards of the current shard, returned only at the end of the current shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder childShards(ChildShard... childShards);
/**
*
* The list of the child shards of the current shard, returned only at the end of the current shard.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.kinesis.model.ChildShard.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.kinesis.model.ChildShard#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.kinesis.model.ChildShard.Builder#build()} is called immediately and
* its result is passed to {@link #childShards(List)}.
*
* @param childShards
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.kinesis.model.ChildShard.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #childShards(java.util.Collection)
*/
Builder childShards(Consumer... childShards);
}
protected static class BuilderImpl implements Builder {
private List records = DefaultSdkAutoConstructList.getInstance();
private String continuationSequenceNumber;
private Long millisBehindLatest;
private List childShards = DefaultSdkAutoConstructList.getInstance();
protected BuilderImpl() {
}
protected BuilderImpl(SubscribeToShardEvent model) {
records(model.records);
continuationSequenceNumber(model.continuationSequenceNumber);
millisBehindLatest(model.millisBehindLatest);
childShards(model.childShards);
}
public final List getRecords() {
List result = RecordListCopier.copyToBuilder(this.records);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRecords(Collection records) {
this.records = RecordListCopier.copyFromBuilder(records);
}
@Override
public final Builder records(Collection records) {
this.records = RecordListCopier.copy(records);
return this;
}
@Override
@SafeVarargs
public final Builder records(Record... records) {
records(Arrays.asList(records));
return this;
}
@Override
@SafeVarargs
public final Builder records(Consumer... records) {
records(Stream.of(records).map(c -> Record.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getContinuationSequenceNumber() {
return continuationSequenceNumber;
}
public final void setContinuationSequenceNumber(String continuationSequenceNumber) {
this.continuationSequenceNumber = continuationSequenceNumber;
}
@Override
public final Builder continuationSequenceNumber(String continuationSequenceNumber) {
this.continuationSequenceNumber = continuationSequenceNumber;
return this;
}
public final Long getMillisBehindLatest() {
return millisBehindLatest;
}
public final void setMillisBehindLatest(Long millisBehindLatest) {
this.millisBehindLatest = millisBehindLatest;
}
@Override
public final Builder millisBehindLatest(Long millisBehindLatest) {
this.millisBehindLatest = millisBehindLatest;
return this;
}
public final List getChildShards() {
List result = ChildShardListCopier.copyToBuilder(this.childShards);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setChildShards(Collection childShards) {
this.childShards = ChildShardListCopier.copyFromBuilder(childShards);
}
@Override
public final Builder childShards(Collection childShards) {
this.childShards = ChildShardListCopier.copy(childShards);
return this;
}
@Override
@SafeVarargs
public final Builder childShards(ChildShard... childShards) {
childShards(Arrays.asList(childShards));
return this;
}
@Override
@SafeVarargs
public final Builder childShards(Consumer... childShards) {
childShards(Stream.of(childShards).map(c -> ChildShard.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public SubscribeToShardEvent build() {
return new SubscribeToShardEvent(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}