com.amazonaws.services.kinesisfirehose.AmazonKinesisFirehose Maven / Gradle / Ivy
Show all versions of aws-android-sdk-kinesis Show documentation
/*
* Copyright 2010-2016 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.kinesisfirehose;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.kinesisfirehose.model.*;
/**
* Interface for accessing AmazonKinesisFirehose.
* Amazon Kinesis Firehose API Reference
* Amazon Kinesis Firehose is a fully-managed service that delivers
* real-time streaming data to destinations such as Amazon S3 and Amazon
* Redshift.
*
*/
public interface AmazonKinesisFirehose {
/**
* Overrides the default endpoint for this client ("https://firehose.us-east-1.amazonaws.com").
* Callers can use this method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "firehose.us-east-1.amazonaws.com") or a full
* URL, including the protocol (ex: "https://firehose.us-east-1.amazonaws.com"). If the
* protocol is not specified here, the default protocol from this client's
* {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and
* a complete list of all available endpoints for all AWS services, see:
*
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
*
* This method is not threadsafe. An endpoint should be configured when the
* client is created and before any service requests are made. Changing it
* afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "firehose.us-east-1.amazonaws.com") or a full URL,
* including the protocol (ex: "https://firehose.us-east-1.amazonaws.com") of
* the region specific AWS endpoint this client will communicate
* with.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link AmazonKinesisFirehose#setEndpoint(String)}, sets the
* regional endpoint for this client's service calls. Callers can use this
* method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol.
* To use http instead, specify it in the {@link ClientConfiguration}
* supplied at construction.
*
* This method is not threadsafe. A region should be configured when the
* client is created and before any service requests are made. Changing it
* afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException
* If the given region is null, or if this service isn't
* available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
*
* Writes multiple data records into a delivery stream in a single call,
* which can achieve higher throughput per producer than when writing
* single records. To write single data records into a delivery stream,
* use PutRecord. Applications using these operations are referred to as
* producers.
*
*
* Each PutRecordBatch request supports up to 500 records. Each record
* in the request can be as large as 1,000 KB (before 64-bit encoding),
* up to a limit of 4 MB for the entire request. By default, each
* delivery stream can take in up to 2,000 transactions per second, 5,000
* records per second, or 5 MB per second. Note that if you use PutRecord
* and PutRecordBatch, the limits are an aggregate across these two
* operations for each delivery stream. For more information about limits
* and how to request an increase, see
* Amazon Kinesis Firehose Limits
* .
*
*
* You must specify the name of the delivery stream and the data record
* when using PutRecord. The data record consists of a data blob that can
* be up to 1,000 KB in size, and any kind of data, for example, a
* segment from a log file, geographic location data, web site
* clickstream data, and so on.
*
*
* Amazon Kinesis Firehose buffers records before delivering them to the
* destination. To disambiguate the data blobs at the destination, a
* common solution is to use delimiters in the data, such as a newline (
* \n ) or some other character unique within the data. This
* allows the consumer application(s) to parse individual data items when
* reading the data from the destination.
*
*
* The PutRecordBatch response includes a count of any failed records,
* FailedPutCount , and an array of responses,
* RequestResponses . The FailedPutCount value
* is a count of records that failed. Each entry in the
* RequestResponses array gives additional information of
* the processed record. Each entry in RequestResponses
* directly correlates with a record in the request array using the same
* ordering, from the top to the bottom of the request and response.
* RequestResponses always includes the same number of
* records as the request array. RequestResponses both
* successfully and unsuccessfully processed records. Amazon Kinesis
* Firehose attempts to process all records in each PutRecordBatch
* request. A single record failure does not stop the processing of
* subsequent records.
*
*
* A successfully processed record includes a RecordId
* value, which is a unique value identified for the record. An
* unsuccessfully processed record includes ErrorCode and
* ErrorMessage values. ErrorCode reflects the
* type of error and is one of the following values:
* ServiceUnavailable or InternalFailure .
* ErrorMessage provides more detailed information about the
* error.
*
*
* If FailedPutCount is greater than 0 (zero), retry the
* request. A retry of the entire batch of records is possible; however,
* we strongly recommend that you inspect the entire response and resend
* only those records that failed processing. This minimizes duplicate
* records and also reduces the total bytes sent (and corresponding
* charges).
*
*
* If the PutRecordBatch operation throws a
* ServiceUnavailableException , back off and retry. If the
* exception persists, it is possible that the throughput limits have
* been exceeded for the delivery stream.
*
*
* Data records sent to Amazon Kinesis Firehose are stored for 24 hours
* from the time they are added to a delivery stream as it attempts to
* send the records to the destination. If the destination is unreachable
* for more than 24 hours, the data is no longer available.
*
*
* @param putRecordBatchRequest Container for the necessary parameters to
* execute the PutRecordBatch service method on AmazonKinesisFirehose.
*
* @return The response from the PutRecordBatch service method, as
* returned by AmazonKinesisFirehose.
*
* @throws InvalidArgumentException
* @throws ResourceNotFoundException
* @throws ServiceUnavailableException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonKinesisFirehose indicating
* either a problem with the data in the request, or a server side issue.
*/
public PutRecordBatchResult putRecordBatch(PutRecordBatchRequest putRecordBatchRequest)
throws AmazonServiceException, AmazonClientException;
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
public void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for
* debugging issues where a service isn't acting as expected. This data isn't considered part
* of the result data returned by an operation, so it's available through this separate,
* diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access
* this extra diagnostic information for an executed request, you should use this method
* to retrieve it as soon as possible after executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}