public class TagStreamRequest extends AmazonWebServiceRequest implements java.io.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.
Constructor and Description |
---|
TagStreamRequest() |
Modifier and Type | Method and Description |
---|---|
TagStreamRequest |
addTagsEntry(java.lang.String key,
java.lang.String value)
A list of tags to associate with the specified stream.
|
TagStreamRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getStreamARN()
The Amazon Resource Name (ARN) of the resource that you want to add the
tag or tags to.
|
java.lang.String |
getStreamName()
The name of the stream that you want to add the tag or tags to.
|
java.util.Map<java.lang.String,java.lang.String> |
getTags()
A list of tags to associate with the specified stream.
|
int |
hashCode() |
void |
setStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) of the resource that you want to add the
tag or tags to.
|
void |
setStreamName(java.lang.String streamName)
The name of the stream that you want to add the tag or tags to.
|
void |
setTags(java.util.Map<java.lang.String,java.lang.String> tags)
A list of tags to associate with the specified stream.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
TagStreamRequest |
withStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) of the resource that you want to add the
tag or tags to.
|
TagStreamRequest |
withStreamName(java.lang.String streamName)
The name of the stream that you want to add the tag or tags to.
|
TagStreamRequest |
withTags(java.util.Map<java.lang.String,java.lang.String> tags)
A list of tags to associate with the specified stream.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.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]+
The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
public void setStreamARN(java.lang.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]+
streamARN
- The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
public TagStreamRequest withStreamARN(java.lang.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]+
streamARN
- The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
public java.lang.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_.-]+
The name of the stream that you want to add the tag or tags to.
public void setStreamName(java.lang.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_.-]+
streamName
- The name of the stream that you want to add the tag or tags to.
public TagStreamRequest withStreamName(java.lang.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_.-]+
streamName
- The name of the stream that you want to add the tag or tags to.
public java.util.Map<java.lang.String,java.lang.String> getTags()
A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)
A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
tags
- A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
public TagStreamRequest withTags(java.util.Map<java.lang.String,java.lang.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.
tags
- A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
public TagStreamRequest addTagsEntry(java.lang.String key, java.lang.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.
key
- The key of the entry to be added into Tags.value
- The corresponding value of the entry to be added into Tags.public TagStreamRequest clearTagsEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.