Documentation
¶
Index ¶
- type Client
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- func (a *Client) SystemJobsSystemJobsCancelCreate(params *SystemJobsSystemJobsCancelCreateParams) (*SystemJobsSystemJobsCancelCreateCreated, error)
- func (a *Client) SystemJobsSystemJobsCancelRead(params *SystemJobsSystemJobsCancelReadParams) (*SystemJobsSystemJobsCancelReadOK, error)
- func (a *Client) SystemJobsSystemJobsDelete(params *SystemJobsSystemJobsDeleteParams) (*SystemJobsSystemJobsDeleteNoContent, error)
- func (a *Client) SystemJobsSystemJobsEventsList(params *SystemJobsSystemJobsEventsListParams) (*SystemJobsSystemJobsEventsListOK, error)
- func (a *Client) SystemJobsSystemJobsList(params *SystemJobsSystemJobsListParams) (*SystemJobsSystemJobsListOK, error)
- func (a *Client) SystemJobsSystemJobsNotificationsList(params *SystemJobsSystemJobsNotificationsListParams) (*SystemJobsSystemJobsNotificationsListOK, error)
- func (a *Client) SystemJobsSystemJobsRead(params *SystemJobsSystemJobsReadParams) (*SystemJobsSystemJobsReadOK, error)
- type ClientService
- type SystemJobsSystemJobsCancelCreateCreated
- type SystemJobsSystemJobsCancelCreateParams
- func NewSystemJobsSystemJobsCancelCreateParams() *SystemJobsSystemJobsCancelCreateParams
- func NewSystemJobsSystemJobsCancelCreateParamsWithContext(ctx context.Context) *SystemJobsSystemJobsCancelCreateParams
- func NewSystemJobsSystemJobsCancelCreateParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsCancelCreateParams
- func NewSystemJobsSystemJobsCancelCreateParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsCancelCreateParams
- func (o *SystemJobsSystemJobsCancelCreateParams) SetContext(ctx context.Context)
- func (o *SystemJobsSystemJobsCancelCreateParams) SetHTTPClient(client *http.Client)
- func (o *SystemJobsSystemJobsCancelCreateParams) SetID(id string)
- func (o *SystemJobsSystemJobsCancelCreateParams) SetTimeout(timeout time.Duration)
- func (o *SystemJobsSystemJobsCancelCreateParams) WithContext(ctx context.Context) *SystemJobsSystemJobsCancelCreateParams
- func (o *SystemJobsSystemJobsCancelCreateParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsCancelCreateParams
- func (o *SystemJobsSystemJobsCancelCreateParams) WithID(id string) *SystemJobsSystemJobsCancelCreateParams
- func (o *SystemJobsSystemJobsCancelCreateParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsCancelCreateParams
- func (o *SystemJobsSystemJobsCancelCreateParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SystemJobsSystemJobsCancelCreateReader
- type SystemJobsSystemJobsCancelReadOK
- type SystemJobsSystemJobsCancelReadParams
- func NewSystemJobsSystemJobsCancelReadParams() *SystemJobsSystemJobsCancelReadParams
- func NewSystemJobsSystemJobsCancelReadParamsWithContext(ctx context.Context) *SystemJobsSystemJobsCancelReadParams
- func NewSystemJobsSystemJobsCancelReadParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsCancelReadParams
- func NewSystemJobsSystemJobsCancelReadParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsCancelReadParams
- func (o *SystemJobsSystemJobsCancelReadParams) SetContext(ctx context.Context)
- func (o *SystemJobsSystemJobsCancelReadParams) SetHTTPClient(client *http.Client)
- func (o *SystemJobsSystemJobsCancelReadParams) SetID(id string)
- func (o *SystemJobsSystemJobsCancelReadParams) SetSearch(search *string)
- func (o *SystemJobsSystemJobsCancelReadParams) SetTimeout(timeout time.Duration)
- func (o *SystemJobsSystemJobsCancelReadParams) WithContext(ctx context.Context) *SystemJobsSystemJobsCancelReadParams
- func (o *SystemJobsSystemJobsCancelReadParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsCancelReadParams
- func (o *SystemJobsSystemJobsCancelReadParams) WithID(id string) *SystemJobsSystemJobsCancelReadParams
- func (o *SystemJobsSystemJobsCancelReadParams) WithSearch(search *string) *SystemJobsSystemJobsCancelReadParams
- func (o *SystemJobsSystemJobsCancelReadParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsCancelReadParams
- func (o *SystemJobsSystemJobsCancelReadParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SystemJobsSystemJobsCancelReadReader
- type SystemJobsSystemJobsDeleteForbidden
- type SystemJobsSystemJobsDeleteNoContent
- type SystemJobsSystemJobsDeleteParams
- func NewSystemJobsSystemJobsDeleteParams() *SystemJobsSystemJobsDeleteParams
- func NewSystemJobsSystemJobsDeleteParamsWithContext(ctx context.Context) *SystemJobsSystemJobsDeleteParams
- func NewSystemJobsSystemJobsDeleteParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsDeleteParams
- func NewSystemJobsSystemJobsDeleteParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsDeleteParams
- func (o *SystemJobsSystemJobsDeleteParams) SetContext(ctx context.Context)
- func (o *SystemJobsSystemJobsDeleteParams) SetHTTPClient(client *http.Client)
- func (o *SystemJobsSystemJobsDeleteParams) SetID(id string)
- func (o *SystemJobsSystemJobsDeleteParams) SetSearch(search *string)
- func (o *SystemJobsSystemJobsDeleteParams) SetTimeout(timeout time.Duration)
- func (o *SystemJobsSystemJobsDeleteParams) WithContext(ctx context.Context) *SystemJobsSystemJobsDeleteParams
- func (o *SystemJobsSystemJobsDeleteParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsDeleteParams
- func (o *SystemJobsSystemJobsDeleteParams) WithID(id string) *SystemJobsSystemJobsDeleteParams
- func (o *SystemJobsSystemJobsDeleteParams) WithSearch(search *string) *SystemJobsSystemJobsDeleteParams
- func (o *SystemJobsSystemJobsDeleteParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsDeleteParams
- func (o *SystemJobsSystemJobsDeleteParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SystemJobsSystemJobsDeleteReader
- type SystemJobsSystemJobsEventsListOK
- type SystemJobsSystemJobsEventsListParams
- func NewSystemJobsSystemJobsEventsListParams() *SystemJobsSystemJobsEventsListParams
- func NewSystemJobsSystemJobsEventsListParamsWithContext(ctx context.Context) *SystemJobsSystemJobsEventsListParams
- func NewSystemJobsSystemJobsEventsListParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsEventsListParams
- func NewSystemJobsSystemJobsEventsListParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsEventsListParams
- func (o *SystemJobsSystemJobsEventsListParams) SetContext(ctx context.Context)
- func (o *SystemJobsSystemJobsEventsListParams) SetHTTPClient(client *http.Client)
- func (o *SystemJobsSystemJobsEventsListParams) SetID(id string)
- func (o *SystemJobsSystemJobsEventsListParams) SetPage(page *int64)
- func (o *SystemJobsSystemJobsEventsListParams) SetPageSize(pageSize *int64)
- func (o *SystemJobsSystemJobsEventsListParams) SetSearch(search *string)
- func (o *SystemJobsSystemJobsEventsListParams) SetTimeout(timeout time.Duration)
- func (o *SystemJobsSystemJobsEventsListParams) WithContext(ctx context.Context) *SystemJobsSystemJobsEventsListParams
- func (o *SystemJobsSystemJobsEventsListParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsEventsListParams
- func (o *SystemJobsSystemJobsEventsListParams) WithID(id string) *SystemJobsSystemJobsEventsListParams
- func (o *SystemJobsSystemJobsEventsListParams) WithPage(page *int64) *SystemJobsSystemJobsEventsListParams
- func (o *SystemJobsSystemJobsEventsListParams) WithPageSize(pageSize *int64) *SystemJobsSystemJobsEventsListParams
- func (o *SystemJobsSystemJobsEventsListParams) WithSearch(search *string) *SystemJobsSystemJobsEventsListParams
- func (o *SystemJobsSystemJobsEventsListParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsEventsListParams
- func (o *SystemJobsSystemJobsEventsListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SystemJobsSystemJobsEventsListReader
- type SystemJobsSystemJobsListOK
- type SystemJobsSystemJobsListParams
- func NewSystemJobsSystemJobsListParams() *SystemJobsSystemJobsListParams
- func NewSystemJobsSystemJobsListParamsWithContext(ctx context.Context) *SystemJobsSystemJobsListParams
- func NewSystemJobsSystemJobsListParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsListParams
- func NewSystemJobsSystemJobsListParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsListParams
- func (o *SystemJobsSystemJobsListParams) SetContext(ctx context.Context)
- func (o *SystemJobsSystemJobsListParams) SetHTTPClient(client *http.Client)
- func (o *SystemJobsSystemJobsListParams) SetPage(page *int64)
- func (o *SystemJobsSystemJobsListParams) SetPageSize(pageSize *int64)
- func (o *SystemJobsSystemJobsListParams) SetSearch(search *string)
- func (o *SystemJobsSystemJobsListParams) SetTimeout(timeout time.Duration)
- func (o *SystemJobsSystemJobsListParams) WithContext(ctx context.Context) *SystemJobsSystemJobsListParams
- func (o *SystemJobsSystemJobsListParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsListParams
- func (o *SystemJobsSystemJobsListParams) WithPage(page *int64) *SystemJobsSystemJobsListParams
- func (o *SystemJobsSystemJobsListParams) WithPageSize(pageSize *int64) *SystemJobsSystemJobsListParams
- func (o *SystemJobsSystemJobsListParams) WithSearch(search *string) *SystemJobsSystemJobsListParams
- func (o *SystemJobsSystemJobsListParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsListParams
- func (o *SystemJobsSystemJobsListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SystemJobsSystemJobsListReader
- type SystemJobsSystemJobsNotificationsListOK
- type SystemJobsSystemJobsNotificationsListParams
- func NewSystemJobsSystemJobsNotificationsListParams() *SystemJobsSystemJobsNotificationsListParams
- func NewSystemJobsSystemJobsNotificationsListParamsWithContext(ctx context.Context) *SystemJobsSystemJobsNotificationsListParams
- func NewSystemJobsSystemJobsNotificationsListParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsNotificationsListParams
- func NewSystemJobsSystemJobsNotificationsListParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsNotificationsListParams
- func (o *SystemJobsSystemJobsNotificationsListParams) SetContext(ctx context.Context)
- func (o *SystemJobsSystemJobsNotificationsListParams) SetHTTPClient(client *http.Client)
- func (o *SystemJobsSystemJobsNotificationsListParams) SetID(id string)
- func (o *SystemJobsSystemJobsNotificationsListParams) SetPage(page *int64)
- func (o *SystemJobsSystemJobsNotificationsListParams) SetPageSize(pageSize *int64)
- func (o *SystemJobsSystemJobsNotificationsListParams) SetSearch(search *string)
- func (o *SystemJobsSystemJobsNotificationsListParams) SetTimeout(timeout time.Duration)
- func (o *SystemJobsSystemJobsNotificationsListParams) WithContext(ctx context.Context) *SystemJobsSystemJobsNotificationsListParams
- func (o *SystemJobsSystemJobsNotificationsListParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsNotificationsListParams
- func (o *SystemJobsSystemJobsNotificationsListParams) WithID(id string) *SystemJobsSystemJobsNotificationsListParams
- func (o *SystemJobsSystemJobsNotificationsListParams) WithPage(page *int64) *SystemJobsSystemJobsNotificationsListParams
- func (o *SystemJobsSystemJobsNotificationsListParams) WithPageSize(pageSize *int64) *SystemJobsSystemJobsNotificationsListParams
- func (o *SystemJobsSystemJobsNotificationsListParams) WithSearch(search *string) *SystemJobsSystemJobsNotificationsListParams
- func (o *SystemJobsSystemJobsNotificationsListParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsNotificationsListParams
- func (o *SystemJobsSystemJobsNotificationsListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SystemJobsSystemJobsNotificationsListReader
- type SystemJobsSystemJobsReadOK
- type SystemJobsSystemJobsReadParams
- func NewSystemJobsSystemJobsReadParams() *SystemJobsSystemJobsReadParams
- func NewSystemJobsSystemJobsReadParamsWithContext(ctx context.Context) *SystemJobsSystemJobsReadParams
- func NewSystemJobsSystemJobsReadParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsReadParams
- func NewSystemJobsSystemJobsReadParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsReadParams
- func (o *SystemJobsSystemJobsReadParams) SetContext(ctx context.Context)
- func (o *SystemJobsSystemJobsReadParams) SetHTTPClient(client *http.Client)
- func (o *SystemJobsSystemJobsReadParams) SetID(id string)
- func (o *SystemJobsSystemJobsReadParams) SetSearch(search *string)
- func (o *SystemJobsSystemJobsReadParams) SetTimeout(timeout time.Duration)
- func (o *SystemJobsSystemJobsReadParams) WithContext(ctx context.Context) *SystemJobsSystemJobsReadParams
- func (o *SystemJobsSystemJobsReadParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsReadParams
- func (o *SystemJobsSystemJobsReadParams) WithID(id string) *SystemJobsSystemJobsReadParams
- func (o *SystemJobsSystemJobsReadParams) WithSearch(search *string) *SystemJobsSystemJobsReadParams
- func (o *SystemJobsSystemJobsReadParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsReadParams
- func (o *SystemJobsSystemJobsReadParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SystemJobsSystemJobsReadReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for system jobs API
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) SystemJobsSystemJobsCancelCreate ¶
func (a *Client) SystemJobsSystemJobsCancelCreate(params *SystemJobsSystemJobsCancelCreateParams) (*SystemJobsSystemJobsCancelCreateCreated, error)
SystemJobsSystemJobsCancelCreate retrieves a system job
Make GET request to this resource to retrieve a single system job record containing the following fields:
* `can_cancel`: (boolean)
func (*Client) SystemJobsSystemJobsCancelRead ¶
func (a *Client) SystemJobsSystemJobsCancelRead(params *SystemJobsSystemJobsCancelReadParams) (*SystemJobsSystemJobsCancelReadOK, error)
SystemJobsSystemJobsCancelRead retrieves a system job
Make GET request to this resource to retrieve a single system job record containing the following fields:
* `can_cancel`: (boolean)
func (*Client) SystemJobsSystemJobsDelete ¶
func (a *Client) SystemJobsSystemJobsDelete(params *SystemJobsSystemJobsDeleteParams) (*SystemJobsSystemJobsDeleteNoContent, error)
SystemJobsSystemJobsDelete deletes a system job
Make a DELETE request to this resource to delete this system job.
func (*Client) SystemJobsSystemJobsEventsList ¶
func (a *Client) SystemJobsSystemJobsEventsList(params *SystemJobsSystemJobsEventsListParams) (*SystemJobsSystemJobsEventsListOK, error)
SystemJobsSystemJobsEventsList lists system job events for a system job
Make a GET request to this resource to retrieve a list of system job events associated with the selected system job.
The resulting data structure contains:
{ "count": 99, "next": null, "previous": null, "results": [ ... ] }
The `count` field indicates the total number of system job events found for the given query. The `next` and `previous` fields provides links to additional results if there are more than will fit on a single page. The `results` list contains zero or more system job event records.
## Results
Each system job event data structure includes the following fields:
* `id`: Database ID for this system job event. (integer) * `type`: Data type for this system job event. (choice) * `url`: URL for this system job event. (string) * `related`: Data structure with URLs of related resources. (object) * `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object) * `created`: Timestamp when this system job event was created. (datetime) * `modified`: Timestamp when this system job event was last modified. (datetime) * `event`: (field) * `counter`: (integer) * `event_display`: (string) * `event_data`: (json) * `failed`: (field) * `changed`: (field) * `uuid`: (string) * `stdout`: (string) * `start_line`: (integer) * `end_line`: (integer) * `verbosity`: (integer) * `system_job`: (id)
## Sorting
To specify that system job events are returned in a particular order, use the `order_by` query string parameter on the GET request.
?order_by=name
Prefix the field name with a dash `-` to sort in reverse:
?order_by=-name
Multiple sorting fields may be specified by separating the field names with a comma `,`:
?order_by=name,some_other_field
## Pagination
Use the `page_size` query string parameter to change the number of results returned for each request. Use the `page` query string parameter to retrieve a particular page of results.
?page_size=100&page=2
The `previous` and `next` links returned with the results will set these query string parameters automatically.
## Searching
Use the `search` query string parameter to perform a case-insensitive search within all designated text fields of a model.
?search=findme
(_Added in Ansible Tower 3.1.0_) Search across related fields:
?related__search=findme
func (*Client) SystemJobsSystemJobsList ¶
func (a *Client) SystemJobsSystemJobsList(params *SystemJobsSystemJobsListParams) (*SystemJobsSystemJobsListOK, error)
SystemJobsSystemJobsList lists system jobs
Make a GET request to this resource to retrieve the list of system jobs.
The resulting data structure contains:
{ "count": 99, "next": null, "previous": null, "results": [ ... ] }
The `count` field indicates the total number of system jobs found for the given query. The `next` and `previous` fields provides links to additional results if there are more than will fit on a single page. The `results` list contains zero or more system job records.
## Results
Each system job data structure includes the following fields:
* `id`: Database ID for this system job. (integer) * `type`: Data type for this system job. (choice) * `url`: URL for this system job. (string) * `related`: Data structure with URLs of related resources. (object) * `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object) * `created`: Timestamp when this system job was created. (datetime) * `modified`: Timestamp when this system job was last modified. (datetime) * `name`: Name of this system job. (string) * `description`: Optional description of this system job. (string) * `unified_job_template`: (id) * `launch_type`: (choice)
- `manual`: Manual
- `relaunch`: Relaunch
- `callback`: Callback
- `scheduled`: Scheduled
- `dependency`: Dependency
- `workflow`: Workflow
- `webhook`: Webhook
- `sync`: Sync
- `scm`: SCM Update
* `status`: (choice)
- `new`: New
- `pending`: Pending
- `waiting`: Waiting
- `running`: Running
- `successful`: Successful
- `failed`: Failed
- `error`: Error
- `canceled`: Canceled
* `failed`: (boolean) * `started`: The date and time the job was queued for starting. (datetime) * `finished`: The date and time the job finished execution. (datetime) * `canceled_on`: The date and time when the cancel request was sent. (datetime) * `elapsed`: Elapsed time in seconds that the job ran. (decimal) * `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string) * `execution_node`: The node the job executed on. (string) * `system_job_template`: (id) * `job_type`: (choice)
- `""`: ---------
- `cleanup_jobs`: Remove jobs older than a certain number of days
- `cleanup_activitystream`: Remove activity stream entries older than a certain number of days
- `cleanup_sessions`: Removes expired browser sessions from the database
- `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens
* `extra_vars`: (string) * `result_stdout`: (field)
## Sorting
To specify that system jobs are returned in a particular order, use the `order_by` query string parameter on the GET request.
?order_by=name
Prefix the field name with a dash `-` to sort in reverse:
?order_by=-name
Multiple sorting fields may be specified by separating the field names with a comma `,`:
?order_by=name,some_other_field
## Pagination
Use the `page_size` query string parameter to change the number of results returned for each request. Use the `page` query string parameter to retrieve a particular page of results.
?page_size=100&page=2
The `previous` and `next` links returned with the results will set these query string parameters automatically.
## Searching
Use the `search` query string parameter to perform a case-insensitive search within all designated text fields of a model.
?search=findme
(_Added in Ansible Tower 3.1.0_) Search across related fields:
?related__search=findme
func (*Client) SystemJobsSystemJobsNotificationsList ¶
func (a *Client) SystemJobsSystemJobsNotificationsList(params *SystemJobsSystemJobsNotificationsListParams) (*SystemJobsSystemJobsNotificationsListOK, error)
SystemJobsSystemJobsNotificationsList lists notifications for a system job
Make a GET request to this resource to retrieve a list of notifications associated with the selected system job.
The resulting data structure contains:
{ "count": 99, "next": null, "previous": null, "results": [ ... ] }
The `count` field indicates the total number of notifications found for the given query. The `next` and `previous` fields provides links to additional results if there are more than will fit on a single page. The `results` list contains zero or more notification records.
## Results
Each notification data structure includes the following fields:
* `id`: Database ID for this notification. (integer) * `type`: Data type for this notification. (choice) * `url`: URL for this notification. (string) * `related`: Data structure with URLs of related resources. (object) * `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object) * `created`: Timestamp when this notification was created. (datetime) * `modified`: Timestamp when this notification was last modified. (datetime) * `notification_template`: (id) * `error`: (string) * `status`: (choice)
- `pending`: Pending
- `successful`: Successful
- `failed`: Failed
* `notifications_sent`: (integer) * `notification_type`: (choice)
- `email`: Email
- `grafana`: Grafana
- `hipchat`: HipChat
- `irc`: IRC
- `mattermost`: Mattermost
- `pagerduty`: Pagerduty
- `rocketchat`: Rocket.Chat
- `slack`: Slack
- `twilio`: Twilio
- `webhook`: Webhook
* `recipients`: (string) * `subject`: (string) * `body`: Notification body (json)
## Sorting
To specify that notifications are returned in a particular order, use the `order_by` query string parameter on the GET request.
?order_by=name
Prefix the field name with a dash `-` to sort in reverse:
?order_by=-name
Multiple sorting fields may be specified by separating the field names with a comma `,`:
?order_by=name,some_other_field
## Pagination
Use the `page_size` query string parameter to change the number of results returned for each request. Use the `page` query string parameter to retrieve a particular page of results.
?page_size=100&page=2
The `previous` and `next` links returned with the results will set these query string parameters automatically.
## Searching
Use the `search` query string parameter to perform a case-insensitive search within all designated text fields of a model.
?search=findme
(_Added in Ansible Tower 3.1.0_) Search across related fields:
?related__search=findme
func (*Client) SystemJobsSystemJobsRead ¶
func (a *Client) SystemJobsSystemJobsRead(params *SystemJobsSystemJobsReadParams) (*SystemJobsSystemJobsReadOK, error)
SystemJobsSystemJobsRead retrieves a system job
Make GET request to this resource to retrieve a single system job record containing the following fields:
* `id`: Database ID for this system job. (integer) * `type`: Data type for this system job. (choice) * `url`: URL for this system job. (string) * `related`: Data structure with URLs of related resources. (object) * `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object) * `created`: Timestamp when this system job was created. (datetime) * `modified`: Timestamp when this system job was last modified. (datetime) * `name`: Name of this system job. (string) * `description`: Optional description of this system job. (string) * `unified_job_template`: (id) * `launch_type`: (choice)
- `manual`: Manual
- `relaunch`: Relaunch
- `callback`: Callback
- `scheduled`: Scheduled
- `dependency`: Dependency
- `workflow`: Workflow
- `webhook`: Webhook
- `sync`: Sync
- `scm`: SCM Update
* `status`: (choice)
- `new`: New
- `pending`: Pending
- `waiting`: Waiting
- `running`: Running
- `successful`: Successful
- `failed`: Failed
- `error`: Error
- `canceled`: Canceled
* `failed`: (boolean) * `started`: The date and time the job was queued for starting. (datetime) * `finished`: The date and time the job finished execution. (datetime) * `canceled_on`: The date and time when the cancel request was sent. (datetime) * `elapsed`: Elapsed time in seconds that the job ran. (decimal) * `job_args`: (string) * `job_cwd`: (string) * `job_env`: (json) * `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string) * `execution_node`: The node the job executed on. (string) * `result_traceback`: (string) * `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean) * `system_job_template`: (id) * `job_type`: (choice)
- `""`: ---------
- `cleanup_jobs`: Remove jobs older than a certain number of days
- `cleanup_activitystream`: Remove activity stream entries older than a certain number of days
- `cleanup_sessions`: Removes expired browser sessions from the database
- `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens
* `extra_vars`: (string) * `result_stdout`: (field)
type ClientService ¶
type ClientService interface { SystemJobsSystemJobsCancelCreate(params *SystemJobsSystemJobsCancelCreateParams) (*SystemJobsSystemJobsCancelCreateCreated, error) SystemJobsSystemJobsCancelRead(params *SystemJobsSystemJobsCancelReadParams) (*SystemJobsSystemJobsCancelReadOK, error) SystemJobsSystemJobsDelete(params *SystemJobsSystemJobsDeleteParams) (*SystemJobsSystemJobsDeleteNoContent, error) SystemJobsSystemJobsEventsList(params *SystemJobsSystemJobsEventsListParams) (*SystemJobsSystemJobsEventsListOK, error) SystemJobsSystemJobsList(params *SystemJobsSystemJobsListParams) (*SystemJobsSystemJobsListOK, error) SystemJobsSystemJobsNotificationsList(params *SystemJobsSystemJobsNotificationsListParams) (*SystemJobsSystemJobsNotificationsListOK, error) SystemJobsSystemJobsRead(params *SystemJobsSystemJobsReadParams) (*SystemJobsSystemJobsReadOK, error) SetTransport(transport runtime.ClientTransport) }
ClientService is the interface for Client methods
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
New creates a new system jobs API client.
type SystemJobsSystemJobsCancelCreateCreated ¶
type SystemJobsSystemJobsCancelCreateCreated struct { }
SystemJobsSystemJobsCancelCreateCreated handles this case with default header values.
SystemJobsSystemJobsCancelCreateCreated system jobs system jobs cancel create created
func NewSystemJobsSystemJobsCancelCreateCreated ¶
func NewSystemJobsSystemJobsCancelCreateCreated() *SystemJobsSystemJobsCancelCreateCreated
NewSystemJobsSystemJobsCancelCreateCreated creates a SystemJobsSystemJobsCancelCreateCreated with default headers values
func (*SystemJobsSystemJobsCancelCreateCreated) Error ¶
func (o *SystemJobsSystemJobsCancelCreateCreated) Error() string
type SystemJobsSystemJobsCancelCreateParams ¶
type SystemJobsSystemJobsCancelCreateParams struct { /*ID*/ ID string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
SystemJobsSystemJobsCancelCreateParams contains all the parameters to send to the API endpoint for the system jobs system jobs cancel create operation typically these are written to a http.Request
func NewSystemJobsSystemJobsCancelCreateParams ¶
func NewSystemJobsSystemJobsCancelCreateParams() *SystemJobsSystemJobsCancelCreateParams
NewSystemJobsSystemJobsCancelCreateParams creates a new SystemJobsSystemJobsCancelCreateParams object with the default values initialized.
func NewSystemJobsSystemJobsCancelCreateParamsWithContext ¶
func NewSystemJobsSystemJobsCancelCreateParamsWithContext(ctx context.Context) *SystemJobsSystemJobsCancelCreateParams
NewSystemJobsSystemJobsCancelCreateParamsWithContext creates a new SystemJobsSystemJobsCancelCreateParams object with the default values initialized, and the ability to set a context for a request
func NewSystemJobsSystemJobsCancelCreateParamsWithHTTPClient ¶
func NewSystemJobsSystemJobsCancelCreateParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsCancelCreateParams
NewSystemJobsSystemJobsCancelCreateParamsWithHTTPClient creates a new SystemJobsSystemJobsCancelCreateParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSystemJobsSystemJobsCancelCreateParamsWithTimeout ¶
func NewSystemJobsSystemJobsCancelCreateParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsCancelCreateParams
NewSystemJobsSystemJobsCancelCreateParamsWithTimeout creates a new SystemJobsSystemJobsCancelCreateParams object with the default values initialized, and the ability to set a timeout on a request
func (*SystemJobsSystemJobsCancelCreateParams) SetContext ¶
func (o *SystemJobsSystemJobsCancelCreateParams) SetContext(ctx context.Context)
SetContext adds the context to the system jobs system jobs cancel create params
func (*SystemJobsSystemJobsCancelCreateParams) SetHTTPClient ¶
func (o *SystemJobsSystemJobsCancelCreateParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the system jobs system jobs cancel create params
func (*SystemJobsSystemJobsCancelCreateParams) SetID ¶
func (o *SystemJobsSystemJobsCancelCreateParams) SetID(id string)
SetID adds the id to the system jobs system jobs cancel create params
func (*SystemJobsSystemJobsCancelCreateParams) SetTimeout ¶
func (o *SystemJobsSystemJobsCancelCreateParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the system jobs system jobs cancel create params
func (*SystemJobsSystemJobsCancelCreateParams) WithContext ¶
func (o *SystemJobsSystemJobsCancelCreateParams) WithContext(ctx context.Context) *SystemJobsSystemJobsCancelCreateParams
WithContext adds the context to the system jobs system jobs cancel create params
func (*SystemJobsSystemJobsCancelCreateParams) WithHTTPClient ¶
func (o *SystemJobsSystemJobsCancelCreateParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsCancelCreateParams
WithHTTPClient adds the HTTPClient to the system jobs system jobs cancel create params
func (*SystemJobsSystemJobsCancelCreateParams) WithID ¶
func (o *SystemJobsSystemJobsCancelCreateParams) WithID(id string) *SystemJobsSystemJobsCancelCreateParams
WithID adds the id to the system jobs system jobs cancel create params
func (*SystemJobsSystemJobsCancelCreateParams) WithTimeout ¶
func (o *SystemJobsSystemJobsCancelCreateParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsCancelCreateParams
WithTimeout adds the timeout to the system jobs system jobs cancel create params
func (*SystemJobsSystemJobsCancelCreateParams) WriteToRequest ¶
func (o *SystemJobsSystemJobsCancelCreateParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SystemJobsSystemJobsCancelCreateReader ¶
type SystemJobsSystemJobsCancelCreateReader struct {
// contains filtered or unexported fields
}
SystemJobsSystemJobsCancelCreateReader is a Reader for the SystemJobsSystemJobsCancelCreate structure.
func (*SystemJobsSystemJobsCancelCreateReader) ReadResponse ¶
func (o *SystemJobsSystemJobsCancelCreateReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type SystemJobsSystemJobsCancelReadOK ¶
type SystemJobsSystemJobsCancelReadOK struct { }
SystemJobsSystemJobsCancelReadOK handles this case with default header values.
OK
func NewSystemJobsSystemJobsCancelReadOK ¶
func NewSystemJobsSystemJobsCancelReadOK() *SystemJobsSystemJobsCancelReadOK
NewSystemJobsSystemJobsCancelReadOK creates a SystemJobsSystemJobsCancelReadOK with default headers values
func (*SystemJobsSystemJobsCancelReadOK) Error ¶
func (o *SystemJobsSystemJobsCancelReadOK) Error() string
type SystemJobsSystemJobsCancelReadParams ¶
type SystemJobsSystemJobsCancelReadParams struct { /*ID*/ ID string /*Search A search term. */ Search *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
SystemJobsSystemJobsCancelReadParams contains all the parameters to send to the API endpoint for the system jobs system jobs cancel read operation typically these are written to a http.Request
func NewSystemJobsSystemJobsCancelReadParams ¶
func NewSystemJobsSystemJobsCancelReadParams() *SystemJobsSystemJobsCancelReadParams
NewSystemJobsSystemJobsCancelReadParams creates a new SystemJobsSystemJobsCancelReadParams object with the default values initialized.
func NewSystemJobsSystemJobsCancelReadParamsWithContext ¶
func NewSystemJobsSystemJobsCancelReadParamsWithContext(ctx context.Context) *SystemJobsSystemJobsCancelReadParams
NewSystemJobsSystemJobsCancelReadParamsWithContext creates a new SystemJobsSystemJobsCancelReadParams object with the default values initialized, and the ability to set a context for a request
func NewSystemJobsSystemJobsCancelReadParamsWithHTTPClient ¶
func NewSystemJobsSystemJobsCancelReadParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsCancelReadParams
NewSystemJobsSystemJobsCancelReadParamsWithHTTPClient creates a new SystemJobsSystemJobsCancelReadParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSystemJobsSystemJobsCancelReadParamsWithTimeout ¶
func NewSystemJobsSystemJobsCancelReadParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsCancelReadParams
NewSystemJobsSystemJobsCancelReadParamsWithTimeout creates a new SystemJobsSystemJobsCancelReadParams object with the default values initialized, and the ability to set a timeout on a request
func (*SystemJobsSystemJobsCancelReadParams) SetContext ¶
func (o *SystemJobsSystemJobsCancelReadParams) SetContext(ctx context.Context)
SetContext adds the context to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) SetHTTPClient ¶
func (o *SystemJobsSystemJobsCancelReadParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) SetID ¶
func (o *SystemJobsSystemJobsCancelReadParams) SetID(id string)
SetID adds the id to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) SetSearch ¶
func (o *SystemJobsSystemJobsCancelReadParams) SetSearch(search *string)
SetSearch adds the search to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) SetTimeout ¶
func (o *SystemJobsSystemJobsCancelReadParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) WithContext ¶
func (o *SystemJobsSystemJobsCancelReadParams) WithContext(ctx context.Context) *SystemJobsSystemJobsCancelReadParams
WithContext adds the context to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) WithHTTPClient ¶
func (o *SystemJobsSystemJobsCancelReadParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsCancelReadParams
WithHTTPClient adds the HTTPClient to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) WithID ¶
func (o *SystemJobsSystemJobsCancelReadParams) WithID(id string) *SystemJobsSystemJobsCancelReadParams
WithID adds the id to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) WithSearch ¶
func (o *SystemJobsSystemJobsCancelReadParams) WithSearch(search *string) *SystemJobsSystemJobsCancelReadParams
WithSearch adds the search to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) WithTimeout ¶
func (o *SystemJobsSystemJobsCancelReadParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsCancelReadParams
WithTimeout adds the timeout to the system jobs system jobs cancel read params
func (*SystemJobsSystemJobsCancelReadParams) WriteToRequest ¶
func (o *SystemJobsSystemJobsCancelReadParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SystemJobsSystemJobsCancelReadReader ¶
type SystemJobsSystemJobsCancelReadReader struct {
// contains filtered or unexported fields
}
SystemJobsSystemJobsCancelReadReader is a Reader for the SystemJobsSystemJobsCancelRead structure.
func (*SystemJobsSystemJobsCancelReadReader) ReadResponse ¶
func (o *SystemJobsSystemJobsCancelReadReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type SystemJobsSystemJobsDeleteForbidden ¶
type SystemJobsSystemJobsDeleteForbidden struct { }
SystemJobsSystemJobsDeleteForbidden handles this case with default header values.
No Permission Response
func NewSystemJobsSystemJobsDeleteForbidden ¶
func NewSystemJobsSystemJobsDeleteForbidden() *SystemJobsSystemJobsDeleteForbidden
NewSystemJobsSystemJobsDeleteForbidden creates a SystemJobsSystemJobsDeleteForbidden with default headers values
func (*SystemJobsSystemJobsDeleteForbidden) Error ¶
func (o *SystemJobsSystemJobsDeleteForbidden) Error() string
type SystemJobsSystemJobsDeleteNoContent ¶
type SystemJobsSystemJobsDeleteNoContent struct { }
SystemJobsSystemJobsDeleteNoContent handles this case with default header values.
SystemJobsSystemJobsDeleteNoContent system jobs system jobs delete no content
func NewSystemJobsSystemJobsDeleteNoContent ¶
func NewSystemJobsSystemJobsDeleteNoContent() *SystemJobsSystemJobsDeleteNoContent
NewSystemJobsSystemJobsDeleteNoContent creates a SystemJobsSystemJobsDeleteNoContent with default headers values
func (*SystemJobsSystemJobsDeleteNoContent) Error ¶
func (o *SystemJobsSystemJobsDeleteNoContent) Error() string
type SystemJobsSystemJobsDeleteParams ¶
type SystemJobsSystemJobsDeleteParams struct { /*ID*/ ID string /*Search A search term. */ Search *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
SystemJobsSystemJobsDeleteParams contains all the parameters to send to the API endpoint for the system jobs system jobs delete operation typically these are written to a http.Request
func NewSystemJobsSystemJobsDeleteParams ¶
func NewSystemJobsSystemJobsDeleteParams() *SystemJobsSystemJobsDeleteParams
NewSystemJobsSystemJobsDeleteParams creates a new SystemJobsSystemJobsDeleteParams object with the default values initialized.
func NewSystemJobsSystemJobsDeleteParamsWithContext ¶
func NewSystemJobsSystemJobsDeleteParamsWithContext(ctx context.Context) *SystemJobsSystemJobsDeleteParams
NewSystemJobsSystemJobsDeleteParamsWithContext creates a new SystemJobsSystemJobsDeleteParams object with the default values initialized, and the ability to set a context for a request
func NewSystemJobsSystemJobsDeleteParamsWithHTTPClient ¶
func NewSystemJobsSystemJobsDeleteParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsDeleteParams
NewSystemJobsSystemJobsDeleteParamsWithHTTPClient creates a new SystemJobsSystemJobsDeleteParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSystemJobsSystemJobsDeleteParamsWithTimeout ¶
func NewSystemJobsSystemJobsDeleteParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsDeleteParams
NewSystemJobsSystemJobsDeleteParamsWithTimeout creates a new SystemJobsSystemJobsDeleteParams object with the default values initialized, and the ability to set a timeout on a request
func (*SystemJobsSystemJobsDeleteParams) SetContext ¶
func (o *SystemJobsSystemJobsDeleteParams) SetContext(ctx context.Context)
SetContext adds the context to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) SetHTTPClient ¶
func (o *SystemJobsSystemJobsDeleteParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) SetID ¶
func (o *SystemJobsSystemJobsDeleteParams) SetID(id string)
SetID adds the id to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) SetSearch ¶
func (o *SystemJobsSystemJobsDeleteParams) SetSearch(search *string)
SetSearch adds the search to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) SetTimeout ¶
func (o *SystemJobsSystemJobsDeleteParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) WithContext ¶
func (o *SystemJobsSystemJobsDeleteParams) WithContext(ctx context.Context) *SystemJobsSystemJobsDeleteParams
WithContext adds the context to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) WithHTTPClient ¶
func (o *SystemJobsSystemJobsDeleteParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsDeleteParams
WithHTTPClient adds the HTTPClient to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) WithID ¶
func (o *SystemJobsSystemJobsDeleteParams) WithID(id string) *SystemJobsSystemJobsDeleteParams
WithID adds the id to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) WithSearch ¶
func (o *SystemJobsSystemJobsDeleteParams) WithSearch(search *string) *SystemJobsSystemJobsDeleteParams
WithSearch adds the search to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) WithTimeout ¶
func (o *SystemJobsSystemJobsDeleteParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsDeleteParams
WithTimeout adds the timeout to the system jobs system jobs delete params
func (*SystemJobsSystemJobsDeleteParams) WriteToRequest ¶
func (o *SystemJobsSystemJobsDeleteParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SystemJobsSystemJobsDeleteReader ¶
type SystemJobsSystemJobsDeleteReader struct {
// contains filtered or unexported fields
}
SystemJobsSystemJobsDeleteReader is a Reader for the SystemJobsSystemJobsDelete structure.
func (*SystemJobsSystemJobsDeleteReader) ReadResponse ¶
func (o *SystemJobsSystemJobsDeleteReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type SystemJobsSystemJobsEventsListOK ¶
type SystemJobsSystemJobsEventsListOK struct { }
SystemJobsSystemJobsEventsListOK handles this case with default header values.
OK
func NewSystemJobsSystemJobsEventsListOK ¶
func NewSystemJobsSystemJobsEventsListOK() *SystemJobsSystemJobsEventsListOK
NewSystemJobsSystemJobsEventsListOK creates a SystemJobsSystemJobsEventsListOK with default headers values
func (*SystemJobsSystemJobsEventsListOK) Error ¶
func (o *SystemJobsSystemJobsEventsListOK) Error() string
type SystemJobsSystemJobsEventsListParams ¶
type SystemJobsSystemJobsEventsListParams struct { /*ID*/ ID string /*Page A page number within the paginated result set. */ Page *int64 /*PageSize Number of results to return per page. */ PageSize *int64 /*Search A search term. */ Search *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
SystemJobsSystemJobsEventsListParams contains all the parameters to send to the API endpoint for the system jobs system jobs events list operation typically these are written to a http.Request
func NewSystemJobsSystemJobsEventsListParams ¶
func NewSystemJobsSystemJobsEventsListParams() *SystemJobsSystemJobsEventsListParams
NewSystemJobsSystemJobsEventsListParams creates a new SystemJobsSystemJobsEventsListParams object with the default values initialized.
func NewSystemJobsSystemJobsEventsListParamsWithContext ¶
func NewSystemJobsSystemJobsEventsListParamsWithContext(ctx context.Context) *SystemJobsSystemJobsEventsListParams
NewSystemJobsSystemJobsEventsListParamsWithContext creates a new SystemJobsSystemJobsEventsListParams object with the default values initialized, and the ability to set a context for a request
func NewSystemJobsSystemJobsEventsListParamsWithHTTPClient ¶
func NewSystemJobsSystemJobsEventsListParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsEventsListParams
NewSystemJobsSystemJobsEventsListParamsWithHTTPClient creates a new SystemJobsSystemJobsEventsListParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSystemJobsSystemJobsEventsListParamsWithTimeout ¶
func NewSystemJobsSystemJobsEventsListParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsEventsListParams
NewSystemJobsSystemJobsEventsListParamsWithTimeout creates a new SystemJobsSystemJobsEventsListParams object with the default values initialized, and the ability to set a timeout on a request
func (*SystemJobsSystemJobsEventsListParams) SetContext ¶
func (o *SystemJobsSystemJobsEventsListParams) SetContext(ctx context.Context)
SetContext adds the context to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) SetHTTPClient ¶
func (o *SystemJobsSystemJobsEventsListParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) SetID ¶
func (o *SystemJobsSystemJobsEventsListParams) SetID(id string)
SetID adds the id to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) SetPage ¶
func (o *SystemJobsSystemJobsEventsListParams) SetPage(page *int64)
SetPage adds the page to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) SetPageSize ¶
func (o *SystemJobsSystemJobsEventsListParams) SetPageSize(pageSize *int64)
SetPageSize adds the pageSize to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) SetSearch ¶
func (o *SystemJobsSystemJobsEventsListParams) SetSearch(search *string)
SetSearch adds the search to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) SetTimeout ¶
func (o *SystemJobsSystemJobsEventsListParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) WithContext ¶
func (o *SystemJobsSystemJobsEventsListParams) WithContext(ctx context.Context) *SystemJobsSystemJobsEventsListParams
WithContext adds the context to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) WithHTTPClient ¶
func (o *SystemJobsSystemJobsEventsListParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsEventsListParams
WithHTTPClient adds the HTTPClient to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) WithID ¶
func (o *SystemJobsSystemJobsEventsListParams) WithID(id string) *SystemJobsSystemJobsEventsListParams
WithID adds the id to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) WithPage ¶
func (o *SystemJobsSystemJobsEventsListParams) WithPage(page *int64) *SystemJobsSystemJobsEventsListParams
WithPage adds the page to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) WithPageSize ¶
func (o *SystemJobsSystemJobsEventsListParams) WithPageSize(pageSize *int64) *SystemJobsSystemJobsEventsListParams
WithPageSize adds the pageSize to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) WithSearch ¶
func (o *SystemJobsSystemJobsEventsListParams) WithSearch(search *string) *SystemJobsSystemJobsEventsListParams
WithSearch adds the search to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) WithTimeout ¶
func (o *SystemJobsSystemJobsEventsListParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsEventsListParams
WithTimeout adds the timeout to the system jobs system jobs events list params
func (*SystemJobsSystemJobsEventsListParams) WriteToRequest ¶
func (o *SystemJobsSystemJobsEventsListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SystemJobsSystemJobsEventsListReader ¶
type SystemJobsSystemJobsEventsListReader struct {
// contains filtered or unexported fields
}
SystemJobsSystemJobsEventsListReader is a Reader for the SystemJobsSystemJobsEventsList structure.
func (*SystemJobsSystemJobsEventsListReader) ReadResponse ¶
func (o *SystemJobsSystemJobsEventsListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type SystemJobsSystemJobsListOK ¶
type SystemJobsSystemJobsListOK struct { }
SystemJobsSystemJobsListOK handles this case with default header values.
OK
func NewSystemJobsSystemJobsListOK ¶
func NewSystemJobsSystemJobsListOK() *SystemJobsSystemJobsListOK
NewSystemJobsSystemJobsListOK creates a SystemJobsSystemJobsListOK with default headers values
func (*SystemJobsSystemJobsListOK) Error ¶
func (o *SystemJobsSystemJobsListOK) Error() string
type SystemJobsSystemJobsListParams ¶
type SystemJobsSystemJobsListParams struct { /*Page A page number within the paginated result set. */ Page *int64 /*PageSize Number of results to return per page. */ PageSize *int64 /*Search A search term. */ Search *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
SystemJobsSystemJobsListParams contains all the parameters to send to the API endpoint for the system jobs system jobs list operation typically these are written to a http.Request
func NewSystemJobsSystemJobsListParams ¶
func NewSystemJobsSystemJobsListParams() *SystemJobsSystemJobsListParams
NewSystemJobsSystemJobsListParams creates a new SystemJobsSystemJobsListParams object with the default values initialized.
func NewSystemJobsSystemJobsListParamsWithContext ¶
func NewSystemJobsSystemJobsListParamsWithContext(ctx context.Context) *SystemJobsSystemJobsListParams
NewSystemJobsSystemJobsListParamsWithContext creates a new SystemJobsSystemJobsListParams object with the default values initialized, and the ability to set a context for a request
func NewSystemJobsSystemJobsListParamsWithHTTPClient ¶
func NewSystemJobsSystemJobsListParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsListParams
NewSystemJobsSystemJobsListParamsWithHTTPClient creates a new SystemJobsSystemJobsListParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSystemJobsSystemJobsListParamsWithTimeout ¶
func NewSystemJobsSystemJobsListParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsListParams
NewSystemJobsSystemJobsListParamsWithTimeout creates a new SystemJobsSystemJobsListParams object with the default values initialized, and the ability to set a timeout on a request
func (*SystemJobsSystemJobsListParams) SetContext ¶
func (o *SystemJobsSystemJobsListParams) SetContext(ctx context.Context)
SetContext adds the context to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) SetHTTPClient ¶
func (o *SystemJobsSystemJobsListParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) SetPage ¶
func (o *SystemJobsSystemJobsListParams) SetPage(page *int64)
SetPage adds the page to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) SetPageSize ¶
func (o *SystemJobsSystemJobsListParams) SetPageSize(pageSize *int64)
SetPageSize adds the pageSize to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) SetSearch ¶
func (o *SystemJobsSystemJobsListParams) SetSearch(search *string)
SetSearch adds the search to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) SetTimeout ¶
func (o *SystemJobsSystemJobsListParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) WithContext ¶
func (o *SystemJobsSystemJobsListParams) WithContext(ctx context.Context) *SystemJobsSystemJobsListParams
WithContext adds the context to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) WithHTTPClient ¶
func (o *SystemJobsSystemJobsListParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsListParams
WithHTTPClient adds the HTTPClient to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) WithPage ¶
func (o *SystemJobsSystemJobsListParams) WithPage(page *int64) *SystemJobsSystemJobsListParams
WithPage adds the page to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) WithPageSize ¶
func (o *SystemJobsSystemJobsListParams) WithPageSize(pageSize *int64) *SystemJobsSystemJobsListParams
WithPageSize adds the pageSize to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) WithSearch ¶
func (o *SystemJobsSystemJobsListParams) WithSearch(search *string) *SystemJobsSystemJobsListParams
WithSearch adds the search to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) WithTimeout ¶
func (o *SystemJobsSystemJobsListParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsListParams
WithTimeout adds the timeout to the system jobs system jobs list params
func (*SystemJobsSystemJobsListParams) WriteToRequest ¶
func (o *SystemJobsSystemJobsListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SystemJobsSystemJobsListReader ¶
type SystemJobsSystemJobsListReader struct {
// contains filtered or unexported fields
}
SystemJobsSystemJobsListReader is a Reader for the SystemJobsSystemJobsList structure.
func (*SystemJobsSystemJobsListReader) ReadResponse ¶
func (o *SystemJobsSystemJobsListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type SystemJobsSystemJobsNotificationsListOK ¶
type SystemJobsSystemJobsNotificationsListOK struct { }
SystemJobsSystemJobsNotificationsListOK handles this case with default header values.
OK
func NewSystemJobsSystemJobsNotificationsListOK ¶
func NewSystemJobsSystemJobsNotificationsListOK() *SystemJobsSystemJobsNotificationsListOK
NewSystemJobsSystemJobsNotificationsListOK creates a SystemJobsSystemJobsNotificationsListOK with default headers values
func (*SystemJobsSystemJobsNotificationsListOK) Error ¶
func (o *SystemJobsSystemJobsNotificationsListOK) Error() string
type SystemJobsSystemJobsNotificationsListParams ¶
type SystemJobsSystemJobsNotificationsListParams struct { /*ID*/ ID string /*Page A page number within the paginated result set. */ Page *int64 /*PageSize Number of results to return per page. */ PageSize *int64 /*Search A search term. */ Search *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
SystemJobsSystemJobsNotificationsListParams contains all the parameters to send to the API endpoint for the system jobs system jobs notifications list operation typically these are written to a http.Request
func NewSystemJobsSystemJobsNotificationsListParams ¶
func NewSystemJobsSystemJobsNotificationsListParams() *SystemJobsSystemJobsNotificationsListParams
NewSystemJobsSystemJobsNotificationsListParams creates a new SystemJobsSystemJobsNotificationsListParams object with the default values initialized.
func NewSystemJobsSystemJobsNotificationsListParamsWithContext ¶
func NewSystemJobsSystemJobsNotificationsListParamsWithContext(ctx context.Context) *SystemJobsSystemJobsNotificationsListParams
NewSystemJobsSystemJobsNotificationsListParamsWithContext creates a new SystemJobsSystemJobsNotificationsListParams object with the default values initialized, and the ability to set a context for a request
func NewSystemJobsSystemJobsNotificationsListParamsWithHTTPClient ¶
func NewSystemJobsSystemJobsNotificationsListParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsNotificationsListParams
NewSystemJobsSystemJobsNotificationsListParamsWithHTTPClient creates a new SystemJobsSystemJobsNotificationsListParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSystemJobsSystemJobsNotificationsListParamsWithTimeout ¶
func NewSystemJobsSystemJobsNotificationsListParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsNotificationsListParams
NewSystemJobsSystemJobsNotificationsListParamsWithTimeout creates a new SystemJobsSystemJobsNotificationsListParams object with the default values initialized, and the ability to set a timeout on a request
func (*SystemJobsSystemJobsNotificationsListParams) SetContext ¶
func (o *SystemJobsSystemJobsNotificationsListParams) SetContext(ctx context.Context)
SetContext adds the context to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) SetHTTPClient ¶
func (o *SystemJobsSystemJobsNotificationsListParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) SetID ¶
func (o *SystemJobsSystemJobsNotificationsListParams) SetID(id string)
SetID adds the id to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) SetPage ¶
func (o *SystemJobsSystemJobsNotificationsListParams) SetPage(page *int64)
SetPage adds the page to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) SetPageSize ¶
func (o *SystemJobsSystemJobsNotificationsListParams) SetPageSize(pageSize *int64)
SetPageSize adds the pageSize to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) SetSearch ¶
func (o *SystemJobsSystemJobsNotificationsListParams) SetSearch(search *string)
SetSearch adds the search to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) SetTimeout ¶
func (o *SystemJobsSystemJobsNotificationsListParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) WithContext ¶
func (o *SystemJobsSystemJobsNotificationsListParams) WithContext(ctx context.Context) *SystemJobsSystemJobsNotificationsListParams
WithContext adds the context to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) WithHTTPClient ¶
func (o *SystemJobsSystemJobsNotificationsListParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsNotificationsListParams
WithHTTPClient adds the HTTPClient to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) WithID ¶
func (o *SystemJobsSystemJobsNotificationsListParams) WithID(id string) *SystemJobsSystemJobsNotificationsListParams
WithID adds the id to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) WithPage ¶
func (o *SystemJobsSystemJobsNotificationsListParams) WithPage(page *int64) *SystemJobsSystemJobsNotificationsListParams
WithPage adds the page to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) WithPageSize ¶
func (o *SystemJobsSystemJobsNotificationsListParams) WithPageSize(pageSize *int64) *SystemJobsSystemJobsNotificationsListParams
WithPageSize adds the pageSize to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) WithSearch ¶
func (o *SystemJobsSystemJobsNotificationsListParams) WithSearch(search *string) *SystemJobsSystemJobsNotificationsListParams
WithSearch adds the search to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) WithTimeout ¶
func (o *SystemJobsSystemJobsNotificationsListParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsNotificationsListParams
WithTimeout adds the timeout to the system jobs system jobs notifications list params
func (*SystemJobsSystemJobsNotificationsListParams) WriteToRequest ¶
func (o *SystemJobsSystemJobsNotificationsListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SystemJobsSystemJobsNotificationsListReader ¶
type SystemJobsSystemJobsNotificationsListReader struct {
// contains filtered or unexported fields
}
SystemJobsSystemJobsNotificationsListReader is a Reader for the SystemJobsSystemJobsNotificationsList structure.
func (*SystemJobsSystemJobsNotificationsListReader) ReadResponse ¶
func (o *SystemJobsSystemJobsNotificationsListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type SystemJobsSystemJobsReadOK ¶
type SystemJobsSystemJobsReadOK struct { }
SystemJobsSystemJobsReadOK handles this case with default header values.
OK
func NewSystemJobsSystemJobsReadOK ¶
func NewSystemJobsSystemJobsReadOK() *SystemJobsSystemJobsReadOK
NewSystemJobsSystemJobsReadOK creates a SystemJobsSystemJobsReadOK with default headers values
func (*SystemJobsSystemJobsReadOK) Error ¶
func (o *SystemJobsSystemJobsReadOK) Error() string
type SystemJobsSystemJobsReadParams ¶
type SystemJobsSystemJobsReadParams struct { /*ID*/ ID string /*Search A search term. */ Search *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
SystemJobsSystemJobsReadParams contains all the parameters to send to the API endpoint for the system jobs system jobs read operation typically these are written to a http.Request
func NewSystemJobsSystemJobsReadParams ¶
func NewSystemJobsSystemJobsReadParams() *SystemJobsSystemJobsReadParams
NewSystemJobsSystemJobsReadParams creates a new SystemJobsSystemJobsReadParams object with the default values initialized.
func NewSystemJobsSystemJobsReadParamsWithContext ¶
func NewSystemJobsSystemJobsReadParamsWithContext(ctx context.Context) *SystemJobsSystemJobsReadParams
NewSystemJobsSystemJobsReadParamsWithContext creates a new SystemJobsSystemJobsReadParams object with the default values initialized, and the ability to set a context for a request
func NewSystemJobsSystemJobsReadParamsWithHTTPClient ¶
func NewSystemJobsSystemJobsReadParamsWithHTTPClient(client *http.Client) *SystemJobsSystemJobsReadParams
NewSystemJobsSystemJobsReadParamsWithHTTPClient creates a new SystemJobsSystemJobsReadParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSystemJobsSystemJobsReadParamsWithTimeout ¶
func NewSystemJobsSystemJobsReadParamsWithTimeout(timeout time.Duration) *SystemJobsSystemJobsReadParams
NewSystemJobsSystemJobsReadParamsWithTimeout creates a new SystemJobsSystemJobsReadParams object with the default values initialized, and the ability to set a timeout on a request
func (*SystemJobsSystemJobsReadParams) SetContext ¶
func (o *SystemJobsSystemJobsReadParams) SetContext(ctx context.Context)
SetContext adds the context to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) SetHTTPClient ¶
func (o *SystemJobsSystemJobsReadParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) SetID ¶
func (o *SystemJobsSystemJobsReadParams) SetID(id string)
SetID adds the id to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) SetSearch ¶
func (o *SystemJobsSystemJobsReadParams) SetSearch(search *string)
SetSearch adds the search to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) SetTimeout ¶
func (o *SystemJobsSystemJobsReadParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) WithContext ¶
func (o *SystemJobsSystemJobsReadParams) WithContext(ctx context.Context) *SystemJobsSystemJobsReadParams
WithContext adds the context to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) WithHTTPClient ¶
func (o *SystemJobsSystemJobsReadParams) WithHTTPClient(client *http.Client) *SystemJobsSystemJobsReadParams
WithHTTPClient adds the HTTPClient to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) WithID ¶
func (o *SystemJobsSystemJobsReadParams) WithID(id string) *SystemJobsSystemJobsReadParams
WithID adds the id to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) WithSearch ¶
func (o *SystemJobsSystemJobsReadParams) WithSearch(search *string) *SystemJobsSystemJobsReadParams
WithSearch adds the search to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) WithTimeout ¶
func (o *SystemJobsSystemJobsReadParams) WithTimeout(timeout time.Duration) *SystemJobsSystemJobsReadParams
WithTimeout adds the timeout to the system jobs system jobs read params
func (*SystemJobsSystemJobsReadParams) WriteToRequest ¶
func (o *SystemJobsSystemJobsReadParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SystemJobsSystemJobsReadReader ¶
type SystemJobsSystemJobsReadReader struct {
// contains filtered or unexported fields
}
SystemJobsSystemJobsReadReader is a Reader for the SystemJobsSystemJobsRead structure.
func (*SystemJobsSystemJobsReadReader) ReadResponse ¶
func (o *SystemJobsSystemJobsReadReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files
¶
- system_jobs_client.go
- system_jobs_system_jobs_cancel_create_parameters.go
- system_jobs_system_jobs_cancel_create_responses.go
- system_jobs_system_jobs_cancel_read_parameters.go
- system_jobs_system_jobs_cancel_read_responses.go
- system_jobs_system_jobs_delete_parameters.go
- system_jobs_system_jobs_delete_responses.go
- system_jobs_system_jobs_events_list_parameters.go
- system_jobs_system_jobs_events_list_responses.go
- system_jobs_system_jobs_list_parameters.go
- system_jobs_system_jobs_list_responses.go
- system_jobs_system_jobs_notifications_list_parameters.go
- system_jobs_system_jobs_notifications_list_responses.go
- system_jobs_system_jobs_read_parameters.go
- system_jobs_system_jobs_read_responses.go