Package com.stripe.model.sigma

Class ScheduledQueryRun

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.sigma.ScheduledQueryRun
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class ScheduledQueryRun extends ApiResource implements HasId
If you have scheduled a Sigma query, you'll receive a sigma.scheduled_query_run.created webhook each time the query runs. The webhook contains a ScheduledQueryRun object, which you can use to retrieve the query results.

  • Constructor Details

    • ScheduledQueryRun

      public ScheduledQueryRun()

  • Method Details

    • list

      public static ScheduledQueryRunCollection list(Map<String,Object> params) throws StripeException
      Returns a list of scheduled query runs.
      Throws:
      StripeException

    • list

      public static ScheduledQueryRunCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of scheduled query runs.
      Throws:
      StripeException

    • list

      public static ScheduledQueryRunCollection list(ScheduledQueryRunListParams params) throws StripeException
      Returns a list of scheduled query runs.
      Throws:
      StripeException

    • list

      public static ScheduledQueryRunCollection list(ScheduledQueryRunListParams params, RequestOptions options) throws StripeException
      Returns a list of scheduled query runs.
      Throws:
      StripeException

    • retrieve

      public static ScheduledQueryRun retrieve(String scheduledQueryRun) throws StripeException
      Retrieves the details of an scheduled query run.
      Throws:
      StripeException

    • retrieve

      public static ScheduledQueryRun retrieve(String scheduledQueryRun, RequestOptions options) throws StripeException
      Retrieves the details of an scheduled query run.
      Throws:
      StripeException

    • retrieve

      public static ScheduledQueryRun retrieve(String scheduledQueryRun, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of an scheduled query run.
      Throws:
      StripeException

    • retrieve

      public static ScheduledQueryRun retrieve(String scheduledQueryRun, ScheduledQueryRunRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of an scheduled query run.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getDataLoadTime

      public Long getDataLoadTime()
      When the query was run, Sigma contained a snapshot of your Stripe data at this time.

    • getError

      public ScheduledQueryRun.Errors getError()

    • getFile

      public File getFile()
      The file object representing the results of the query.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to scheduled_query_run.

    • getResultAvailableUntil

      public Long getResultAvailableUntil()
      Time at which the result expires and is no longer available for download.

    • getSql

      public String getSql()
      SQL for the query.

    • getStatus

      public String getStatus()
      The query's execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.

    • getTitle

      public String getTitle()
      Title of the query.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setDataLoadTime

      public void setDataLoadTime(Long dataLoadTime)
      When the query was run, Sigma contained a snapshot of your Stripe data at this time.

    • setError

      public void setError(ScheduledQueryRun.Errors error)

    • setFile

      public void setFile(File file)
      The file object representing the results of the query.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to scheduled_query_run.

    • setResultAvailableUntil

      public void setResultAvailableUntil(Long resultAvailableUntil)
      Time at which the result expires and is no longer available for download.

    • setSql

      public void setSql(String sql)
      SQL for the query.

    • setStatus

      public void setStatus(String status)
      The query's execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.

    • setTitle

      public void setTitle(String title)
      Title of the query.

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId