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

Interface AmazonopensearchserviceDestinationDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AmazonopensearchserviceDestinationDescription.Builder,AmazonopensearchserviceDestinationDescription>, SdkBuilder<AmazonopensearchserviceDestinationDescription.Builder,AmazonopensearchserviceDestinationDescription>, SdkPojo

Enclosing class:

AmazonopensearchserviceDestinationDescription

public static interface AmazonopensearchserviceDestinationDescription.Builder
extends SdkPojo, CopyableBuilder<AmazonopensearchserviceDestinationDescription.Builder,AmazonopensearchserviceDestinationDescription>

Method Summary

Modifier and Type	Method	Description
default AmazonopensearchserviceDestinationDescription.Builder	bufferingHints(Consumer<AmazonopensearchserviceBufferingHints.Builder> bufferingHints)	The buffering options.
AmazonopensearchserviceDestinationDescription.Builder	bufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)	The buffering options.
default AmazonopensearchserviceDestinationDescription.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	Sets the value of the CloudWatchLoggingOptions property for this object.
AmazonopensearchserviceDestinationDescription.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	Sets the value of the CloudWatchLoggingOptions property for this object.
AmazonopensearchserviceDestinationDescription.Builder	clusterEndpoint(String clusterEndpoint)	The endpoint to use when communicating with the cluster.
default AmazonopensearchserviceDestinationDescription.Builder	documentIdOptions(Consumer<DocumentIdOptions.Builder> documentIdOptions)	Indicates the method for setting up document ID.
AmazonopensearchserviceDestinationDescription.Builder	documentIdOptions(DocumentIdOptions documentIdOptions)	Indicates the method for setting up document ID.
AmazonopensearchserviceDestinationDescription.Builder	domainARN(String domainARN)	The ARN of the Amazon OpenSearch Service domain.
AmazonopensearchserviceDestinationDescription.Builder	indexName(String indexName)	The Amazon OpenSearch Service index name.
AmazonopensearchserviceDestinationDescription.Builder	indexRotationPeriod(String indexRotationPeriod)	The Amazon OpenSearch Service index rotation period
AmazonopensearchserviceDestinationDescription.Builder	indexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)	The Amazon OpenSearch Service index rotation period
default AmazonopensearchserviceDestinationDescription.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	Sets the value of the ProcessingConfiguration property for this object.
AmazonopensearchserviceDestinationDescription.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	Sets the value of the ProcessingConfiguration property for this object.
default AmazonopensearchserviceDestinationDescription.Builder	retryOptions(Consumer<AmazonopensearchserviceRetryOptions.Builder> retryOptions)	The Amazon OpenSearch Service retry options.
AmazonopensearchserviceDestinationDescription.Builder	retryOptions(AmazonopensearchserviceRetryOptions retryOptions)	The Amazon OpenSearch Service retry options.
AmazonopensearchserviceDestinationDescription.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
AmazonopensearchserviceDestinationDescription.Builder	s3BackupMode(String s3BackupMode)	The Amazon S3 backup mode.
AmazonopensearchserviceDestinationDescription.Builder	s3BackupMode(AmazonopensearchserviceS3BackupMode s3BackupMode)	The Amazon S3 backup mode.
default AmazonopensearchserviceDestinationDescription.Builder	s3DestinationDescription(Consumer<S3DestinationDescription.Builder> s3DestinationDescription)	Sets the value of the S3DestinationDescription property for this object.
AmazonopensearchserviceDestinationDescription.Builder	s3DestinationDescription(S3DestinationDescription s3DestinationDescription)	Sets the value of the S3DestinationDescription property for this object.
AmazonopensearchserviceDestinationDescription.Builder	typeName(String typeName)	The Amazon OpenSearch Service type name.
default AmazonopensearchserviceDestinationDescription.Builder	vpcConfigurationDescription(Consumer<VpcConfigurationDescription.Builder> vpcConfigurationDescription)	Sets the value of the VpcConfigurationDescription property for this object.
AmazonopensearchserviceDestinationDescription.Builder	vpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)	Sets the value of the VpcConfigurationDescription property for this object.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

