software.amazon.kinesis.retrieval.RecordsRetrieved 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 2019 Amazon.com, Inc. or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.retrieval;

import software.amazon.kinesis.lifecycle.events.ProcessRecordsInput;

public interface RecordsRetrieved {

    /**
     * Retrieves the records that have been received via one of the publishers
     * 
     * @return the processRecordsInput received
     */
    ProcessRecordsInput processRecordsInput();

    /**
     * Returns the identifier that uniquely identifies this batch.
     *
     * @return batchUniqueIdentifier that uniquely identifies the records batch and its source.
     */
    default BatchUniqueIdentifier batchUniqueIdentifier() {
        throw new UnsupportedOperationException("Retrieval of batch unique identifier is not supported");
    }
}