Package org.elasticsearch.xpack.esql.datasources.dataset

Class PutDatasetAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<PutDatasetAction.Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<PutDatasetAction.Request>

org.elasticsearch.xpack.esql.datasources.dataset.PutDatasetAction.Request

All Implemented Interfaces:

IndicesRequest, Writeable, RefCounted, TaskAwareRequest, TransportRequest, DataSourceRequestInfo

Enclosing class:

PutDatasetAction

public static class PutDatasetAction.Request
extends AcknowledgedRequest<PutDatasetAction.Request>
implements IndicesRequest, DataSourceRequestInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PutDatasetAction.Request.ParseContext

Nested classes/interfaces inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

AcknowledgedRequest.Plain

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

IndicesRequest.CrossProjectCandidate, IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

INFINITE_MASTER_NODE_TIMEOUT, TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUT

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Request(StreamInput in)
Request(TimeValue masterNodeTimeout, TimeValue ackTimeout, String name, String dataSource, String resource, String description, Map<String,Object> rawSettings)
Request(TimeValue masterNodeTimeout, TimeValue ackTimeout, String name, String dataSource, String resource, String description, Map<String,Object> rawSettings, DatasetMapping mapping)

Method Summary

Modifier and Type	Method	Description
String	dataSource()
String	dataSourceClusterActionName()	Cluster action used to evaluate global.data_source for the attached datasource on put.
String[]	dataSourceNames()
String	description()
boolean	equals(Object o)
static PutDatasetAction.Request	fromXContent(XContentParser parser, TimeValue masterNodeTimeout, TimeValue ackTimeout, String name)
int	hashCode()
String[]	indices()
IndicesOptions	indicesOptions()
DatasetMapping	mapping()	The parsed declared mapping (the declared mappings block), or null when none was supplied.
String	name()
Map<String,Object>	rawSettings()
String	resource()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, ackTimeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterTerm

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Constructor Details

Request

public Request(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String name,
 String dataSource,
 String resource,
 @Nullable
 String description,
 Map<String,Object> rawSettings)

Request

public Request(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String name,
 String dataSource,
 String resource,
 @Nullable
 String description,
 Map<String,Object> rawSettings,
 @Nullable
 DatasetMapping mapping)

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

fromXContent

public static PutDatasetAction.Request fromXContent(XContentParser parser,
 TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String name)
                                             throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<PutDatasetAction.Request>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Overrides:

validate in class AcknowledgedRequest<PutDatasetAction.Request>

name

public String name()

dataSource

public String dataSource()

dataSourceNames

public String[] dataSourceNames()

Specified by:

dataSourceNames in interface DataSourceRequestInfo

dataSourceClusterActionName

public String dataSourceClusterActionName()

Cluster action used to evaluate global.data_source for the attached datasource on put.

Specified by:

dataSourceClusterActionName in interface DataSourceRequestInfo

resource

public String resource()

description

@Nullable
public String description()

rawSettings

public Map<String,Object> rawSettings()

mapping

@Nullable
public DatasetMapping mapping()

The parsed declared mapping (the declared mappings block), or null when none was supplied.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

indices

public String[] indices()

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Specified by:

indicesOptions in interface IndicesRequest