Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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.kinesis.model;
 
 
Container for the parameters to the PutRecords operation.

Puts (writes) multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request). Use this operation to send data from a data producer into the Amazon Kinesis stream for real-time ingestion and processing. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.

You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records , with each record in the array requiring a partition key and data blob.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Partition Key in the Amazon Kinesis Developer Guide .

Each record in the Records array may include an optional parameter, ExplicitHashKey , which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Developer Guide .

The PutRecords response includes an array of response Records . Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.

The response Records array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.

A successfully-processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.

An unsuccessfully-processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure . ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled.

Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.

public class PutRecordsRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The records associated with the request.

Constraints:
Length: 1 - 500

The stream name associated with the request.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

    private String streamName;

    
The records associated with the request.

Constraints:
Length: 1 - 500

Returns:
The records associated with the request.
        if ( == null) {
              .setAutoConstruct(true);
        }
        return ;
    }
    
    
The records associated with the request.

Constraints:
Length: 1 - 500

Parameters:
records The records associated with the request.
    public void setRecords(java.util.Collection<PutRecordsRequestEntryrecords) {
        if (records == null) {
            this. = null;
            return;
        }
        recordsCopy.addAll(records);
        this. = recordsCopy;
    }
    
    
The records associated with the request.

NOTE: This method appends the values to the existing list (if any). Use setRecords(java.util.Collection) or withRecords(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 500

Parameters:
records The records associated with the request.
Returns:
A reference to this updated object so that method calls can be chained together.
        if (getRecords() == nullsetRecords(new java.util.ArrayList<PutRecordsRequestEntry>(records.length));
        for (PutRecordsRequestEntry value : records) {
            getRecords().add(value);
        }
        return this;
    }
    
    
The records associated with the request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 500

Parameters:
records The records associated with the request.
Returns:
A reference to this updated object so that method calls can be chained together.
        if (records == null) {
            this. = null;
        } else {
            recordsCopy.addAll(records);
            this. = recordsCopy;
        }
        return this;
    }

    
The stream name associated with the request.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Returns:
The stream name associated with the request.
    public String getStreamName() {
        return ;
    }
    
    
The stream name associated with the request.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:
streamName The stream name associated with the request.
    public void setStreamName(String streamName) {
        this. = streamName;
    }
    
    
The stream name associated with the request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:
streamName The stream name associated with the request.
Returns:
A reference to this updated object so that method calls can be chained together.
    public PutRecordsRequest withStreamName(String streamName) {
        this. = streamName;
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getRecords() != nullsb.append("Records: " + getRecords() + ",");
        if (getStreamName() != nullsb.append("StreamName: " + getStreamName() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getRecords() == null) ? 0 : getRecords().hashCode()); 
        hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof PutRecordsRequest == falsereturn false;
        PutRecordsRequest other = (PutRecordsRequest)obj;
        
        if (other.getRecords() == null ^ this.getRecords() == nullreturn false;
        if (other.getRecords() != null && other.getRecords().equals(this.getRecords()) == falsereturn false
        if (other.getStreamName() == null ^ this.getStreamName() == nullreturn false;
        if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == falsereturn false
        return true;
    }
    
    @Override
    public PutRecordsRequest clone() {
        
            return (PutRecordsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X