roleARN

AmazonopensearchserviceDestinationDescription.Builder roleARN(String roleARN)

The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

Parameters:

roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

Returns:

Returns a reference to this object so that method calls can be chained together.

domainARN

AmazonopensearchserviceDestinationDescription.Builder domainARN(String domainARN)

The ARN of the Amazon OpenSearch Service domain.

Parameters:

domainARN - The ARN of the Amazon OpenSearch Service domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterEndpoint

AmazonopensearchserviceDestinationDescription.Builder clusterEndpoint(String clusterEndpoint)

The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

Parameters:

clusterEndpoint - The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

Returns:

Returns a reference to this object so that method calls can be chained together.

indexName

AmazonopensearchserviceDestinationDescription.Builder indexName(String indexName)

The Amazon OpenSearch Service index name.

Parameters:

indexName - The Amazon OpenSearch Service index name.

Returns:

Returns a reference to this object so that method calls can be chained together.

typeName

AmazonopensearchserviceDestinationDescription.Builder typeName(String typeName)

The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

Parameters:

typeName - The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

Returns:

Returns a reference to this object so that method calls can be chained together.

indexRotationPeriod

AmazonopensearchserviceDestinationDescription.Builder indexRotationPeriod(String indexRotationPeriod)

The Amazon OpenSearch Service index rotation period

Parameters:

indexRotationPeriod - The Amazon OpenSearch Service index rotation period

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AmazonopensearchserviceIndexRotationPeriod, AmazonopensearchserviceIndexRotationPeriod

indexRotationPeriod

AmazonopensearchserviceDestinationDescription.Builder indexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)

The Amazon OpenSearch Service index rotation period

Parameters:

indexRotationPeriod - The Amazon OpenSearch Service index rotation period

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AmazonopensearchserviceIndexRotationPeriod, AmazonopensearchserviceIndexRotationPeriod

bufferingHints

AmazonopensearchserviceDestinationDescription.Builder bufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)

The buffering options.

Parameters:

bufferingHints - The buffering options.

Returns:

Returns a reference to this object so that method calls can be chained together.

bufferingHints

default AmazonopensearchserviceDestinationDescription.Builder bufferingHints(Consumer<AmazonopensearchserviceBufferingHints.Builder> bufferingHints)

The buffering options.

This is a convenience method that creates an instance of the AmazonopensearchserviceBufferingHints.Builder avoiding the need to create one manually via AmazonopensearchserviceBufferingHints.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bufferingHints(AmazonopensearchserviceBufferingHints).

Parameters:

bufferingHints - a consumer that will call methods on AmazonopensearchserviceBufferingHints.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

bufferingHints(AmazonopensearchserviceBufferingHints)

retryOptions

AmazonopensearchserviceDestinationDescription.Builder retryOptions(AmazonopensearchserviceRetryOptions retryOptions)

The Amazon OpenSearch Service retry options.

Parameters:

retryOptions - The Amazon OpenSearch Service retry options.

Returns:

Returns a reference to this object so that method calls can be chained together.

retryOptions

default AmazonopensearchserviceDestinationDescription.Builder retryOptions(Consumer<AmazonopensearchserviceRetryOptions.Builder> retryOptions)

The Amazon OpenSearch Service retry options.

This is a convenience method that creates an instance of the AmazonopensearchserviceRetryOptions.Builder avoiding the need to create one manually via AmazonopensearchserviceRetryOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryOptions(AmazonopensearchserviceRetryOptions).

Parameters:

retryOptions - a consumer that will call methods on AmazonopensearchserviceRetryOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

retryOptions(AmazonopensearchserviceRetryOptions)

s3BackupMode

AmazonopensearchserviceDestinationDescription.Builder s3BackupMode(String s3BackupMode)

The Amazon S3 backup mode.

Parameters:

s3BackupMode - The Amazon S3 backup mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AmazonopensearchserviceS3BackupMode, AmazonopensearchserviceS3BackupMode

s3BackupMode

AmazonopensearchserviceDestinationDescription.Builder s3BackupMode(AmazonopensearchserviceS3BackupMode s3BackupMode)

