Class AmazonopensearchserviceDestinationDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AmazonopensearchserviceDestinationDescription.Builder,
AmazonopensearchserviceDestinationDescription>
The destination description in Amazon OpenSearch Service.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionThe buffering options.builder()
final CloudWatchLoggingOptions
Returns the value of the CloudWatchLoggingOptions property for this object.final String
The endpoint to use when communicating with the cluster.final DocumentIdOptions
Indicates the method for setting up document ID.final String
The ARN of the Amazon OpenSearch Service domain.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The Amazon OpenSearch Service index name.The Amazon OpenSearch Service index rotation periodfinal String
The Amazon OpenSearch Service index rotation periodfinal ProcessingConfiguration
Returns the value of the ProcessingConfiguration property for this object.The Amazon OpenSearch Service retry options.final String
roleARN()
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.The Amazon S3 backup mode.final String
The Amazon S3 backup mode.final S3DestinationDescription
Returns the value of the S3DestinationDescription property for this object.static Class
<? extends AmazonopensearchserviceDestinationDescription.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
typeName()
The Amazon OpenSearch Service type name.Returns the value of the VpcConfigurationDescription property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
roleARN
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
-
domainARN
The ARN of the Amazon OpenSearch Service domain.
- Returns:
- The ARN of the Amazon OpenSearch Service domain.
-
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:
- 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.
-
indexName
The Amazon OpenSearch Service index name.
- Returns:
- The Amazon OpenSearch Service index name.
-
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:
- 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.
-
indexRotationPeriod
The Amazon OpenSearch Service index rotation period
If the service returns an enum value that is not available in the current SDK version,
indexRotationPeriod
will returnAmazonopensearchserviceIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexRotationPeriodAsString()
.- Returns:
- The Amazon OpenSearch Service index rotation period
- See Also:
-
indexRotationPeriodAsString
The Amazon OpenSearch Service index rotation period
If the service returns an enum value that is not available in the current SDK version,
indexRotationPeriod
will returnAmazonopensearchserviceIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexRotationPeriodAsString()
.- Returns:
- The Amazon OpenSearch Service index rotation period
- See Also:
-
bufferingHints
The buffering options.
- Returns:
- The buffering options.
-
retryOptions
The Amazon OpenSearch Service retry options.
- Returns:
- The Amazon OpenSearch Service retry options.
-
s3BackupMode
The Amazon S3 backup mode.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnAmazonopensearchserviceS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- The Amazon S3 backup mode.
- See Also:
-
s3BackupModeAsString
The Amazon S3 backup mode.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnAmazonopensearchserviceS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- The Amazon S3 backup mode.
- See Also:
-
s3DestinationDescription
Returns the value of the S3DestinationDescription property for this object.- Returns:
- The value of the S3DestinationDescription property for this object.
-
processingConfiguration
Returns the value of the ProcessingConfiguration property for this object.- Returns:
- The value of the ProcessingConfiguration property for this object.
-
cloudWatchLoggingOptions
Returns the value of the CloudWatchLoggingOptions property for this object.- Returns:
- The value of the CloudWatchLoggingOptions property for this object.
-
vpcConfigurationDescription
Returns the value of the VpcConfigurationDescription property for this object.- Returns:
- The value of the VpcConfigurationDescription property for this object.
-
documentIdOptions
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AmazonopensearchserviceDestinationDescription.Builder,
AmazonopensearchserviceDestinationDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AmazonopensearchserviceDestinationDescription.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-