com.amazonaws.services.kinesis.model

Class AddTagsToStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.AddTagsToStreamRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AddTagsToStreamRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the AddTagsToStream operation.

Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

See Also:

AmazonKinesis.addTagsToStream(AddTagsToStreamRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AddTagsToStreamRequest()

Method Summary

Methods

Modifier and Type	Method and Description
AddTagsToStreamRequest	addTagsEntry(String key, String value) The set of key-value pairs to use to create the tags.
AddTagsToStreamRequest	clearTagsEntries() Removes all the entries added into Tags.
AddTagsToStreamRequest	clone()
boolean	equals(Object obj)
String	getStreamName() The name of the stream.
Map<String,String>	getTags() The set of key-value pairs to use to create the tags.
int	hashCode()
void	setStreamName(String streamName) The name of the stream.
void	setTags(Map<String,String> tags) The set of key-value pairs to use to create the tags.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AddTagsToStreamRequest	withStreamName(String streamName) The name of the stream.
AddTagsToStreamRequest	withTags(Map<String,String> tags) The set of key-value pairs to use to create the tags.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AddTagsToStreamRequest

public AddTagsToStreamRequest()

Method Detail

getStreamName

public String getStreamName()

The name of the stream.

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

Returns:

The name of the stream.

setStreamName

public void setStreamName(String streamName)

The name of the stream.

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

Parameters:

streamName - The name of the stream.

withStreamName

public AddTagsToStreamRequest withStreamName(String streamName)

The name of the stream.

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 name of the stream.

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

The set of key-value pairs to use to create the tags.

Constraints:
Length: 1 - 10

Returns:

The set of key-value pairs to use to create the tags.

setTags

public void setTags(Map<String,String> tags)

The set of key-value pairs to use to create the tags.

Constraints:
Length: 1 - 10

Parameters:

tags - The set of key-value pairs to use to create the tags.

withTags

public AddTagsToStreamRequest withTags(Map<String,String> tags)

The set of key-value pairs to use to create the tags.

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

Constraints:
Length: 1 - 10

Parameters:

tags - The set of key-value pairs to use to create the tags.

Returns:

A reference to this updated object so that method calls can be chained together.

addTagsEntry

public AddTagsToStreamRequest addTagsEntry(String key,
                                  String value)

The set of key-value pairs to use to create the tags.

The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 10

Parameters:

key - The key of the entry to be added into Tags.

value - The corresponding value of the entry to be added into Tags.

clearTagsEntries

public AddTagsToStreamRequest clearTagsEntries()

Removes all the entries added into Tags.

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public AddTagsToStreamRequest clone()

Overrides:

clone in class AmazonWebServiceRequest