AmazonopensearchserviceDestinationDescription (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The destination description in Amazon OpenSearch Service.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AmazonopensearchserviceDestinationDescription()

Constructors
Constructor and Description
`AmazonopensearchserviceDestinationDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmazonopensearchserviceDestinationDescription`	`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 Amazon OpenSearch Service retry options.
`String`	`getRoleARN()` The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
`String`	`getS3BackupMode()` The Amazon S3 backup mode.
`S3DestinationDescription`	`getS3DestinationDescription()`
`String`	`getTypeName()` The Amazon OpenSearch Service type name.
`VpcConfigurationDescription`	`getVpcConfigurationDescription()`
`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 Amazon OpenSearch Service retry options.
`void`	`setRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
`void`	`setS3BackupMode(String s3BackupMode)` The Amazon S3 backup mode.
`void`	`setS3DestinationDescription(S3DestinationDescription s3DestinationDescription)`
`void`	`setTypeName(String typeName)` The Amazon OpenSearch Service type name.
`void`	`setVpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)`
`String`	`toString()` Returns a string representation of this object.
`AmazonopensearchserviceDestinationDescription`	`withBufferingHints(AmazonopensearchserviceBufferingHints bufferingHints)` The buffering options.
`AmazonopensearchserviceDestinationDescription`	`withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)`
`AmazonopensearchserviceDestinationDescription`	`withClusterEndpoint(String clusterEndpoint)` The endpoint to use when communicating with the cluster.
`AmazonopensearchserviceDestinationDescription`	`withDocumentIdOptions(DocumentIdOptions documentIdOptions)` Indicates the method for setting up document ID.
`AmazonopensearchserviceDestinationDescription`	`withDomainARN(String domainARN)` The ARN of the Amazon OpenSearch Service domain.
`AmazonopensearchserviceDestinationDescription`	`withIndexName(String indexName)` The Amazon OpenSearch Service index name.
`AmazonopensearchserviceDestinationDescription`	`withIndexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)` The Amazon OpenSearch Service index rotation period
`AmazonopensearchserviceDestinationDescription`	`withIndexRotationPeriod(String indexRotationPeriod)` The Amazon OpenSearch Service index rotation period
`AmazonopensearchserviceDestinationDescription`	`withProcessingConfiguration(ProcessingConfiguration processingConfiguration)`
`AmazonopensearchserviceDestinationDescription`	`withRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)` The Amazon OpenSearch Service retry options.
`AmazonopensearchserviceDestinationDescription`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
`AmazonopensearchserviceDestinationDescription`	`withS3BackupMode(AmazonopensearchserviceS3BackupMode s3BackupMode)` The Amazon S3 backup mode.
`AmazonopensearchserviceDestinationDescription`	`withS3BackupMode(String s3BackupMode)` The Amazon S3 backup mode.
`AmazonopensearchserviceDestinationDescription`	`withS3DestinationDescription(S3DestinationDescription s3DestinationDescription)`
`AmazonopensearchserviceDestinationDescription`	`withTypeName(String typeName)` The Amazon OpenSearch Service type name.
`AmazonopensearchserviceDestinationDescription`	`withVpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)`

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

- Constructor Detail
  - AmazonopensearchserviceDestinationDescription
```
public AmazonopensearchserviceDestinationDescription()
```
- Method Detail
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
  - getRoleARN
```
public String getRoleARN()
```
    The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
  - withRoleARN
```
public AmazonopensearchserviceDestinationDescription withRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
    
    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.
    
    Parameters:
    
    domainARN - The ARN of the Amazon OpenSearch Service domain.
  - getDomainARN
```
public String getDomainARN()
```
    The ARN of the Amazon OpenSearch Service domain.
    
    Returns:
    
    The ARN of the Amazon OpenSearch Service domain.
  - withDomainARN
```
public AmazonopensearchserviceDestinationDescription withDomainARN(String domainARN)
```
    The ARN of the Amazon OpenSearch Service domain.
    
    Parameters:
    
    domainARN - The ARN of the Amazon OpenSearch Service domain.
    
    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. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
    
    Parameters:
    
    clusterEndpoint - The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
  - getClusterEndpoint
```
public String getClusterEndpoint()
```
    The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
    
    Returns:
    
    The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
  - withClusterEndpoint
```
public AmazonopensearchserviceDestinationDescription withClusterEndpoint(String clusterEndpoint)
```
    The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
    
    Parameters:
    
    clusterEndpoint - The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
    
    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 AmazonopensearchserviceDestinationDescription 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. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
    
    Parameters:
    
    typeName - The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
  - getTypeName
```
public String getTypeName()
```
    The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
    
    Returns:
    
    The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
  - withTypeName
```
public AmazonopensearchserviceDestinationDescription withTypeName(String typeName)
```
    The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
    
    Parameters:
    
    typeName - The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.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 Amazon OpenSearch Service index rotation period
    
    Parameters:
    
    indexRotationPeriod - The Amazon OpenSearch Service index rotation period
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - getIndexRotationPeriod
```
public String getIndexRotationPeriod()
```
    The Amazon OpenSearch Service index rotation period
    
    Returns:
    
    The Amazon OpenSearch Service index rotation period
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - withIndexRotationPeriod
```
public AmazonopensearchserviceDestinationDescription withIndexRotationPeriod(String indexRotationPeriod)
```
    The Amazon OpenSearch Service index rotation period
    
    Parameters:
    
    indexRotationPeriod - The Amazon OpenSearch Service index rotation period
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - withIndexRotationPeriod
```
public AmazonopensearchserviceDestinationDescription withIndexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod)
```
    The Amazon OpenSearch Service index rotation period
    
    Parameters:
    
    indexRotationPeriod - The Amazon OpenSearch Service index rotation period
    
    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.
    
    Parameters:
    
    bufferingHints - The buffering options.
  - getBufferingHints
```
public AmazonopensearchserviceBufferingHints getBufferingHints()
```
    The buffering options.
    
    Returns:
    
    The buffering options.
  - withBufferingHints
```
public AmazonopensearchserviceDestinationDescription withBufferingHints(AmazonopensearchserviceBufferingHints 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(AmazonopensearchserviceRetryOptions retryOptions)
```
    The Amazon OpenSearch Service retry options.
    
    Parameters:
    
    retryOptions - The Amazon OpenSearch Service retry options.
  - getRetryOptions
```
public AmazonopensearchserviceRetryOptions getRetryOptions()
```
    The Amazon OpenSearch Service retry options.
    
    Returns:
    
    The Amazon OpenSearch Service retry options.
  - withRetryOptions
```
public AmazonopensearchserviceDestinationDescription withRetryOptions(AmazonopensearchserviceRetryOptions retryOptions)
```
    The Amazon OpenSearch Service retry options.
    
    Parameters:
    
    retryOptions - The Amazon OpenSearch Service 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:
    
    AmazonopensearchserviceS3BackupMode
  - getS3BackupMode
```
public String getS3BackupMode()
```
    The Amazon S3 backup mode.
    
    Returns:
    
    The Amazon S3 backup mode.
    
    See Also:
    
    AmazonopensearchserviceS3BackupMode
  - withS3BackupMode
```
public AmazonopensearchserviceDestinationDescription 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:
    
    AmazonopensearchserviceS3BackupMode
  - withS3BackupMode
```
public AmazonopensearchserviceDestinationDescription withS3BackupMode(AmazonopensearchserviceS3BackupMode 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:
    
    AmazonopensearchserviceS3BackupMode
  - setS3DestinationDescription
```
public void setS3DestinationDescription(S3DestinationDescription s3DestinationDescription)
```
    Parameters:
    
    s3DestinationDescription -
  - getS3DestinationDescription
```
public S3DestinationDescription getS3DestinationDescription()
```
    Returns:
  - withS3DestinationDescription
```
public AmazonopensearchserviceDestinationDescription withS3DestinationDescription(S3DestinationDescription s3DestinationDescription)
```
    Parameters:
    
    s3DestinationDescription -
    
    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 AmazonopensearchserviceDestinationDescription 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 AmazonopensearchserviceDestinationDescription withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    Parameters:
    
    cloudWatchLoggingOptions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfigurationDescription
```
public void setVpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)
```
    Parameters:
    
    vpcConfigurationDescription -
  - getVpcConfigurationDescription
```
public VpcConfigurationDescription getVpcConfigurationDescription()
```
    Returns:
  - withVpcConfigurationDescription
```
public AmazonopensearchserviceDestinationDescription withVpcConfigurationDescription(VpcConfigurationDescription vpcConfigurationDescription)
```
    Parameters:
    
    vpcConfigurationDescription -
    
    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 AmazonopensearchserviceDestinationDescription 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 AmazonopensearchserviceDestinationDescription 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.777

Class AmazonopensearchserviceDestinationDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AmazonopensearchserviceDestinationDescription

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

setS3BackupMode

getS3BackupMode

withS3BackupMode

withS3BackupMode

setS3DestinationDescription

getS3DestinationDescription

withS3DestinationDescription

setProcessingConfiguration

getProcessingConfiguration

withProcessingConfiguration

setCloudWatchLoggingOptions

getCloudWatchLoggingOptions

withCloudWatchLoggingOptions

setVpcConfigurationDescription

getVpcConfigurationDescription

withVpcConfigurationDescription

setDocumentIdOptions

getDocumentIdOptions

withDocumentIdOptions

toString

equals

hashCode

clone

marshall