software.amazon.awssdk.services.kinesisanalytics.model.InputStartingPositionConfiguration 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.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;
/**
*
* Describes the point at which the application reads from the streaming source.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class InputStartingPositionConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField INPUT_STARTING_POSITION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InputStartingPosition")
.getter(getter(InputStartingPositionConfiguration::inputStartingPositionAsString))
.setter(setter(Builder::inputStartingPosition))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InputStartingPosition").build())
.build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(INPUT_STARTING_POSITION_FIELD));
private static final long serialVersionUID = 1L;
private final String inputStartingPosition;
private InputStartingPositionConfiguration(BuilderImpl builder) {
this.inputStartingPosition = builder.inputStartingPosition;
}
/**
*
* The starting position on the stream.
*
*
* -
*
* NOW
- Start reading just after the most recent record in the stream, start at the request time stamp
* that the customer issued.
*
*
* -
*
* TRIM_HORIZON
- Start reading at the last untrimmed record in the stream, which is the oldest record
* available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.
*
*
* -
*
* LAST_STOPPED_POINT
- Resume reading from where the application last stopped reading.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #inputStartingPosition} will return {@link InputStartingPosition#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #inputStartingPositionAsString}.
*
*
* @return The starting position on the stream.
*
* -
*
* NOW
- Start reading just after the most recent record in the stream, start at the request
* time stamp that the customer issued.
*
*
* -
*
* TRIM_HORIZON
- Start reading at the last untrimmed record in the stream, which is the oldest
* record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery
* stream.
*
*
* -
*
* LAST_STOPPED_POINT
- Resume reading from where the application last stopped reading.
*
*
* @see InputStartingPosition
*/
public final InputStartingPosition inputStartingPosition() {
return InputStartingPosition.fromValue(inputStartingPosition);
}
/**
*
* The starting position on the stream.
*
*
* -
*
* NOW
- Start reading just after the most recent record in the stream, start at the request time stamp
* that the customer issued.
*
*
* -
*
* TRIM_HORIZON
- Start reading at the last untrimmed record in the stream, which is the oldest record
* available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.
*
*
* -
*
* LAST_STOPPED_POINT
- Resume reading from where the application last stopped reading.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #inputStartingPosition} will return {@link InputStartingPosition#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #inputStartingPositionAsString}.
*
*
* @return The starting position on the stream.
*
* -
*
* NOW
- Start reading just after the most recent record in the stream, start at the request
* time stamp that the customer issued.
*
*
* -
*
* TRIM_HORIZON
- Start reading at the last untrimmed record in the stream, which is the oldest
* record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery
* stream.
*
*
* -
*
* LAST_STOPPED_POINT
- Resume reading from where the application last stopped reading.
*
*
* @see InputStartingPosition
*/
public final String inputStartingPositionAsString() {
return inputStartingPosition;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(inputStartingPositionAsString());
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 InputStartingPositionConfiguration)) {
return false;
}
InputStartingPositionConfiguration other = (InputStartingPositionConfiguration) obj;
return Objects.equals(inputStartingPositionAsString(), other.inputStartingPositionAsString());
}
/**
* 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("InputStartingPositionConfiguration")
.add("InputStartingPosition", inputStartingPositionAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InputStartingPosition":
return Optional.ofNullable(clazz.cast(inputStartingPositionAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function