software.amazon.kinesis.retrieval.ConsumerRegistration 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 2018 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.retrieval;

import software.amazon.kinesis.leases.exceptions.DependencyException;

/**
 *
 */
public interface ConsumerRegistration {
    /**
     * This method is used to get or create StreamConsumer information from Kinesis. It returns the StreamConsumer ARN
     * after retrieving it.
     *
     * @return StreamConsumer ARN
     * @throws DependencyException
     */
    String getOrCreateStreamConsumerArn() throws DependencyException;
}