Module org.elasticsearch.xcore
Package org.elasticsearch.xpack.core.inference.regionpolicy

Record Class RegionPolicyDoc

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.core.inference.regionpolicy.RegionPolicyDoc
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject
public record RegionPolicyDoc(RegionPolicy regionPolicy, Instant createdAt, String createdBy, Instant updatedAt, String updatedBy) extends Record implements ToXContentObject, Writeable

  • Field Details

    • REGION_POLICY_FIELD

      public static final ParseField REGION_POLICY_FIELD

    • CREATED_AT_FIELD

      public static final ParseField CREATED_AT_FIELD

    • CREATED_BY_FIELD

      public static final ParseField CREATED_BY_FIELD

    • UPDATED_AT_FIELD

      public static final ParseField UPDATED_AT_FIELD

    • UPDATED_BY_FIELD

      public static final ParseField UPDATED_BY_FIELD

    • DOCUMENT_ID

      public static final String DOCUMENT_ID
      The document id for region policies. We currently only support region policy for the elastic inference service. We add "elastic" to the document id to avoid conflicts with other inference services in the future.
      See Also:

    • STRICT_PARSER

      public static final ConstructingObjectParser<RegionPolicyDoc,Void> STRICT_PARSER

    • LENIENT_PARSER

      public static final ConstructingObjectParser<RegionPolicyDoc,Void> LENIENT_PARSER

  • Constructor Details

    • RegionPolicyDoc

      public RegionPolicyDoc(StreamInput in) throws IOException
      Throws:
      IOException

    • RegionPolicyDoc

      public RegionPolicyDoc(RegionPolicy regionPolicy, Instant createdAt, @Nullable String createdBy, @Nullable Instant updatedAt, @Nullable String updatedBy)
      Creates an instance of a RegionPolicyDoc record class.
      Parameters:
      regionPolicy - the value for the regionPolicy record component
      createdAt - the value for the createdAt record component
      createdBy - the value for the createdBy record component
      updatedAt - the value for the updatedAt record component
      updatedBy - the value for the updatedBy record component

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toXContent

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

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • regionPolicy

      public RegionPolicy regionPolicy()
      Returns the value of the regionPolicy record component.
      Returns:
      the value of the regionPolicy record component

    • createdAt

      public Instant createdAt()
      Returns the value of the createdAt record component.
      Returns:
      the value of the createdAt record component

    • createdBy

      @Nullable public String createdBy()
      Returns the value of the createdBy record component.
      Returns:
      the value of the createdBy record component

    • updatedAt

      @Nullable public Instant updatedAt()
      Returns the value of the updatedAt record component.
      Returns:
      the value of the updatedAt record component

    • updatedBy

      @Nullable public String updatedBy()
      Returns the value of the updatedBy record component.
      Returns:
      the value of the updatedBy record component