TagStreamRequest (AWS SDK for Android - Amazon Kinesis Video Streams 2.16.5 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesisvideo.model.TagStreamRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class TagStreamRequest
extends AmazonWebServiceRequest
implements Serializable
```
Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

Kinesis video streams support up to 50 tags.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TagStreamRequest()

Constructors
Constructor and Description
`TagStreamRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TagStreamRequest`	`addTagsEntry(String key, String value)` A list of tags to associate with the specified stream.
`TagStreamRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`boolean`	`equals(Object obj)`
`String`	`getStreamARN()` The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
`String`	`getStreamName()` The name of the stream that you want to add the tag or tags to.
`Map<String,String>`	`getTags()` A list of tags to associate with the specified stream.
`int`	`hashCode()`
`void`	`setStreamARN(String streamARN)` The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
`void`	`setStreamName(String streamName)` The name of the stream that you want to add the tag or tags to.
`void`	`setTags(Map<String,String> tags)` A list of tags to associate with the specified stream.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TagStreamRequest`	`withStreamARN(String streamARN)` The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
`TagStreamRequest`	`withStreamName(String streamName)` The name of the stream that you want to add the tag or tags to.
`TagStreamRequest`	`withTags(Map<String,String> tags)` A list of tags to associate with the specified stream.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TagStreamRequest
```
public TagStreamRequest()
```
- Method Detail
  - getStreamARN
```
public String getStreamARN()
```
    The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
    
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
  - setStreamARN
```
public void setStreamARN(String streamARN)
```
    The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
    
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Parameters:
    
    streamARN -
    The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
  - withStreamARN
```
public TagStreamRequest withStreamARN(String streamARN)
```
    The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Parameters:
    
    streamARN -
    The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStreamName
```
public String getStreamName()
```
    The name of the stream that you want to add the tag or tags to.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The name of the stream that you want to add the tag or tags to.
  - setStreamName
```
public void setStreamName(String streamName)
```
    The name of the stream that you want to add the tag or tags to.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the stream that you want to add the tag or tags to.
  - withStreamName
```
public TagStreamRequest withStreamName(String streamName)
```
    The name of the stream that you want to add the tag or tags to.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the stream that you want to add the tag or tags to.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
    
    Returns:
    
    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
  - setTags
```
public void setTags(Map<String,String> tags)
```
    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
    
    Parameters:
    
    tags -
    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
  - withTags
```
public TagStreamRequest withTags(Map<String,String> tags)
```
    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addTagsEntry
```
public TagStreamRequest addTagsEntry(String key,
                                     String value)
```
    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
    
    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.
    
    Parameters:
    
    key - The key of the entry to be added into Tags.
    
    value - The corresponding value of the entry to be added into Tags.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearTagsEntries
```
public TagStreamRequest 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

Class TagStreamRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

TagStreamRequest

Method Detail

getStreamARN

setStreamARN

withStreamARN

getStreamName

setStreamName

withStreamName

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

hashCode

equals