software.amazon.kinesis.lifecycle.ShutdownInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of amazon-kinesis-client Show documentation

The Amazon Kinesis Client Library for Java enables Java developers to easily consume and process data from Amazon Kinesis.

There is a newer version: 3.0.1

Show newest version

/*
 *  Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 *  Licensed under the Amazon Software License (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/asl/
 *
 *  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.kinesis.lifecycle;

import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;
import lombok.experimental.Accessors;
import software.amazon.kinesis.processor.ShardRecordProcessor;
import software.amazon.kinesis.processor.RecordProcessorCheckpointer;

/**
 * Container for the parameters to the IRecordProcessor's
 * {@link ShardRecordProcessor#shutdown(ShutdownInput
 * shutdownInput) shutdown} method.
 */
@Builder
@Getter
@Accessors(fluent = true)
@EqualsAndHashCode
@ToString
public class ShutdownInput {

    /**
     * Get shutdown reason.
     *
     * -- GETTER --
     * @return Reason for the shutdown (ShutdownReason.SHARD_END indicates the shard is closed and there are no
     *         more records to process. Shutdown.LEASE_LOST indicates a fail over has occurred).
     */
    private final ShutdownReason shutdownReason;

    /**
     * Get Checkpointer.
     *
     * -- GETTER --
     * @return The checkpointer object that the record processor should use to checkpoint
     */
    private final RecordProcessorCheckpointer checkpointer;

}