Package org.opensearch.action.ingest

Class PutPipelineRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest<PutPipelineRequest>

org.opensearch.action.support.master.MasterNodeRequest<PutPipelineRequest>

org.opensearch.action.support.master.AcknowledgedRequest<PutPipelineRequest>

org.opensearch.action.ingest.PutPipelineRequest

All Implemented Interfaces:

AckedRequest, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, TaskAwareRequest

@PublicApi(since="1.0.0")
public class PutPipelineRequest
extends AcknowledgedRequest<PutPipelineRequest>
implements org.opensearch.core.xcontent.ToXContentObject

transport request to put a pipeline

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.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, DEFAULT_TASK_EXECUTION_TIMEOUT, timeout

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

clusterManagerNodeTimeout, DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PutPipelineRequest(String id, org.opensearch.core.common.bytes.BytesReference source, org.opensearch.core.xcontent.MediaType mediaType)	Create a new pipeline request with the id and source along with the content type of the source
PutPipelineRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	getId()
org.opensearch.core.xcontent.MediaType	getMediaType()
org.opensearch.core.common.bytes.BytesReference	getSource()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

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

ackTimeout, timeout, timeout, timeout

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.cluster.ack.AckedRequest

clusterManagerNodeTimeout, masterNodeTimeout

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Constructor Details

PutPipelineRequest

public PutPipelineRequest(String id,
 org.opensearch.core.common.bytes.BytesReference source,
 org.opensearch.core.xcontent.MediaType mediaType)

Create a new pipeline request with the id and source along with the content type of the source

PutPipelineRequest

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

Throws:

IOException

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

getId

public String getId()

getSource

public org.opensearch.core.common.bytes.BytesReference getSource()

getMediaType

public org.opensearch.core.xcontent.MediaType getMediaType()

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 AcknowledgedRequest<PutPipelineRequest>

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException