Class ElasticsearchDestinationUpdate
- All Implemented Interfaces:
Serializable
,Cloneable
Describes an update for a destination in Amazon ES.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Buffering options.Describes CloudWatch logging options for your delivery stream.The ARN of the Amazon ES domain.The Elasticsearch index name.The Elasticsearch index rotation period.Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.The Elasticsearch type name.int
hashCode()
void
setBufferingHints
(ElasticsearchBufferingHints bufferingHints) Buffering options.void
setCloudWatchLoggingOptions
(CloudWatchLoggingOptions cloudWatchLoggingOptions) Describes CloudWatch logging options for your delivery stream.void
setDomainARN
(String domainARN) The ARN of the Amazon ES domain.void
setIndexName
(String indexName) The Elasticsearch index name.void
setIndexRotationPeriod
(ElasticsearchIndexRotationPeriod indexRotationPeriod) The Elasticsearch index rotation period.void
setIndexRotationPeriod
(String indexRotationPeriod) The Elasticsearch index rotation period.void
setRetryOptions
(ElasticsearchRetryOptions retryOptions) Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.void
setRoleARN
(String roleARN) The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.void
setS3Update
(S3DestinationUpdate s3Update) void
setTypeName
(String typeName) The Elasticsearch type name.toString()
Returns a string representation of this object; useful for testing and debugging.withBufferingHints
(ElasticsearchBufferingHints bufferingHints) Buffering options.withCloudWatchLoggingOptions
(CloudWatchLoggingOptions cloudWatchLoggingOptions) Describes CloudWatch logging options for your delivery stream.withDomainARN
(String domainARN) The ARN of the Amazon ES domain.withIndexName
(String indexName) The Elasticsearch index name.withIndexRotationPeriod
(ElasticsearchIndexRotationPeriod indexRotationPeriod) The Elasticsearch index rotation period.withIndexRotationPeriod
(String indexRotationPeriod) The Elasticsearch index rotation period.withRetryOptions
(ElasticsearchRetryOptions retryOptions) Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.withRoleARN
(String roleARN) The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.withS3Update
(S3DestinationUpdate s3Update) withTypeName
(String typeName) The Elasticsearch type name.
-
Constructor Details
-
ElasticsearchDestinationUpdate
public ElasticsearchDestinationUpdate()
-
-
Method Details
-
setRoleARN
The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.
- Parameters:
roleARN
- The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.
-
getRoleARN
The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.
- Returns:
- The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.
-
withRoleARN
The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.
- Parameters:
roleARN
- The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDomainARN
The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
- Parameters:
domainARN
- The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
-
getDomainARN
The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
- Returns:
- The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
-
withDomainARN
The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
- Parameters:
domainARN
- The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIndexName
The Elasticsearch index name.
- Parameters:
indexName
- The Elasticsearch index name.
-
getIndexName
The Elasticsearch index name.
- Returns:
- The Elasticsearch index name.
-
withIndexName
The Elasticsearch index name.
- Parameters:
indexName
- The Elasticsearch index name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTypeName
The Elasticsearch type name.
- Parameters:
typeName
- The Elasticsearch type name.
-
getTypeName
The Elasticsearch type name.
- Returns:
- The Elasticsearch type name.
-
withTypeName
The Elasticsearch type name.
- Parameters:
typeName
- The Elasticsearch type name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIndexRotationPeriod
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is
OneDay
.- Parameters:
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value isOneDay
.- See Also:
-
getIndexRotationPeriod
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is
OneDay
.- Returns:
- The Elasticsearch index rotation period. Index rotation appends a
timestamp to the IndexName to facilitate the expiration of old
data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination.
Default value is
OneDay
. - See Also:
-
withIndexRotationPeriod
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is
OneDay
.- Parameters:
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value isOneDay
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setIndexRotationPeriod
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is
OneDay
.- Parameters:
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value isOneDay
.- See Also:
-
withIndexRotationPeriod
public ElasticsearchDestinationUpdate withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod) The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is
OneDay
.- Parameters:
indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value isOneDay
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setBufferingHints
Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
- Parameters:
bufferingHints
- Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
-
getBufferingHints
Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
- Returns:
- Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
-
withBufferingHints
public ElasticsearchDestinationUpdate withBufferingHints(ElasticsearchBufferingHints bufferingHints) Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
- Parameters:
bufferingHints
- Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRetryOptions
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
- Parameters:
retryOptions
- Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
-
getRetryOptions
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
- Returns:
- Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
-
withRetryOptions
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
- Parameters:
retryOptions
- Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setS3Update
- Parameters:
s3Update
-
-
getS3Update
- Returns:
-
withS3Update
- Parameters:
s3Update
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCloudWatchLoggingOptions
Describes CloudWatch logging options for your delivery stream.
- Parameters:
cloudWatchLoggingOptions
- Describes CloudWatch logging options for your delivery stream.
-
getCloudWatchLoggingOptions
Describes CloudWatch logging options for your delivery stream.
- Returns:
- Describes CloudWatch logging options for your delivery stream.
-
withCloudWatchLoggingOptions
public ElasticsearchDestinationUpdate withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) Describes CloudWatch logging options for your delivery stream.
- Parameters:
cloudWatchLoggingOptions
- Describes CloudWatch logging options for your delivery stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-