ElasticsearchDestinationDescription (AWS Java SDK for Amazon Kinesis 1.12.282 API)

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The destination description in Amazon ES.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ElasticsearchDestinationDescription()

Constructors
Constructor and Description
`ElasticsearchDestinationDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ElasticsearchDestinationDescription`	`clone()`
`boolean`	`equals(Object obj)`
`ElasticsearchBufferingHints`	`getBufferingHints()` The buffering options.
`CloudWatchLoggingOptions`	`getCloudWatchLoggingOptions()` The Amazon CloudWatch logging options.
`String`	`getClusterEndpoint()` The endpoint to use when communicating with the cluster.
`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 Amazon ES retry options.
`String`	`getRoleARN()` The Amazon Resource Name (ARN) of the AWS credentials.
`String`	`getS3BackupMode()` The Amazon S3 backup mode.
`S3DestinationDescription`	`getS3DestinationDescription()` The Amazon S3 destination.
`String`	`getTypeName()` The Elasticsearch type name.
`VpcConfigurationDescription`	`getVpcConfigurationDescription()` The details of the VPC of the Amazon ES destination.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBufferingHints(ElasticsearchBufferingHints bufferingHints)` The buffering options.
`void`	`setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)` The Amazon CloudWatch logging options.
`void`	`setClusterEndpoint(String clusterEndpoint)` The endpoint to use when communicating with the cluster.
`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 Amazon ES retry options.
`void`	`setRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the AWS credentials.
`void`	`setS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)` The Amazon S3 backup mode.
`void`	`setS3BackupMode(String s3BackupMode)` The Amazon S3 backup mode.
`void`	`setS3DestinationDescription(S3DestinationDescription s3DestinationDescription)` The Amazon S3 destination.
`void`	`setTypeName(String typeName)` The Elasticsearch type name.
`void`	`setVpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)` The details of the VPC of the Amazon ES destination.
`String`	`toString()` Returns a string representation of this object.
`ElasticsearchDestinationDescription`	`withBufferingHints(ElasticsearchBufferingHints bufferingHints)` The buffering options.
`ElasticsearchDestinationDescription`	`withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)` The Amazon CloudWatch logging options.
`ElasticsearchDestinationDescription`	`withClusterEndpoint(String clusterEndpoint)` The endpoint to use when communicating with the cluster.
`ElasticsearchDestinationDescription`	`withDomainARN(String domainARN)` The ARN of the Amazon ES domain.
`ElasticsearchDestinationDescription`	`withIndexName(String indexName)` The Elasticsearch index name.
`ElasticsearchDestinationDescription`	`withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)` The Elasticsearch index rotation period
`ElasticsearchDestinationDescription`	`withIndexRotationPeriod(String indexRotationPeriod)` The Elasticsearch index rotation period
`ElasticsearchDestinationDescription`	`withProcessingConfiguration(ProcessingConfiguration processingConfiguration)` The data processing configuration.
`ElasticsearchDestinationDescription`	`withRetryOptions(ElasticsearchRetryOptions retryOptions)` The Amazon ES retry options.
`ElasticsearchDestinationDescription`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the AWS credentials.
`ElasticsearchDestinationDescription`	`withS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)` The Amazon S3 backup mode.
`ElasticsearchDestinationDescription`	`withS3BackupMode(String s3BackupMode)` The Amazon S3 backup mode.
`ElasticsearchDestinationDescription`	`withS3DestinationDescription(S3DestinationDescription s3DestinationDescription)` The Amazon S3 destination.
`ElasticsearchDestinationDescription`	`withTypeName(String typeName)` The Elasticsearch type name.
`ElasticsearchDestinationDescription`	`withVpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)` The details of the VPC of the Amazon ES destination.

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

- Constructor Detail
  - ElasticsearchDestinationDescription
```
public ElasticsearchDestinationDescription()
```
- Method Detail
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - getRoleARN
```
public String getRoleARN()
```
    The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - withRoleARN
```
public ElasticsearchDestinationDescription withRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the AWS credentials. 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.
  - setDomainARN
```
public void setDomainARN(String domainARN)
```
    The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
    
    Parameters:
    
    domainARN - The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
  - getDomainARN
```
public String getDomainARN()
```
    The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
    
    Returns:
    
    The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
  - withDomainARN
```
public ElasticsearchDestinationDescription withDomainARN(String domainARN)
```
    The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
    
    Parameters:
    
    domainARN - The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterEndpoint
```
public void setClusterEndpoint(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 ES.
    
    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 ES.
  - getClusterEndpoint
```
public String getClusterEndpoint()
```
    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 ES.
    
    Returns:
    
    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 ES.
  - withClusterEndpoint
```
public ElasticsearchDestinationDescription withClusterEndpoint(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 ES.
    
    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 ES.
    
    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 ElasticsearchDestinationDescription 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. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.
    
    Parameters:
    
    typeName - The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.
  - getTypeName
```
public String getTypeName()
```
    The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.
    
    Returns:
    
    The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.
  - withTypeName
```
public ElasticsearchDestinationDescription withTypeName(String typeName)
```
    The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.
    
    Parameters:
    
    typeName - The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.
    
    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
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - getIndexRotationPeriod
```
public String getIndexRotationPeriod()
```
    The Elasticsearch index rotation period
    
    Returns:
    
    The Elasticsearch index rotation period
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - withIndexRotationPeriod
```
public ElasticsearchDestinationDescription withIndexRotationPeriod(String indexRotationPeriod)
```
    The Elasticsearch index rotation period
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period
    
    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
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - withIndexRotationPeriod
```
public ElasticsearchDestinationDescription withIndexRotationPeriod(ElasticsearchIndexRotationPeriod indexRotationPeriod)
```
    The Elasticsearch index rotation period
    
    Parameters:
    
    indexRotationPeriod - The Elasticsearch index rotation period
    
    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.
    
    Parameters:
    
    bufferingHints - The buffering options.
  - getBufferingHints
```
public ElasticsearchBufferingHints getBufferingHints()
```
    The buffering options.
    
    Returns:
    
    The buffering options.
  - withBufferingHints
```
public ElasticsearchDestinationDescription withBufferingHints(ElasticsearchBufferingHints bufferingHints)
```
    The buffering options.
    
    Parameters:
    
    bufferingHints - The buffering options.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryOptions
```
public void setRetryOptions(ElasticsearchRetryOptions retryOptions)
```
    The Amazon ES retry options.
    
    Parameters:
    
    retryOptions - The Amazon ES retry options.
  - getRetryOptions
```
public ElasticsearchRetryOptions getRetryOptions()
```
    The Amazon ES retry options.
    
    Returns:
    
    The Amazon ES retry options.
  - withRetryOptions
```
public ElasticsearchDestinationDescription withRetryOptions(ElasticsearchRetryOptions retryOptions)
```
    The Amazon ES retry options.
    
    Parameters:
    
    retryOptions - The Amazon ES retry options.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3BackupMode
```
public void setS3BackupMode(String s3BackupMode)
```
    The Amazon S3 backup mode.
    
    Parameters:
    
    s3BackupMode - The Amazon S3 backup mode.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - getS3BackupMode
```
public String getS3BackupMode()
```
    The Amazon S3 backup mode.
    
    Returns:
    
    The Amazon S3 backup mode.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - withS3BackupMode
```
public ElasticsearchDestinationDescription withS3BackupMode(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:
    
    ElasticsearchS3BackupMode
  - setS3BackupMode
```
public void setS3BackupMode(ElasticsearchS3BackupMode s3BackupMode)
```
    The Amazon S3 backup mode.
    
    Parameters:
    
    s3BackupMode - The Amazon S3 backup mode.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - withS3BackupMode
```
public ElasticsearchDestinationDescription withS3BackupMode(ElasticsearchS3BackupMode 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:
    
    ElasticsearchS3BackupMode
  - setS3DestinationDescription
```
public void setS3DestinationDescription(S3DestinationDescription s3DestinationDescription)
```
    The Amazon S3 destination.
    
    Parameters:
    
    s3DestinationDescription - The Amazon S3 destination.
  - getS3DestinationDescription
```
public S3DestinationDescription getS3DestinationDescription()
```
    The Amazon S3 destination.
    
    Returns:
    
    The Amazon S3 destination.
  - withS3DestinationDescription
```
public ElasticsearchDestinationDescription withS3DestinationDescription(S3DestinationDescription s3DestinationDescription)
```
    The Amazon S3 destination.
    
    Parameters:
    
    s3DestinationDescription - 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 ElasticsearchDestinationDescription 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 Amazon CloudWatch logging options.
    
    Parameters:
    
    cloudWatchLoggingOptions - The Amazon CloudWatch logging options.
  - getCloudWatchLoggingOptions
```
public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
```
    The Amazon CloudWatch logging options.
    
    Returns:
    
    The Amazon CloudWatch logging options.
  - withCloudWatchLoggingOptions
```
public ElasticsearchDestinationDescription withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    The Amazon CloudWatch logging options.
    
    Parameters:
    
    cloudWatchLoggingOptions - The Amazon CloudWatch logging options.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfigurationDescription
```
public void setVpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)
```
    The details of the VPC of the Amazon ES destination.
    
    Parameters:
    
    vpcConfigurationDescription - The details of the VPC of the Amazon ES destination.
  - getVpcConfigurationDescription
```
public VpcConfigurationDescription getVpcConfigurationDescription()
```
    The details of the VPC of the Amazon ES destination.
    
    Returns:
    
    The details of the VPC of the Amazon ES destination.
  - withVpcConfigurationDescription
```
public ElasticsearchDestinationDescription withVpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)
```
    The details of the VPC of the Amazon ES destination.
    
    Parameters:
    
    vpcConfigurationDescription - The details of the VPC of the Amazon ES destination.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 ElasticsearchDestinationDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ElasticsearchDestinationDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ElasticsearchDestinationDescription

Method Detail

setRoleARN

getRoleARN

withRoleARN

setDomainARN

getDomainARN

withDomainARN

setClusterEndpoint

getClusterEndpoint

withClusterEndpoint

setIndexName

getIndexName

withIndexName

setTypeName

getTypeName

withTypeName

setIndexRotationPeriod

getIndexRotationPeriod

withIndexRotationPeriod

setIndexRotationPeriod

withIndexRotationPeriod

setBufferingHints

getBufferingHints

withBufferingHints

setRetryOptions

getRetryOptions

withRetryOptions

setS3BackupMode

getS3BackupMode

withS3BackupMode

setS3BackupMode

withS3BackupMode

setS3DestinationDescription

getS3DestinationDescription

withS3DestinationDescription

setProcessingConfiguration

getProcessingConfiguration

withProcessingConfiguration

setCloudWatchLoggingOptions

getCloudWatchLoggingOptions

withCloudWatchLoggingOptions

setVpcConfigurationDescription

getVpcConfigurationDescription

withVpcConfigurationDescription

toString

equals

hashCode

clone

marshall