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.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
public class UpdateModelSnapshotRequest
extends org.elasticsearch.action.ActionRequest
implements 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 class org.elasticsearch.transport.TransportRequest

    org.elasticsearch.transport.TransportRequest.Empty

    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

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

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

  • Field Summary

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

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

    EMPTY_PARAMS

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.lang.String getDescription()  
    java.lang.String getJobId()  
    java.lang.Boolean getRetain()  
    java.lang.String getSnapshotId()  
    int hashCode()  
    void setDescription​(java.lang.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)  
    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

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, setParentTask

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

    isFragment

  • Field Details

  • Constructor Details

    • UpdateModelSnapshotRequest

      public UpdateModelSnapshotRequest​(java.lang.String jobId, java.lang.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 java.lang.String getJobId()

    • getSnapshotId

      public java.lang.String getSnapshotId()

    • getDescription

      public java.lang.String getDescription()
      Specified by:
      getDescription in interface org.elasticsearch.tasks.TaskAwareRequest

    • setDescription

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

    • getRetain

      public java.lang.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.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object