Package software.amazon.awssdk.services.iot.model

Class ElasticsearchAction

java.lang.Object

software.amazon.awssdk.services.iot.model.ElasticsearchAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ElasticsearchAction.Builder,ElasticsearchAction>

@Generated("software.amazon.awssdk:codegen")
public final class ElasticsearchAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ElasticsearchAction.Builder,ElasticsearchAction>

Describes an action that writes data to an Amazon OpenSearch Service domain.

The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ElasticsearchAction.Builder

Method Summary

Modifier and Type	Method	Description
static ElasticsearchAction.Builder	builder()
String	endpoint()	The endpoint of your OpenSearch domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique identifier for the document you are storing.
String	index()	The index where you want to store your data.
String	roleArn()	The IAM role ARN that has access to OpenSearch.
List<SdkField<?>>	sdkFields()
static Class<? extends ElasticsearchAction.Builder>	serializableBuilderClass()
ElasticsearchAction.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The type of document you are storing.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

roleArn

public final String roleArn()

The IAM role ARN that has access to OpenSearch.

Returns:

The IAM role ARN that has access to OpenSearch.

endpoint

public final String endpoint()

The endpoint of your OpenSearch domain.

Returns:

The endpoint of your OpenSearch domain.

index

public final String index()

The index where you want to store your data.

Returns:

The index where you want to store your data.

type

public final String type()

The type of document you are storing.

Returns:

The type of document you are storing.

id

public final String id()

The unique identifier for the document you are storing.

Returns:

The unique identifier for the document you are storing.

toBuilder

public ElasticsearchAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ElasticsearchAction.Builder,ElasticsearchAction>

builder

public static ElasticsearchAction.Builder builder()

serializableBuilderClass

public static Class<? extends ElasticsearchAction.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo