# Schedule

A Schedule is a time schedule of when a User will use a query.

> **Package : spaceone.api.statistics.v1**

\
\


## Schedule

**Schedule Methods:**

| Method                                                                                                                  | Request                                                                                                                                         | Response                                                                                                                        |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| [**add**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#add)         | [AddScheduleRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#addschedulerequest)       | [ScheduleInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#scheduleinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#update)   | [UpdateScheduleRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#updateschedulerequest) | [ScheduleInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#scheduleinfo)   |
| [**enable**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#enable)   | [ScheduleRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#schedulerequest)             | [ScheduleInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#scheduleinfo)   |
| [**disable**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#disable) | [ScheduleRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#schedulerequest)             | [ScheduleInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#scheduleinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#delete)   | [ScheduleRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#schedulerequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#empty)                 |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#get)         | [ScheduleRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#schedulerequest)             | [ScheduleInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#scheduleinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#list)       | [ScheduleQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#schedulequery)                 | [SchedulesInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#schedulesinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#stat)       | [ScheduleStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#schedulestatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/statistics/v1/Schedule/README.md#struct)               |

\


### add

Adds a new Schedule. When creating, `topic` and queries to be used should be specified. The time interval of the Schedule should be also specified to run queries repeatedly. The run set by Schedule starts every hour on the hour.

> **POST** /statistics/v1/schedule/add

\


### update

Updates a specific Schedule. You can make changes in Schedule settings, including time intervals.

> **POST** /statistics/schedule/update

\


### enable

Enables a specific Schedule. If a Schedule is enabled, the query usage will be scheduled by the time interval specified.

> **POST** /statistics/v1/schedule/enable

\


### disable

Disables a specific Schedule. If a Schedule is disabled, the query usage will not be scheduled.

> **POST** /statistics/v1/schedule/disable

\


### delete

Deletes a specific Schedule. You must specify the `schedule_id` of the Schedule to delete.

> **POST** /statistics/v1/schedule/delete

\


### get

Gets a specific Schedule. Prints detailed information about the Schedule, including the schedule interval and `state`.

> **POST** /statistics/v1/schedule/get

\


### list

Gets a list of all Schedules. You can use a query to get a filtered list of Schedules.

> **POST** /statistics/v1/schedule/list

\


### stat

> **POST** /statistics/v1/schedule/stat

\
\


## Message

### AddScheduleRequest

* **topic** (string) `Required`
* **options** (Struct) `Required`
* **schedule** (Scheduled) `Required`
*   **tags** (Struct)

    \


### QueryOption

* **aggregate** (StatAggregate) `Required`
*   **page** (StatPage)

    \


### ScheduleInfo

* **schedule\_id** (string) `Required`
* **topic** (string) `Required`
* **state** (State) `Required`
* **options** (Struct) `Required`
* **schedule** (Scheduled) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
*   **last\_scheduled\_at** (string) `Required`

    \


### ScheduleQuery

* **query** (Query)
* **schedule\_id** (string)
* **topic** (string)
*   **state** (string)

    \


### ScheduleRequest

*   **schedule\_id** (string) `Required`

    \


### ScheduleStatQuery

*   **query** (StatisticsQuery) `Required`

    \


### Scheduled

* **cron** (string) `Required`
* **interval** (int32) `Required`
* **minutes** (int32) `Repeated` `Required`
*   **hours** (int32) `Repeated` `Required`

    \


### SchedulesInfo

* **results** (ScheduleInfo) `Repeated` `Required`
*   **total\_count** (int32) `Required`

    \


### UpdateScheduleRequest

* **schedule\_id** (string) `Required`
* **schedule** (Scheduled)
*   **tags** (Struct)

    \
