Package org.elasticsearch.cluster.metadata

Record Class DesiredNode

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.metadata.DesiredNode
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public record DesiredNode(Settings settings, int processors, ByteSizeValue memory, ByteSizeValue storage, Version version) extends Record implements Writeable, org.elasticsearch.xcontent.ToXContentObject

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ConstructingObjectParser<DesiredNode,String>
    PARSER
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    DesiredNode(StreamInput in)
     
    DesiredNode(Settings settings, int processors, ByteSizeValue memory, ByteSizeValue storage, Version version)
    Creates an instance of a DesiredNode record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    externalId()
     
    static DesiredNode
    fromXContent(org.elasticsearch.xcontent.XContentParser parser)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    hasMasterRole()
     
    ByteSizeValue
    memory()
    Returns the value of the memory record component.
    int
    processors()
    Returns the value of the processors record component.
    Settings
    settings()
    Returns the value of the settings record component.
    ByteSizeValue
    storage()
    Returns the value of the storage record component.
    final String
    toString()
    Returns a string representation of this record class.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    Version
    version()
    Returns the value of the version record component.
    void
    writeTo(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • Field Details

    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<DesiredNode,String> PARSER

  • Constructor Details

    • DesiredNode

      public DesiredNode(Settings settings, int processors, ByteSizeValue memory, ByteSizeValue storage, Version version)
      Creates an instance of a DesiredNode record class.
      Parameters:
      settings - the value for the settings record component
      processors - the value for the processors record component
      memory - the value for the memory record component
      storage - the value for the storage record component
      version - the value for the version record component

    • DesiredNode

      public DesiredNode(StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • fromXContent

      public static DesiredNode fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException

    • externalId

      public String externalId()

    • hasMasterRole

      public boolean hasMasterRole()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • settings

      public Settings settings()
      Returns the value of the settings record component.
      Returns:
      the value of the settings record component

    • processors

      public int processors()
      Returns the value of the processors record component.
      Returns:
      the value of the processors record component

    • memory

      public ByteSizeValue memory()
      Returns the value of the memory record component.
      Returns:
      the value of the memory record component

    • storage

      public ByteSizeValue storage()
      Returns the value of the storage record component.
      Returns:
      the value of the storage record component

    • version

      public Version version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component