PutIndexedScriptRequest (core 5.0.0-alpha1 API)

java.lang.Object
- org.elasticsearch.transport.TransportMessage
- - org.elasticsearch.transport.TransportRequest
  - - org.elasticsearch.action.ActionRequest<PutIndexedScriptRequest>
    - - org.elasticsearch.action.indexedscripts.put.PutIndexedScriptRequest

All Implemented Interfaces:

IndicesRequest, Streamable
```
public class PutIndexedScriptRequest
extends ActionRequest<PutIndexedScriptRequest>
implements IndicesRequest
```
Index request to index a script to the script index and make it available at search time.
The request requires the scriptLang(String), id(String) and source(byte[]) to be set.
The source (content to index) can be set in its bytes form using (source() (byte[])}), its string form (source(String)) or using a XContentBuilder (source(org.elasticsearch.common.xcontent.XContentBuilder)).
If the id(String) is not set, it will be automatically generated.

See Also:

PutIndexedScriptResponse

Nested Class Summary
- Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
  IndicesRequest.Replaceable

Constructor Summary

Constructors
Constructor and Description
`PutIndexedScriptRequest()`
`PutIndexedScriptRequest(java.lang.String scriptLang)` Constructs a new index request against the specific index and type.
`PutIndexedScriptRequest(java.lang.String scriptLang, java.lang.String id)` Constructs a new index request against the index, type, id and using the source.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutIndexedScriptRequest`	`contentType(XContentType contentType)` Sets the content type that will be used when generating a document from user provided objects (like Map).
`PutIndexedScriptRequest`	`create(boolean create)` Set to `true` to force this index to use `IndexRequest.OpType.CREATE`.
`java.lang.String`	`id()` The id of the indexed document.
`PutIndexedScriptRequest`	`id(java.lang.String id)` Sets the id of the indexed document.
`java.lang.String[]`	`indices()` Returns the array of indices that the action relates to
`IndicesOptions`	`indicesOptions()` Returns the indices options used to resolve indices.
`IndexRequest.OpType`	`opType()` The type of operation to perform.
`PutIndexedScriptRequest`	`opType(IndexRequest.OpType opType)` Sets the type of operation to perform.
`void`	`readFrom(StreamInput in)` Set this object's fields from a StreamInput.
`java.lang.String`	`scriptLang()` The type of the indexed document.
`PutIndexedScriptRequest`	`scriptLang(java.lang.String scriptLang)` Sets the type of the indexed document.
`BytesReference`	`source()` The source of the document to index, recopied to a new array if it is unsafe.
`PutIndexedScriptRequest`	`source(byte[] source)` Sets the document to index in bytes form.
`PutIndexedScriptRequest`	`source(byte[] source, int offset, int length)` Sets the document to index in bytes form (assumed to be safe to be used from different threads).
`PutIndexedScriptRequest`	`source(BytesReference source)` Sets the document to index in bytes form.
`PutIndexedScriptRequest`	`source(java.util.Map source)` Index the Map as a `Requests.INDEX_CONTENT_TYPE`.
`PutIndexedScriptRequest`	`source(java.util.Map source, XContentType contentType)` Index the Map as the provided content type.
`PutIndexedScriptRequest`	`source(java.lang.Object... source)`
`PutIndexedScriptRequest`	`source(java.lang.String source)` Sets the document source to index.
`PutIndexedScriptRequest`	`source(XContentBuilder sourceBuilder)` Sets the content source to index.
`java.util.Map<java.lang.String,java.lang.Object>`	`sourceAsMap()`
`java.lang.String`	`toString()`
`ActionRequestValidationException`	`validate()`
`long`	`version()`
`PutIndexedScriptRequest`	`version(long version)` Sets the version, which will cause the index operation to only be performed if a matching version exists and no changes happened on the doc since then.
`VersionType`	`versionType()`
`PutIndexedScriptRequest`	`versionType(VersionType versionType)` Sets the versioning type.
`void`	`writeTo(StreamOutput out)` Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportRequest
createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutIndexedScriptRequest
```
public PutIndexedScriptRequest()
```
  - PutIndexedScriptRequest
```
public PutIndexedScriptRequest(java.lang.String scriptLang)
```
    Constructs a new index request against the specific index and type. The source(byte[]) must be set.
  - PutIndexedScriptRequest
```
public PutIndexedScriptRequest(java.lang.String scriptLang,
                               java.lang.String id)
```
    Constructs a new index request against the index, type, id and using the source.
    
    Parameters:
    
    scriptLang - The scriptLang to index into
    
    id - The id of document
- Method Detail
  - validate
```
public ActionRequestValidationException validate()
```
    Specified by:
    
    validate in class ActionRequest<PutIndexedScriptRequest>
  - indices
```
public java.lang.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
  - contentType
