com.amazonaws.services.kinesisanalytics.model.InputStartingPositionConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* Copyright 2017-2022 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 com.amazonaws.services.kinesisanalytics.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes the point at which the application reads from the streaming source.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InputStartingPositionConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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.
*
*
*
*/
private String 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.
*
*
*
*
* @param 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.
*
*
* @see InputStartingPosition
*/
public void setInputStartingPosition(String inputStartingPosition) {
this.inputStartingPosition = 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.
*
*
*
*
* @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 String getInputStartingPosition() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InputStartingPosition
*/
public InputStartingPositionConfiguration withInputStartingPosition(String inputStartingPosition) {
setInputStartingPosition(inputStartingPosition);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see InputStartingPosition
*/
public void setInputStartingPosition(InputStartingPosition inputStartingPosition) {
withInputStartingPosition(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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InputStartingPosition
*/
public InputStartingPositionConfiguration withInputStartingPosition(InputStartingPosition inputStartingPosition) {
this.inputStartingPosition = inputStartingPosition.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInputStartingPosition() != null)
sb.append("InputStartingPosition: ").append(getInputStartingPosition());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InputStartingPositionConfiguration == false)
return false;
InputStartingPositionConfiguration other = (InputStartingPositionConfiguration) obj;
if (other.getInputStartingPosition() == null ^ this.getInputStartingPosition() == null)
return false;
if (other.getInputStartingPosition() != null && other.getInputStartingPosition().equals(this.getInputStartingPosition()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInputStartingPosition() == null) ? 0 : getInputStartingPosition().hashCode());
return hashCode;
}
@Override
public InputStartingPositionConfiguration clone() {
try {
return (InputStartingPositionConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kinesisanalytics.model.transform.InputStartingPositionConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}