Interface AmazonopensearchserviceDestinationDescription.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AmazonopensearchserviceDestinationDescription.Builder,
,AmazonopensearchserviceDestinationDescription> SdkBuilder<AmazonopensearchserviceDestinationDescription.Builder,
,AmazonopensearchserviceDestinationDescription> SdkPojo
- Enclosing class:
AmazonopensearchserviceDestinationDescription
-
Method Summary
Modifier and TypeMethodDescriptionbufferingHints
(Consumer<AmazonopensearchserviceBufferingHints.Builder> bufferingHints) The buffering options.bufferingHints
(AmazonopensearchserviceBufferingHints bufferingHints) The buffering options.cloudWatchLoggingOptions
(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.cloudWatchLoggingOptions
(CloudWatchLoggingOptions cloudWatchLoggingOptions) Sets the value of the CloudWatchLoggingOptions property for this object.clusterEndpoint
(String clusterEndpoint) The endpoint to use when communicating with the cluster.documentIdOptions
(Consumer<DocumentIdOptions.Builder> documentIdOptions) Indicates the method for setting up document ID.documentIdOptions
(DocumentIdOptions documentIdOptions) Indicates the method for setting up document ID.The ARN of the Amazon OpenSearch Service domain.The Amazon OpenSearch Service index name.indexRotationPeriod
(String indexRotationPeriod) The Amazon OpenSearch Service index rotation periodindexRotationPeriod
(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod) The Amazon OpenSearch Service index rotation periodprocessingConfiguration
(Consumer<ProcessingConfiguration.Builder> processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.processingConfiguration
(ProcessingConfiguration processingConfiguration) Sets the value of the ProcessingConfiguration property for this object.retryOptions
(Consumer<AmazonopensearchserviceRetryOptions.Builder> retryOptions) The Amazon OpenSearch Service retry options.retryOptions
(AmazonopensearchserviceRetryOptions retryOptions) The Amazon OpenSearch Service retry options.The Amazon Resource Name (ARN) of the Amazon Web Services credentials.s3BackupMode
(String s3BackupMode) The Amazon S3 backup mode.s3BackupMode
(AmazonopensearchserviceS3BackupMode s3BackupMode) The Amazon S3 backup mode.s3DestinationDescription
(Consumer<S3DestinationDescription.Builder> s3DestinationDescription) Sets the value of the S3DestinationDescription property for this object.s3DestinationDescription
(S3DestinationDescription s3DestinationDescription) Sets the value of the S3DestinationDescription property for this object.The Amazon OpenSearch Service type name.vpcConfigurationDescription
(Consumer<VpcConfigurationDescription.Builder> vpcConfigurationDescription) Sets the value of the VpcConfigurationDescription property for this object.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 Details
-
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
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
The endpoint to use when communicating with the cluster. 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. 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
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
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:
-
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:
-
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 theAmazonopensearchserviceBufferingHints.Builder
avoiding the need to create one manually viaAmazonopensearchserviceBufferingHints.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobufferingHints(AmazonopensearchserviceBufferingHints)
.- Parameters:
bufferingHints
- a consumer that will call methods onAmazonopensearchserviceBufferingHints.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theAmazonopensearchserviceRetryOptions.Builder
avoiding the need to create one manually viaAmazonopensearchserviceRetryOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryOptions(AmazonopensearchserviceRetryOptions)
.- Parameters:
retryOptions
- a consumer that will call methods onAmazonopensearchserviceRetryOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
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:
-
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 theS3DestinationDescription.Builder
avoiding the need to create one manually viaS3DestinationDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3DestinationDescription(S3DestinationDescription)
.- Parameters:
s3DestinationDescription
- a consumer that will call methods onS3DestinationDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theProcessingConfiguration.Builder
avoiding the need to create one manually viaProcessingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprocessingConfiguration(ProcessingConfiguration)
.- Parameters:
processingConfiguration
- a consumer that will call methods onProcessingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theCloudWatchLoggingOptions.Builder
avoiding the need to create one manually viaCloudWatchLoggingOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloudWatchLoggingOptions(CloudWatchLoggingOptions)
.- Parameters:
cloudWatchLoggingOptions
- a consumer that will call methods onCloudWatchLoggingOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theVpcConfigurationDescription.Builder
avoiding the need to create one manually viaVpcConfigurationDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfigurationDescription(VpcConfigurationDescription)
.- Parameters:
vpcConfigurationDescription
- a consumer that will call methods onVpcConfigurationDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
documentIdOptions
AmazonopensearchserviceDestinationDescription.Builder documentIdOptions(DocumentIdOptions documentIdOptions) Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- Parameters:
documentIdOptions
- Indicates the method for setting up document ID. The supported methods are 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 Firehose generated document ID and OpenSearch Service generated document ID.
This is a convenience method that creates an instance of theDocumentIdOptions.Builder
avoiding the need to create one manually viaDocumentIdOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentIdOptions(DocumentIdOptions)
.- Parameters:
documentIdOptions
- a consumer that will call methods onDocumentIdOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-