software.amazon.awssdk.services.firehose.model

Class CreateDeliveryStreamRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeliveryStreamRequest.Builder,CreateDeliveryStreamRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDeliveryStreamRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDeliveryStreamRequest.Builder	builder()
String	deliveryStreamName() The name of the delivery stream.
DeliveryStreamType	deliveryStreamType() The delivery stream type.
String	deliveryStreamTypeAsString() The delivery stream type.
ElasticsearchDestinationConfiguration	elasticsearchDestinationConfiguration() The destination in Amazon ES.
boolean	equals(Object obj)
ExtendedS3DestinationConfiguration	extendedS3DestinationConfiguration() The destination in Amazon S3.
<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()
KinesisStreamSourceConfiguration	kinesisStreamSourceConfiguration() When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
RedshiftDestinationConfiguration	redshiftDestinationConfiguration() The destination in Amazon Redshift.
S3DestinationConfiguration	s3DestinationConfiguration() [Deprecated] The destination in Amazon S3.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeliveryStreamRequest.Builder>	serializableBuilderClass()
SplunkDestinationConfiguration	splunkDestinationConfiguration() The destination in Splunk.
List<Tag>	tags() A set of tags to assign to the delivery stream.
CreateDeliveryStreamRequest.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

deliveryStreamName

public String deliveryStreamName()

The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.

Returns:

The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.

deliveryStreamType

public DeliveryStreamType deliveryStreamType()

The delivery stream type. This parameter can be one of the following values:

• DirectPut: Provider applications access the delivery stream directly.

• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

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

Returns:

The delivery stream type. This parameter can be one of the following values:

• DirectPut: Provider applications access the delivery stream directly.

• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

See Also:

DeliveryStreamType

deliveryStreamTypeAsString

public String deliveryStreamTypeAsString()

The delivery stream type. This parameter can be one of the following values:

• DirectPut: Provider applications access the delivery stream directly.

• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

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

Returns:

The delivery stream type. This parameter can be one of the following values:

• DirectPut: Provider applications access the delivery stream directly.

• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

See Also:

DeliveryStreamType

kinesisStreamSourceConfiguration

public KinesisStreamSourceConfiguration kinesisStreamSourceConfiguration()

When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

Returns:

When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

s3DestinationConfiguration

public S3DestinationConfiguration s3DestinationConfiguration()

[Deprecated] The destination in Amazon S3. You can specify only one destination.

Returns:

[Deprecated] The destination in Amazon S3. You can specify only one destination.

extendedS3DestinationConfiguration

public ExtendedS3DestinationConfiguration extendedS3DestinationConfiguration()

The destination in Amazon S3. You can specify only one destination.

Returns:

The destination in Amazon S3. You can specify only one destination.

redshiftDestinationConfiguration

public RedshiftDestinationConfiguration redshiftDestinationConfiguration()

The destination in Amazon Redshift. You can specify only one destination.

Returns:

The destination in Amazon Redshift. You can specify only one destination.

elasticsearchDestinationConfiguration

public ElasticsearchDestinationConfiguration elasticsearchDestinationConfiguration()

The destination in Amazon ES. You can specify only one destination.

Returns:

The destination in Amazon ES. You can specify only one destination.

splunkDestinationConfiguration

public SplunkDestinationConfiguration splunkDestinationConfiguration()

The destination in Splunk. You can specify only one destination.

Returns:

The destination in Splunk. You can specify only one destination.

tags

public List<Tag> tags()

A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a delivery stream.

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

Returns:

A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a delivery stream.

toBuilder

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

Specified by:

toBuilder in class FirehoseRequest

Returns:

a builder for type T

builder

public static CreateDeliveryStreamRequest.Builder builder()

serializableBuilderClass

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