Package org.elasticsearch.client.ml

Class UpdateModelSnapshotRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.UpdateModelSnapshotRequest
All Implemented Interfaces:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.core.RefCounted, org.elasticsearch.tasks.TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class UpdateModelSnapshotRequest extends org.elasticsearch.action.ActionRequest implements org.elasticsearch.xcontent.ToXContentObject
A request to update information about an existing model snapshot for a given job

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

    org.elasticsearch.transport.TransportRequest.Empty

    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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

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

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • 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.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    org.elasticsearch.action.ActionRequestValidationException
    validate()
     

    Methods inherited from class org.elasticsearch.action.ActionRequest

    getShouldStoreResult, writeTo

    Methods inherited from class org.elasticsearch.transport.TransportRequest

    getParentTask, setParentTask, toString

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, setParentTask

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • 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()
      Specified by:
      getDescription in interface org.elasticsearch.tasks.TaskAwareRequest

    • 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

    • validate

      public org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest

    • 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

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object