ElasticsearchDestinationUpdate (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationUpdate

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ElasticsearchDestinationUpdate
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes an update for a destination in Amazon ES.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ElasticsearchDestinationUpdate()

Constructors
Constructor and Description
`ElasticsearchDestinationUpdate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ElasticsearchDestinationUpdate`	`clone()`
`boolean`	`equals(Object obj)`
`ElasticsearchBufferingHints`	`getBufferingHints()` The buffering options.
`CloudWatchLoggingOptions`	`getCloudWatchLoggingOptions()` The 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.
`ProcessingConfiguration`	`getProcessingConfiguration()` The data processing configuration.
`ElasticsearchRetryOptions`	`getRetryOptions()` The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
`String`	`getRoleARN()` The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents.
`S3DestinationUpdate`	`getS3Update()` The Amazon S3 destination.
`String`	`getTypeName()` The Elasticsearch type name.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBufferingHints(ElasticsearchBufferingHints bufferingHints)` The buffering options.
`void`	`setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)` The 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`	`setProcessingConfiguration(ProcessingConfiguration processingConfiguration)` The data processing configuration.
`void`	`setRetryOptions(ElasticsearchRetryOptions retryOptions)` The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
`void`	`setRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents.
`void`	`setS3Update(S3DestinationUpdate s3Update)` The Amazon S3 destination.
`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)` The buffering options.
`ElasticsearchDestinationUpdate`	`withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)` The 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`	`withProcessingConfiguration(ProcessingConfiguration processingConfiguration)` The data processing configuration.
`ElasticsearchDestinationUpdate`	`withRetryOptions(ElasticsearchRetryOptions retryOptions)` The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
`ElasticsearchDestinationUpdate`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents.
`ElasticsearchDestinationUpdate`	`withS3Update(S3DestinationUpdate s3Update)` The Amazon S3 destination.
`ElasticsearchDestinationUpdate`	`withTypeName(String typeName)` The Elasticsearch type name.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ElasticsearchDestinationUpdate
```
public ElasticsearchDestinationUpdate()
```
- Method Detail
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - getRoleARN
```
public String getRoleARN()
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - withRoleARN
```
public ElasticsearchDestinationUpdate withRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    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 permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - getDomainARN
```
public String getDomainARN()
```
    The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Returns:
    
    The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - withDomainARN
```
public ElasticsearchDestinationUpdate withDomainARN(String domainARN)
```
    The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    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. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
    
    Parameters:
    
    typeName - The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
  - getTypeName
```
public String getTypeName()
```
    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
    
    Returns:
    
    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
  - withTypeName
```
public ElasticsearchDestinationUpdate withTypeName(String typeName)
```
    The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
    
    Parameters:
    
    typeName - The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
    
    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 time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - getIndexRotationPeriod
```
public String getIndexRotationPeriod()
```
    The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    Returns:
    
    The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - withIndexRotationPeriod
```
public ElasticsearchDestinationUpdate withIndexRotationPeriod(String indexRotationPeriod)
```
    The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    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 time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - withIndexRotationPeriod
```
public ElasticsearchDestinationUpdate withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
```
    The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - setBufferingHints
```
public void setBufferingHints(ElasticsearchBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
  - getBufferingHints
```
public ElasticsearchBufferingHints getBufferingHints()
```
    The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
    
    Returns:
    
    The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
  - withBufferingHints
```
public ElasticsearchDestinationUpdate withBufferingHints(ElasticsearchBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
    
    Parameters:
    
    bufferingHints - The 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)
```
    The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
    
    Parameters:
    
    retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
  - getRetryOptions
```
public ElasticsearchRetryOptions getRetryOptions()
```
    The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
    
    Returns:
    
    The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
  - withRetryOptions
```
public ElasticsearchDestinationUpdate withRetryOptions(ElasticsearchRetryOptions retryOptions)
```
    The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
    
    Parameters:
    
    retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The 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)
```
    The Amazon S3 destination.
    
    Parameters:
    
    s3Update - The Amazon S3 destination.
  - getS3Update
```
public S3DestinationUpdate getS3Update()
```
    The Amazon S3 destination.
    
    Returns:
    
    The Amazon S3 destination.
  - withS3Update
```
public ElasticsearchDestinationUpdate withS3Update(S3DestinationUpdate s3Update)
```
    The Amazon S3 destination.
    
    Parameters:
    
    s3Update - The Amazon S3 destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProcessingConfiguration
```
public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    The data processing configuration.
    
    Parameters:
    
    processingConfiguration - The data processing configuration.
  - getProcessingConfiguration
```
public ProcessingConfiguration getProcessingConfiguration()
```
    The data processing configuration.
    
    Returns:
    
    The data processing configuration.
  - withProcessingConfiguration
```
public ElasticsearchDestinationUpdate withProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    The data processing configuration.
    
    Parameters:
    
    processingConfiguration - The data processing configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchLoggingOptions
```
public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    The CloudWatch logging options for your delivery stream.
    
    Parameters:
    
    cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.
  - getCloudWatchLoggingOptions
```
public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
```
    The CloudWatch logging options for your delivery stream.
    
    Returns:
    
    The CloudWatch logging options for your delivery stream.
  - withCloudWatchLoggingOptions
```
public ElasticsearchDestinationUpdate withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    The CloudWatch logging options for your delivery stream.
    
    Parameters:
    
    cloudWatchLoggingOptions - The 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 class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ElasticsearchDestinationUpdate clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ElasticsearchDestinationUpdate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ElasticsearchDestinationUpdate

Method Detail

setRoleARN

getRoleARN

withRoleARN

setDomainARN

getDomainARN

withDomainARN

setIndexName

getIndexName

withIndexName

setTypeName

getTypeName

withTypeName

setIndexRotationPeriod

getIndexRotationPeriod

withIndexRotationPeriod

setIndexRotationPeriod

withIndexRotationPeriod

setBufferingHints

getBufferingHints

withBufferingHints

setRetryOptions

getRetryOptions

withRetryOptions

setS3Update

getS3Update

withS3Update

setProcessingConfiguration

getProcessingConfiguration

withProcessingConfiguration

setCloudWatchLoggingOptions

getCloudWatchLoggingOptions

withCloudWatchLoggingOptions

toString

equals

hashCode

clone

marshall