The Amazon S3 backup mode.

Parameters:

s3BackupMode - The Amazon S3 backup mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AmazonopensearchserviceS3BackupMode, AmazonopensearchserviceS3BackupMode

s3DestinationDescription

AmazonopensearchserviceDestinationDescription.Builder s3DestinationDescription(S3DestinationDescription s3DestinationDescription)

Sets the value of the S3DestinationDescription property for this object.

Parameters:

s3DestinationDescription - The new value for the S3DestinationDescription property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3DestinationDescription

default AmazonopensearchserviceDestinationDescription.Builder s3DestinationDescription(Consumer<S3DestinationDescription.Builder> s3DestinationDescription)

Sets the value of the S3DestinationDescription property for this object. This is a convenience method that creates an instance of the S3DestinationDescription.Builder avoiding the need to create one manually via S3DestinationDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3DestinationDescription(S3DestinationDescription).

Parameters:

s3DestinationDescription - a consumer that will call methods on S3DestinationDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

s3DestinationDescription(S3DestinationDescription)

processingConfiguration

AmazonopensearchserviceDestinationDescription.Builder processingConfiguration(ProcessingConfiguration processingConfiguration)

Sets the value of the ProcessingConfiguration property for this object.

Parameters:

processingConfiguration - The new value for the ProcessingConfiguration property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

processingConfiguration

default AmazonopensearchserviceDestinationDescription.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)

Sets the value of the ProcessingConfiguration property for this object. This is a convenience method that creates an instance of the ProcessingConfiguration.Builder avoiding the need to create one manually via ProcessingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to processingConfiguration(ProcessingConfiguration).

Parameters:

processingConfiguration - a consumer that will call methods on ProcessingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

processingConfiguration(ProcessingConfiguration)

cloudWatchLoggingOptions

AmazonopensearchserviceDestinationDescription.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

Sets the value of the CloudWatchLoggingOptions property for this object.

Parameters:

cloudWatchLoggingOptions - The new value for the CloudWatchLoggingOptions property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudWatchLoggingOptions

default AmazonopensearchserviceDestinationDescription.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)

Sets the value of the CloudWatchLoggingOptions property for this object. This is a convenience method that creates an instance of the CloudWatchLoggingOptions.Builder avoiding the need to create one manually via CloudWatchLoggingOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLoggingOptions(CloudWatchLoggingOptions).

Parameters:

cloudWatchLoggingOptions - a consumer that will call methods on CloudWatchLoggingOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cloudWatchLoggingOptions(CloudWatchLoggingOptions)

vpcConfigurationDescription

AmazonopensearchserviceDestinationDescription.Builder vpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)

Sets the value of the VpcConfigurationDescription property for this object.

Parameters:

vpcConfigurationDescription - The new value for the VpcConfigurationDescription property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcConfigurationDescription

default AmazonopensearchserviceDestinationDescription.Builder vpcConfigurationDescription(Consumer<VpcConfigurationDescription.Builder> vpcConfigurationDescription)

Sets the value of the VpcConfigurationDescription property for this object. This is a convenience method that creates an instance of the VpcConfigurationDescription.Builder avoiding the need to create one manually via VpcConfigurationDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfigurationDescription(VpcConfigurationDescription).

Parameters:

vpcConfigurationDescription - a consumer that will call methods on VpcConfigurationDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

vpcConfigurationDescription(VpcConfigurationDescription)

documentIdOptions

AmazonopensearchserviceDestinationDescription.Builder documentIdOptions(DocumentIdOptions documentIdOptions)

Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.

Parameters:

documentIdOptions - Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentIdOptions

default AmazonopensearchserviceDestinationDescription.Builder documentIdOptions(Consumer<DocumentIdOptions.Builder> documentIdOptions)

Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.

This is a convenience method that creates an instance of the DocumentIdOptions.Builder avoiding the need to create one manually via DocumentIdOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentIdOptions(DocumentIdOptions).

Parameters:

documentIdOptions - a consumer that will call methods on DocumentIdOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

documentIdOptions(DocumentIdOptions)