Class ElasticsearchDestinationUpdate
- java.lang.Object
-
- com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationUpdate
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ElasticsearchDestinationUpdate extends Object implements Serializable, Cloneable
Describes an update for a destination in Amazon ES.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ElasticsearchDestinationUpdate()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ElasticsearchDestinationUpdate
clone()
boolean
equals(Object obj)
ElasticsearchBufferingHints
getBufferingHints()
Buffering options.CloudWatchLoggingOptions
getCloudWatchLoggingOptions()
Describes CloudWatch logging options for your delivery stream.String
getDomainARN()
The ARN of the Amazon ES domain.String
getIndexName()
The Elasticsearch index name.String
getIndexRotationPeriod()
The Elasticsearch index rotation period.ElasticsearchRetryOptions
getRetryOptions()
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.String
getRoleARN()
The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents.S3DestinationUpdate
getS3Update()
String
getTypeName()
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.ElasticsearchDestinationUpdate
withBufferingHints(ElasticsearchBufferingHints bufferingHints)
Buffering options.ElasticsearchDestinationUpdate
withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
Describes CloudWatch logging options for your delivery stream.ElasticsearchDestinationUpdate
withDomainARN(String domainARN)
The ARN of the Amazon ES domain.ElasticsearchDestinationUpdate
withIndexName(String indexName)
The Elasticsearch index name.ElasticsearchDestinationUpdate
withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
The Elasticsearch index rotation period.ElasticsearchDestinationUpdate
withIndexRotationPeriod(String indexRotationPeriod)
The Elasticsearch index rotation period.ElasticsearchDestinationUpdate
withRetryOptions(ElasticsearchRetryOptions retryOptions)
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.ElasticsearchDestinationUpdate
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.ElasticsearchDestinationUpdate
withS3Update(S3DestinationUpdate s3Update)
ElasticsearchDestinationUpdate
withTypeName(String typeName)
The Elasticsearch type name.
-
-
-
Method Detail
-
setRoleARN
public 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. 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
public String 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
public ElasticsearchDestinationUpdate 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. 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
public void setDomainARN(String domainARN)
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
public String 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
public ElasticsearchDestinationUpdate withDomainARN(String domainARN)
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
public void setIndexName(String indexName)
The Elasticsearch index name.
- Parameters:
indexName
- The Elasticsearch index name.
-
getIndexName
public String getIndexName()
The Elasticsearch index name.
- Returns:
- The Elasticsearch index name.
-
withIndexName
public ElasticsearchDestinationUpdate withIndexName(String indexName)
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
public void setTypeName(String typeName)
The Elasticsearch type name.
- Parameters:
typeName
- The Elasticsearch type name.
-
getTypeName
public String getTypeName()
The Elasticsearch type name.
- Returns:
- The Elasticsearch type name.
-
withTypeName
public ElasticsearchDestinationUpdate withTypeName(String typeName)
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
public void setIndexRotationPeriod(String 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
.- See Also:
ElasticsearchIndexRotationPeriod
-
getIndexRotationPeriod
public String 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:
ElasticsearchIndexRotationPeriod
-
withIndexRotationPeriod
public ElasticsearchDestinationUpdate withIndexRotationPeriod(String 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:
ElasticsearchIndexRotationPeriod
-
setIndexRotationPeriod
public void setIndexRotationPeriod(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
.- See Also:
ElasticsearchIndexRotationPeriod
-
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:
ElasticsearchIndexRotationPeriod
-
setBufferingHints
public void setBufferingHints(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.
-
getBufferingHints
public ElasticsearchBufferingHints 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
public void setRetryOptions(ElasticsearchRetryOptions retryOptions)
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
public ElasticsearchRetryOptions 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
public ElasticsearchDestinationUpdate withRetryOptions(ElasticsearchRetryOptions retryOptions)
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
public void setS3Update(S3DestinationUpdate s3Update)
- Parameters:
s3Update
-
-
getS3Update
public S3DestinationUpdate getS3Update()
- Returns:
-
withS3Update
public ElasticsearchDestinationUpdate withS3Update(S3DestinationUpdate s3Update)
- Parameters:
s3Update
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCloudWatchLoggingOptions
public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
Describes CloudWatch logging options for your delivery stream.
- Parameters:
cloudWatchLoggingOptions
- Describes CloudWatch logging options for your delivery stream.
-
getCloudWatchLoggingOptions
public CloudWatchLoggingOptions 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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ElasticsearchDestinationUpdate clone()
-
-