Package org.elasticsearch.client.ml

Class UpdateModelSnapshotRequest

java.lang.Object
org.elasticsearch.client.ml.UpdateModelSnapshotRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class UpdateModelSnapshotRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
A request to update information about an existing model snapshot for a given job

  • Nested Class Summary

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

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<UpdateModelSnapshotRequest,​Void>
    PARSER
     

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • Constructor Summary

    Constructors
    Constructor
    Description
    UpdateModelSnapshotRequest​(String jobId, String snapshotId)
    Constructs a request to update information for a snapshot of given job

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object obj)
     
    String
    getDescription()
     
    String
    getJobId()
     
    Boolean
    getRetain()
     
    String
    getSnapshotId()
     
    int
    hashCode()
     
    void
    setDescription​(String description)
    The new description of the snapshot.
    void
    setRetain​(boolean retain)
    The new value of the "retain" property of the snapshot
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Field Details

  • Constructor Details

    • UpdateModelSnapshotRequest

      public UpdateModelSnapshotRequest​(String jobId, String snapshotId)
      Constructs a request to update information for a snapshot of given job
      Parameters:
      jobId - id of the job from which to retrieve results
      snapshotId - id of the snapshot from which to retrieve results

  • Method Details

    • getJobId

      public String getJobId()

    • getSnapshotId

      public String getSnapshotId()

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription​(String description)
      The new description of the snapshot.
      Parameters:
      description - the updated snapshot description

    • getRetain

      public Boolean getRetain()

    • setRetain

      public void setRetain​(boolean retain)
      The new value of the "retain" property of the snapshot
      Parameters:
      retain - the updated retain property

    • toXContent

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

    • equals

      public boolean equals​(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object