Package software.amazon.awssdk.services.kinesisvideo.model

Class TagStreamRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoRequest

software.amazon.awssdk.services.kinesisvideo.model.TagStreamRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TagStreamRequest.Builder,TagStreamRequest>

@Generated("software.amazon.awssdk:codegen")
public final class TagStreamRequest
extends KinesisVideoRequest
implements ToCopyableBuilder<TagStreamRequest.Builder,TagStreamRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TagStreamRequest.Builder

Method Summary

Modifier and Type	Method	Description
static TagStreamRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TagStreamRequest.Builder>	serializableBuilderClass()
String	streamARN()	The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
String	streamName()	The name of the stream that you want to add the tag or tags to.
Map<String,String>	tags()	A list of tags to associate with the specified stream.
TagStreamRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamARN

public final String streamARN()

The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

Returns:

The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

streamName

public final String streamName()

The name of the stream that you want to add the tag or tags to.

Returns:

The name of the stream that you want to add the tag or tags to.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final 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).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

toBuilder

public TagStreamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TagStreamRequest.Builder,TagStreamRequest>

Specified by:

toBuilder in class KinesisVideoRequest

builder

public static TagStreamRequest.Builder builder()

serializableBuilderClass

public static Class<? extends TagStreamRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo