AmazonopensearchserviceDestinationUpdate (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes an update for a destination in Amazon OpenSearch Service.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AmazonopensearchserviceDestinationUpdate()

Constructors
Constructor and Description
`AmazonopensearchserviceDestinationUpdate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmazonopensearchserviceDestinationUpdate`	`clone()`
`boolean`	`equals(Object obj)`
`AmazonopensearchserviceBufferingHints`	`getBufferingHints()` The buffering options.
`CloudWatchLoggingOptions`	`getCloudWatchLoggingOptions()`
`String`	`getClusterEndpoint()` The endpoint to use when communicating with the cluster.
`DocumentIdOptions`	`getDocumentIdOptions()` Indicates the method for setting up document ID.
`String`	`getDomainARN()` The ARN of the Amazon OpenSearch Service domain.
`String`	`getIndexName()` The Amazon OpenSearch Service index name.
`String`	`getIndexRotationPeriod()` The Amazon OpenSearch Service index rotation period.
`ProcessingConfiguration`	`getProcessingConfiguration()`
`AmazonopensearchserviceRetryOptions`	`getRetryOptions()` The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
`String`	`getRoleARN()` The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
`S3DestinationUpdate`	`getS3Update()`
`String`	`getTypeName()` The Amazon OpenSearch Service type name.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)` The buffering options.
`void`	`setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)`
`void`	`setClusterEndpoint(String clusterEndpoint)` The endpoint to use when communicating with the cluster.
`void`	`setDocumentIdOptions(DocumentIdOptions documentIdOptions)` Indicates the method for setting up document ID.
`void`	`setDomainARN(String domainARN)` The ARN of the Amazon OpenSearch Service domain.
`void`	`setIndexName(String indexName)` The Amazon OpenSearch Service index name.
`void`	`setIndexRotationPeriod(String indexRotationPeriod)` The Amazon OpenSearch Service index rotation period.
`void`	`setProcessingConfiguration(ProcessingConfiguration processingConfiguration)`
`void`	`setRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)` The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
`void`	`setRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
`void`	`setS3Update(S3DestinationUpdate s3Update)`
`void`	`setTypeName(String typeName)` The Amazon OpenSearch Service type name.
`String`	`toString()` Returns a string representation of this object.
`AmazonopensearchserviceDestinationUpdate`	`withBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)` The buffering options.
`AmazonopensearchserviceDestinationUpdate`	`withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)`
`AmazonopensearchserviceDestinationUpdate`	`withClusterEndpoint(String clusterEndpoint)` The endpoint to use when communicating with the cluster.
`AmazonopensearchserviceDestinationUpdate`	`withDocumentIdOptions(DocumentIdOptions documentIdOptions)` Indicates the method for setting up document ID.
`AmazonopensearchserviceDestinationUpdate`	`withDomainARN(String domainARN)` The ARN of the Amazon OpenSearch Service domain.
`AmazonopensearchserviceDestinationUpdate`	`withIndexName(String indexName)` The Amazon OpenSearch Service index name.
`AmazonopensearchserviceDestinationUpdate`	`withIndexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)` The Amazon OpenSearch Service index rotation period.
`AmazonopensearchserviceDestinationUpdate`	`withIndexRotationPeriod(String indexRotationPeriod)` The Amazon OpenSearch Service index rotation period.
`AmazonopensearchserviceDestinationUpdate`	`withProcessingConfiguration(ProcessingConfiguration processingConfiguration)`
`AmazonopensearchserviceDestinationUpdate`	`withRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)` The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
`AmazonopensearchserviceDestinationUpdate`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
`AmazonopensearchserviceDestinationUpdate`	`withS3Update(S3DestinationUpdate s3Update)`
`AmazonopensearchserviceDestinationUpdate`	`withTypeName(String typeName)` The Amazon OpenSearch Service type name.

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

- Constructor Detail
  - AmazonopensearchserviceDestinationUpdate
```
public AmazonopensearchserviceDestinationUpdate()
```
- Method Detail
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
  - getRoleARN
```
public String getRoleARN()
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
  - withRoleARN
```
public AmazonopensearchserviceDestinationUpdate withRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
    
    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 OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
    
    Parameters:
    
    domainARN - The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
  - getDomainARN
```
public String getDomainARN()
```
    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
    
    Returns:
    
    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
  - withDomainARN
```
public AmazonopensearchserviceDestinationUpdate withDomainARN(String domainARN)
```
    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
    
    Parameters:
    
    domainARN - The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
    
    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. Specify either this ClusterEndpoint or the DomainARN field.
    
    Parameters:
    
    clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
  - getClusterEndpoint
```
public String getClusterEndpoint()
```
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
    
    Returns:
    
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
  - withClusterEndpoint
```
public AmazonopensearchserviceDestinationUpdate withClusterEndpoint(String clusterEndpoint)
```
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
    
    Parameters:
    
    clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexName
```
public void setIndexName(String indexName)
```
    The Amazon OpenSearch Service index name.
    
    Parameters:
    
    indexName - The Amazon OpenSearch Service index name.
  - getIndexName
```
public String getIndexName()
```
    The Amazon OpenSearch Service index name.
    
    Returns:
    
    The Amazon OpenSearch Service index name.
  - withIndexName
```
public AmazonopensearchserviceDestinationUpdate withIndexName(String 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.
  - setTypeName
```
public void setTypeName(String typeName)
```
    The Amazon OpenSearch Service 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, Firehose returns an error during runtime.
    
    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
    
    Parameters:
    
    typeName - The Amazon OpenSearch Service 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, Firehose returns an error during runtime.
    
    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
  - getTypeName
```
public String getTypeName()
```
    The Amazon OpenSearch Service 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, Firehose returns an error during runtime.
    
    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
    
    Returns:
    
    The Amazon OpenSearch Service 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, Firehose returns an error during runtime.
    
    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
  - withTypeName
```
public AmazonopensearchserviceDestinationUpdate withTypeName(String typeName)
```
    The Amazon OpenSearch Service 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, Firehose returns an error during runtime.
    
    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
    
    Parameters:
    
    typeName - The Amazon OpenSearch Service 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, Firehose returns an error during runtime.
    
    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexRotationPeriod
```
public void setIndexRotationPeriod(String indexRotationPeriod)
```
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
    
    Parameters:
    
    indexRotationPeriod - The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - getIndexRotationPeriod
```
public String getIndexRotationPeriod()
```
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
    
    Returns:
    
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - withIndexRotationPeriod
```
public AmazonopensearchserviceDestinationUpdate withIndexRotationPeriod(String indexRotationPeriod)
```
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
    
    Parameters:
    
    indexRotationPeriod - The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - withIndexRotationPeriod
```
public AmazonopensearchserviceDestinationUpdate withIndexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)
```
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
    
    Parameters:
    
    indexRotationPeriod - The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - setBufferingHints
```
public void setBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
  - getBufferingHints
```
public AmazonopensearchserviceBufferingHints getBufferingHints()
```
    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
    
    Returns:
    
    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
  - withBufferingHints
```
public AmazonopensearchserviceDestinationUpdate withBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryOptions
```
public void setRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)
```
    The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
    
    Parameters:
    
    retryOptions - The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
  - getRetryOptions
```
public AmazonopensearchserviceRetryOptions getRetryOptions()
```
    The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
    
    Returns:
    
    The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
  - withRetryOptions
```
public AmazonopensearchserviceDestinationUpdate withRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)
```
    The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
    
    Parameters:
    
    retryOptions - The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. 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)
```
    Parameters:
    
    s3Update -
  - getS3Update
```
public S3DestinationUpdate getS3Update()
```
    Returns:
  - withS3Update
```
public AmazonopensearchserviceDestinationUpdate withS3Update(S3DestinationUpdate s3Update)
```
    Parameters:
    
    s3Update -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProcessingConfiguration
```
public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    Parameters:
    
    processingConfiguration -
  - getProcessingConfiguration
```
public ProcessingConfiguration getProcessingConfiguration()
```
    Returns:
  - withProcessingConfiguration
```
public AmazonopensearchserviceDestinationUpdate withProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    Parameters:
    
    processingConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchLoggingOptions
```
public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    Parameters:
    
    cloudWatchLoggingOptions -
  - getCloudWatchLoggingOptions
```
public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
```
    Returns:
  - withCloudWatchLoggingOptions
```
public AmazonopensearchserviceDestinationUpdate withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    Parameters:
    
    cloudWatchLoggingOptions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentIdOptions
```
public void setDocumentIdOptions(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.
  - getDocumentIdOptions
```
public DocumentIdOptions getDocumentIdOptions()
```
    Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
    
    Returns:
    
    Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
  - withDocumentIdOptions
```
public AmazonopensearchserviceDestinationUpdate withDocumentIdOptions(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.
  - 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 AmazonopensearchserviceDestinationUpdate 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.

AWS SDK for Java 1.x API Reference - 1.12.780

Class AmazonopensearchserviceDestinationUpdate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AmazonopensearchserviceDestinationUpdate

Method Detail

setRoleARN

getRoleARN

withRoleARN

setDomainARN

getDomainARN

withDomainARN

setClusterEndpoint

getClusterEndpoint

withClusterEndpoint

setIndexName

getIndexName

withIndexName

setTypeName

getTypeName

withTypeName

setIndexRotationPeriod

getIndexRotationPeriod

withIndexRotationPeriod

withIndexRotationPeriod

setBufferingHints

getBufferingHints

withBufferingHints

setRetryOptions

getRetryOptions

withRetryOptions

setS3Update

getS3Update

withS3Update

setProcessingConfiguration

getProcessingConfiguration

withProcessingConfiguration

setCloudWatchLoggingOptions

getCloudWatchLoggingOptions

withCloudWatchLoggingOptions

setDocumentIdOptions

getDocumentIdOptions

withDocumentIdOptions

toString

equals

hashCode

clone

marshall