java.lang.Object
org.elasticsearch.cluster.AbstractNamedDiffable<Metadata.ProjectCustom>
org.elasticsearch.cluster.metadata.StreamsMetadata
- All Implemented Interfaces:
Diffable<Metadata.ProjectCustom>,Metadata.MetadataCustom<Metadata.ProjectCustom>,Metadata.ProjectCustom,NamedDiffable<Metadata.ProjectCustom>,NamedWriteable,VersionedNamedWriteable,Writeable,ChunkedToXContent
public class StreamsMetadata
extends AbstractNamedDiffable<Metadata.ProjectCustom>
implements Metadata.ProjectCustom
Metadata for the Streams feature, which allows enabling or disabling logs for data streams.
This class implements the Metadata.ProjectCustom interface to allow it to be stored in the cluster state.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncontext()booleanstatic StreamsMetadatafromXContent(XContentParser parser) The minimal version of the recipient this object can be sent to.Returns the name of the writeable objectinthashCode()booleanstatic NamedDiff<Metadata.ProjectCustom> booleansupportsVersion(TransportVersion version) Determines whether this instance should be serialized based on the provided transport version.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 org.elasticsearch.cluster.AbstractNamedDiffable
diff, get, readDiffFromMethods 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
isRestorable
-
Field Details
-
TYPE
- See Also:
-
EMPTY
-
logsEnabled
public boolean logsEnabled
-
-
Constructor Details
-
StreamsMetadata
- Throws:
IOException
-
StreamsMetadata
public StreamsMetadata(boolean logsEnabled)
-
-
Method Details
-
isLogsEnabled
public boolean isLogsEnabled() -
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
-
supportsVersion
Description copied from interface:VersionedNamedWriteableDetermines whether this instance should be serialized based on the provided transport version. The default implementation returnstrueif the given transport version is equal to or newer thanVersionedNamedWriteable.getMinimalSupportedVersion(). Subclasses may override this method to define custom serialization logic.- Specified by:
supportsVersionin interfaceVersionedNamedWriteable- Parameters:
version- the transport version of the receiving node- Returns:
trueif the instance should be serialized,falseotherwise
-
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
-
equals
-
hashCode
public int hashCode() -
fromXContent
- Throws:
IOException
-