```
public PutIndexedScriptRequest contentType(XContentType contentType)
```
    Sets the content type that will be used when generating a document from user provided objects (like Map).
  - scriptLang
```
public java.lang.String scriptLang()
```
    The type of the indexed document.
  - scriptLang
```
public PutIndexedScriptRequest scriptLang(java.lang.String scriptLang)
```
    Sets the type of the indexed document.
  - id
```
public java.lang.String id()
```
    The id of the indexed document. If not set, will be automatically generated.
  - id
```
public PutIndexedScriptRequest id(java.lang.String id)
```
    Sets the id of the indexed document. If not set, will be automatically generated.
  - source
```
public BytesReference source()
```
    The source of the document to index, recopied to a new array if it is unsafe.
  - sourceAsMap
```
public java.util.Map<java.lang.String,java.lang.Object> sourceAsMap()
```
  - source
```
public PutIndexedScriptRequest source(java.util.Map source)
                               throws ElasticsearchGenerationException
```
    Index the Map as a Requests.INDEX_CONTENT_TYPE.
    
    Parameters:
    
    source - The map to index
    
    Throws:
    
    ElasticsearchGenerationException
  - source
```
public PutIndexedScriptRequest source(java.util.Map source,
                                      XContentType contentType)
                               throws ElasticsearchGenerationException
```
    Index the Map as the provided content type.
    
    Parameters:
    
    source - The map to index
    
    Throws:
    
    ElasticsearchGenerationException
  - source
```
public PutIndexedScriptRequest source(java.lang.String source)
```
    Sets the document source to index.
    Note, its preferable to either set it using source(org.elasticsearch.common.xcontent.XContentBuilder) or using the source(byte[]).
  - source
```
public PutIndexedScriptRequest source(XContentBuilder sourceBuilder)
```
    Sets the content source to index.
  - source
```
public PutIndexedScriptRequest source(java.lang.Object... source)
```
  - source
```
public PutIndexedScriptRequest source(BytesReference source)
```
    Sets the document to index in bytes form.
  - source
```
public PutIndexedScriptRequest source(byte[] source)
```
    Sets the document to index in bytes form.
  - source
```
public PutIndexedScriptRequest source(byte[] source,
                                      int offset,
                                      int length)
```
    Sets the document to index in bytes form (assumed to be safe to be used from different threads).
    
    Parameters:
    
    source - The source to index
    
    offset - The offset in the byte array
    
    length - The length of the data
  - opType
```
public PutIndexedScriptRequest opType(IndexRequest.OpType opType)
```
    Sets the type of operation to perform.
  - create
```
public PutIndexedScriptRequest create(boolean create)
```
    Set to true to force this index to use IndexRequest.OpType.CREATE.
  - opType
```
public IndexRequest.OpType opType()
```
    The type of operation to perform.
  - version
```
public PutIndexedScriptRequest version(long version)
```
    Sets the version, which will cause the index operation to only be performed if a matching version exists and no changes happened on the doc since then.
  - version
```
public long version()
```
  - versionType
```
public PutIndexedScriptRequest versionType(VersionType versionType)
```
    Sets the versioning type. Defaults to VersionType.INTERNAL.
  - versionType
```
public VersionType versionType()
```
  - readFrom
```
public void readFrom(StreamInput in)
              throws java.io.IOException
```
    Description copied from interface: Streamable
    
    Set this object's fields from a StreamInput.
    
    Specified by:
    
    readFrom in interface Streamable
    
    Overrides:
    
    readFrom in class ActionRequest<PutIndexedScriptRequest>
    
    Throws:
    
    java.io.IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws java.io.IOException
```
    Description copied from interface: Streamable
    
    Write this object's fields to a StreamOutput.
    
    Specified by:
    
    writeTo in interface Streamable
    
    Overrides:
    
    writeTo in class ActionRequest<PutIndexedScriptRequest>
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PutIndexedScriptRequest

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class org.elasticsearch.transport.TransportRequest

Methods inherited from class org.elasticsearch.transport.TransportMessage

Methods inherited from class java.lang.Object

Constructor Detail

PutIndexedScriptRequest

PutIndexedScriptRequest

PutIndexedScriptRequest

Method Detail

validate

indices

indicesOptions

contentType

scriptLang

scriptLang

id

id

source

sourceAsMap

source

source

source

source

source

source

source

source

opType

create

opType

version

version

versionType

versionType

readFrom

writeTo

toString