Package software.amazon.awssdk.services.firehose.model

Class DeleteDeliveryStreamRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.firehose.model.FirehoseRequest

software.amazon.awssdk.services.firehose.model.DeleteDeliveryStreamRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteDeliveryStreamRequest.Builder,DeleteDeliveryStreamRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteDeliveryStreamRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allowForceDelete()	Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK.
static DeleteDeliveryStreamRequest.Builder	builder()
String	deliveryStreamName()	The name of the delivery stream.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteDeliveryStreamRequest.Builder>	serializableBuilderClass()
DeleteDeliveryStreamRequest.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

deliveryStreamName

public final String deliveryStreamName()

The name of the delivery stream.

Returns:

The name of the delivery stream.

allowForceDelete

public final Boolean allowForceDelete()

Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Kinesis Data Firehose keeps retrying the delete operation.

The default value is false.

Returns:

Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Kinesis Data Firehose keeps retrying the delete operation.

The default value is false.

toBuilder

public DeleteDeliveryStreamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteDeliveryStreamRequest.Builder,DeleteDeliveryStreamRequest>

Specified by:

toBuilder in class FirehoseRequest

builder

public static DeleteDeliveryStreamRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteDeliveryStreamRequest.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