software.amazon.awssdk.services.kinesis.model

Class StopStreamEncryptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesis.model.KinesisRequest

software.amazon.awssdk.services.kinesis.model.StopStreamEncryptionRequest

All Implemented Interfaces:

ToCopyableBuilder<StopStreamEncryptionRequest.Builder,StopStreamEncryptionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StopStreamEncryptionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StopStreamEncryptionRequest.Builder	builder()
EncryptionType	encryptionType() The encryption type.
String	encryptionTypeAsString() The encryption type.
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()
String	keyId() The GUID for the customer-managed KMS key to use for encryption.
static Class<? extends StopStreamEncryptionRequest.Builder>	serializableBuilderClass()
String	streamName() The name of the stream on which to stop encrypting records.
StopStreamEncryptionRequest.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

streamName

public String streamName()

The name of the stream on which to stop encrypting records.

Returns:

The name of the stream on which to stop encrypting records.

encryptionType

public EncryptionType encryptionType()

The encryption type. The only valid value is KMS.

If the service returns an enum value that is not available in the current SDK version, encryptionType will return EncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().

Returns:

The encryption type. The only valid value is KMS.

See Also:

EncryptionType

encryptionTypeAsString

public String encryptionTypeAsString()

The encryption type. The only valid value is KMS.

If the service returns an enum value that is not available in the current SDK version, encryptionType will return EncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().

Returns:

The encryption type. The only valid value is KMS.

See Also:

EncryptionType

keyId

public String keyId()

The GUID for the customer-managed KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Streams by specifying the alias aws/kinesis.

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally unique key ID example: 12345678-1234-1234-1234-123456789012

• Alias name example: alias/MyAliasName

• Master key owned by Kinesis Streams: alias/aws/kinesis

Returns:

The GUID for the customer-managed KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Streams by specifying the alias aws/kinesis.

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally unique key ID example: 12345678-1234-1234-1234-123456789012

• Alias name example: alias/MyAliasName

• Master key owned by Kinesis Streams: alias/aws/kinesis

toBuilder

public StopStreamEncryptionRequest.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<StopStreamEncryptionRequest.Builder,StopStreamEncryptionRequest>

Specified by:

toBuilder in class KinesisRequest

Returns:

a builder for type T

builder

public static StopStreamEncryptionRequest.Builder builder()

serializableBuilderClass

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