Module org.elasticsearch.server
Class SamplingMetadata
java.lang.Object
org.elasticsearch.action.admin.indices.sampling.SamplingMetadata
- All Implemented Interfaces:
Diffable<Metadata.ProjectCustom>,Metadata.MetadataCustom<Metadata.ProjectCustom>,Metadata.ProjectCustom,NamedDiffable<Metadata.ProjectCustom>,NamedWriteable,VersionedNamedWriteable,Writeable,ChunkedToXContent
An object to store a map from index name to SamplingConfiguration.
-
Nested Class Summary
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
ConstructorsConstructorDescriptionSamplingMetadata(Map<String, SamplingConfiguration> indexToSamplingConfigMap) Constructs a new SamplingMetadata with the given index to sampling configuration map.Constructs a SamplingMetadata from a StreamInput for wire protocol deserialization. -
Method Summary
Modifier and TypeMethodDescriptioncontext()diff(Metadata.ProjectCustom previousState) Returns serializable object representing differences between this and previousStatebooleanstatic SamplingMetadatafromXContent(XContentParser parser) Parses SamplingMetadata from XContent (JSON).Returns the map of index names to their sampling configurations.The minimal version of the recipient this object can be sent to.Returns the name of the writeable objectinthashCode()static NamedDiff<Metadata.ProjectCustom> Creates a named diff that can be used to deserialize SamplingMetadata diffs from wire protocol.Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params) 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, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
isFragment, toXContentChunked, toXContentChunkedV8Methods inherited from interface org.elasticsearch.cluster.metadata.Metadata.MetadataCustom
isRestorableMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
supportsVersion
-
Field Details
-
SAMPLING_CONFIGURATION
-
TYPE
- See Also:
-
-
Constructor Details
-
SamplingMetadata
Constructs a new SamplingMetadata with the given index to sampling configuration map.- Parameters:
indexToSamplingConfigMap- A map from index name to sampling configuration. The map is copied to ensure the immutability of the metadata object.
-
SamplingMetadata
Constructs a SamplingMetadata from a StreamInput for wire protocol deserialization.- Parameters:
in- The StreamInput to read from- Throws:
IOException- If an I/O error occurs during deserialization
-
-
Method Details
-
getIndexToSamplingConfigMap
Returns the map of index names to their sampling configurations.- Returns:
- An unmodifiable view of the index to sampling configuration map
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
fromXContent
Parses SamplingMetadata from XContent (JSON).- Parameters:
parser- The XContentParser to parse from- Returns:
- The parsed SamplingMetadata object
- Throws:
IOException- If parsing fails due to invalid JSON or I/O errors
-
equals
-
hashCode
public int hashCode() -
context
- Specified by:
contextin interfaceMetadata.MetadataCustom<Metadata.ProjectCustom>
-
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. SeeVersionedNamedWriteable.supportsVersion(TransportVersion)for the default serialization check.- Specified by:
getMinimalSupportedVersionin interfaceVersionedNamedWriteable
-
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.ProjectCustom>
-
readDiffFrom
Creates a named diff that can be used to deserialize SamplingMetadata diffs from wire protocol.- Parameters:
in- The StreamInput to read the diff from- Returns:
- A NamedDiff that can be applied to produce the target SamplingMetadata
- Throws:
IOException- If an I/O error occurs during deserialization
-