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.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
public class GetModelSnapshotsRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.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.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.ParseField DESC  
    static org.elasticsearch.common.ParseField END  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<GetModelSnapshotsRequest,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField SNAPSHOT_ID  
    static org.elasticsearch.common.ParseField SORT  
    static org.elasticsearch.common.ParseField START  

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

    EMPTY_PARAMS

  • Constructor Summary

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

  • Method Summary

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

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

    isFragment

  • Field Details

    • SNAPSHOT_ID

      public static final org.elasticsearch.common.ParseField SNAPSHOT_ID

    • SORT

      public static final org.elasticsearch.common.ParseField SORT

    • START

      public static final org.elasticsearch.common.ParseField START

    • END

      public static final org.elasticsearch.common.ParseField END

    • DESC

      public static final org.elasticsearch.common.ParseField DESC

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<GetModelSnapshotsRequest,​java.lang.Void> PARSER

  • Constructor Details

    • GetModelSnapshotsRequest

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

    • getSnapshotId

      public java.lang.String getSnapshotId()

    • setSnapshotId

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

    • getSort

      public java.lang.String getSort()

    • setSort

      public void setSort​(java.lang.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 java.lang.String getStart()

    • setStart

      public void setStart​(java.lang.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 java.lang.String getEnd()

    • setEnd

      public void setEnd​(java.lang.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 java.lang.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.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