software.amazon.awssdk.services.kinesisvideo.model

Class DeleteStreamRequest

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.DeleteStreamRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteStreamRequest.Builder,DeleteStreamRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeleteStreamRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DeleteStreamRequest.Builder	builder()
String	currentVersion() Optional: The version of the stream that you want to delete.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteStreamRequest.Builder>	serializableBuilderClass()
String	streamARN() The Amazon Resource Name (ARN) of the stream that you want to delete.
DeleteStreamRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

streamARN

public String streamARN()

The Amazon Resource Name (ARN) of the stream that you want to delete.

Returns:

The Amazon Resource Name (ARN) of the stream that you want to delete.

currentVersion

public String currentVersion()

Optional: The version of the stream that you want to delete.

Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.

If not specified, only the CreationTime is checked before deleting the stream.

Returns:

Optional: The version of the stream that you want to delete.

Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.

If not specified, only the CreationTime is checked before deleting the stream.

toBuilder

public DeleteStreamRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteStreamRequest.Builder,DeleteStreamRequest>

Specified by:

toBuilder in class KinesisVideoRequest

Returns:

a builder for type T

builder

public static DeleteStreamRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.