java.lang.Object
org.elasticsearch.script.ScriptMetadata
- All Implemented Interfaces:
Diffable<Metadata.Custom>,Metadata.Custom,NamedDiffable<Metadata.Custom>,NamedWriteable,VersionedNamedWriteable,Writeable,ChunkedToXContent
ScriptMetadata is used to store user-defined scripts
as part of the ClusterState using only an id as the key.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA builder used to modify the currently stored scripts data held within theClusterState.Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
EMPTY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncontext()diff(Metadata.Custom before) Returns serializable object representing differences between this and previousStatebooleanstatic ScriptMetadatafromXContent(XContentParser parser) This will parse XContent intoScriptMetadata.The minimal version of the recipient this object can be sent toReturns the name of the writeable objectinthashCode()static NamedDiff<Metadata.Custom> toString()Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored) Create an iterator ofToXContentchunks for a REST response.voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
isFragment, toXContentChunked, toXContentChunkedV8Methods inherited from interface org.elasticsearch.cluster.metadata.Metadata.Custom
isRestorable
-
Field Details
-
TYPE
The type ofClusterStatedata.- See Also:
-
-
Constructor Details
-
ScriptMetadata
- Throws:
IOException
-
-
Method Details
-
fromXContent
This will parse XContent intoScriptMetadata. The following format will be parsed:{ "<id>" : "<{@link StoredScriptSource#fromXContent(XContentParser, boolean)}>", "<id>" : "<{@link StoredScriptSource#fromXContent(XContentParser, boolean)}>", ... }- Throws:
IOException
-
readDiffFrom
- Throws:
IOException
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContentChunked
Description copied from interface:ChunkedToXContentCreate an iterator ofToXContentchunks for a REST response. Each chunk is serialized with the sameXContentBuilderandToXContent.Params, which is also the same as theToXContent.Paramspassed as theparamsargument. For best results, all chunks should beO(1)size. The last chunk in the iterator must always yield at least one byte of output. See alsoChunkedToXContentHelperfor some handy utilities.Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.
- Specified by:
toXContentChunkedin interfaceChunkedToXContent- Returns:
- iterator over chunks of
ToXContent
-
diff
Description copied from interface:DiffableReturns serializable object representing differences between this and previousState- Specified by:
diffin interfaceDiffable<Metadata.Custom>
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object- Specified by:
getWriteableNamein interfaceNamedWriteable- Specified by:
getWriteableNamein interfaceVersionedNamedWriteable
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to- Specified by:
getMinimalSupportedVersionin interfaceVersionedNamedWriteable
-
context
- Specified by:
contextin interfaceMetadata.Custom
-
equals
-
hashCode
public int hashCode() -
toString
-