Package org.opensearch.action.admin.indices.template.put

Class PutComposableIndexTemplateAction.Request

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest<PutComposableIndexTemplateAction.Request>

org.opensearch.action.admin.indices.template.put.PutComposableIndexTemplateAction.Request

All Implemented Interfaces:

IndicesRequest, org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

Enclosing class:

PutComposableIndexTemplateAction

@PublicApi(since="1.0.0")
public static class PutComposableIndexTemplateAction.Request
extends ClusterManagerNodeRequest<PutComposableIndexTemplateAction.Request>
implements IndicesRequest

A request for putting a single index template into the cluster state

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
Request(String name)	Constructs a new put index template request with the provided name.
Request(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	cause()
PutComposableIndexTemplateAction.Request	cause(String cause)	The cause for this index template creation.
boolean	create()
PutComposableIndexTemplateAction.Request	create(boolean create)	Set to true to force only creation, not an update of an index template.
boolean	equals(Object obj)
int	hashCode()
ComposableIndexTemplate	indexTemplate()
PutComposableIndexTemplateAction.Request	indexTemplate(ComposableIndexTemplate template)	The index template that will be inserted into the cluster state
String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
String	name()	The name of the index template.
String	toString()
ActionRequestValidationException	validate()
ActionRequestValidationException	validateIndexTemplate(ActionRequestValidationException validationException)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, clusterManagerNodeTimeout, clusterManagerNodeTimeout, masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

Request

public Request(org.opensearch.core.common.io.stream.StreamInput in)
        throws IOException

Throws:

IOException

Request

public Request(String name)

Constructs a new put index template request with the provided name.

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class ClusterManagerNodeRequest<PutComposableIndexTemplateAction.Request>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

validateIndexTemplate

public ActionRequestValidationException validateIndexTemplate(@Nullable
 ActionRequestValidationException validationException)

name

public String name()

The name of the index template.

create

public PutComposableIndexTemplateAction.Request create(boolean create)

Set to true to force only creation, not an update of an index template. If it already exists, it will fail with an IllegalArgumentException.

create

public boolean create()

cause

public PutComposableIndexTemplateAction.Request cause(@Nullable
 String cause)

The cause for this index template creation.

cause

@Nullable
public String cause()

indexTemplate

public PutComposableIndexTemplateAction.Request indexTemplate(ComposableIndexTemplate template)

The index template that will be inserted into the cluster state

indexTemplate

public ComposableIndexTemplate indexTemplate()

toString

public String toString()

Overrides:

toString in class Object

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object