Package org.elasticsearch.client.ml

Class GetModelSnapshotsRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetModelSnapshotsRequest
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 GetModelSnapshotsRequest extends org.elasticsearch.action.ActionRequest implements org.elasticsearch.xcontent.ToXContentObject
A request to retrieve information about model snapshots 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.ParseField
    DESC
     
    static final org.elasticsearch.xcontent.ParseField
    END
     
    static final org.elasticsearch.xcontent.ConstructingObjectParser<GetModelSnapshotsRequest,Void>
    PARSER
     
    static final org.elasticsearch.xcontent.ParseField
    SNAPSHOT_ID
     
    static final org.elasticsearch.xcontent.ParseField
    SORT
     
    static final org.elasticsearch.xcontent.ParseField
    START
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    GetModelSnapshotsRequest(String jobId)
    Constructs a request to retrieve snapshot information from a given job

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Boolean
    getDesc()
     
    String
    getEnd()
     
    String
    getJobId()
     
    PageParams
    getPageParams()
     
    String
    getSnapshotId()
     
    String
    getSort()
     
    String
    getStart()
     
    int
    hashCode()
     
    void
    setDesc(boolean desc)
    Sets the value of "desc".
    void
    setEnd(String end)
    Sets the value of "end" which is a timestamp.
    void
    setPageParams(PageParams pageParams)
    Sets the paging parameters
    void
    setSnapshotId(String snapshotId)
    Sets the id of the snapshot to retrieve.
    void
    setSort(String sort)
    Sets the value of "sort".
    void
    setStart(String start)
    Sets the value of "start" which is a timestamp.
    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, getDescription, setParentTask

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • Field Details

    • SNAPSHOT_ID

      public static final org.elasticsearch.xcontent.ParseField SNAPSHOT_ID

    • SORT

      public static final org.elasticsearch.xcontent.ParseField SORT

    • START

      public static final org.elasticsearch.xcontent.ParseField START

    • END

      public static final org.elasticsearch.xcontent.ParseField END

    • DESC

      public static final org.elasticsearch.xcontent.ParseField DESC

    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<GetModelSnapshotsRequest,Void> PARSER

  • Constructor Details

    • GetModelSnapshotsRequest

      public GetModelSnapshotsRequest(String jobId)
      Constructs a request to retrieve snapshot information from a given job
      Parameters:
      jobId - id of the job from which to retrieve results

  • Method Details

    • getJobId

      public String getJobId()

    • getSnapshotId

      public String getSnapshotId()

    • setSnapshotId

      public void setSnapshotId(String snapshotId)
      Sets the id of the snapshot to retrieve.
      Parameters:
      snapshotId - the snapshot id

    • getSort

      public String getSort()

    • setSort

      public void setSort(String sort)
      Sets the value of "sort". Specifies the snapshot field to sort on.
      Parameters:
      sort - value of "sort".

    • getPageParams

      public PageParams getPageParams()

    • setPageParams

      public void setPageParams(PageParams pageParams)
      Sets the paging parameters
      Parameters:
      pageParams - the paging parameters

    • getStart

      public String getStart()

    • setStart

      public void setStart(String start)
      Sets the value of "start" which is a timestamp. Only snapshots whose timestamp is on or after the "start" value will be returned.
      Parameters:
      start - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getEnd

      public String getEnd()

    • setEnd

      public void setEnd(String end)
      Sets the value of "end" which is a timestamp. Only snapshots whose timestamp is before the "end" value will be returned.
      Parameters:
      end - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getDesc

      public Boolean getDesc()

    • setDesc

      public void setDesc(boolean desc)
      Sets the value of "desc". Specifies the sorting order.
      Parameters:
      desc - value of "desc"

    • 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