unified_jobs

Documentation

Index

• type Client
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
  • func (a *Client) UnifiedJobsUnifiedJobsList(params *UnifiedJobsUnifiedJobsListParams) (*UnifiedJobsUnifiedJobsListOK, error)
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
• type UnifiedJobsUnifiedJobsListOK
  • func NewUnifiedJobsUnifiedJobsListOK() *UnifiedJobsUnifiedJobsListOK
  • func (o *UnifiedJobsUnifiedJobsListOK) Error() string
• type UnifiedJobsUnifiedJobsListParams
  • func NewUnifiedJobsUnifiedJobsListParams() *UnifiedJobsUnifiedJobsListParams
  • func NewUnifiedJobsUnifiedJobsListParamsWithContext(ctx context.Context) *UnifiedJobsUnifiedJobsListParams
  • func NewUnifiedJobsUnifiedJobsListParamsWithHTTPClient(client *http.Client) *UnifiedJobsUnifiedJobsListParams
  • func NewUnifiedJobsUnifiedJobsListParamsWithTimeout(timeout time.Duration) *UnifiedJobsUnifiedJobsListParams
  • func (o *UnifiedJobsUnifiedJobsListParams) SetContext(ctx context.Context)
  • func (o *UnifiedJobsUnifiedJobsListParams) SetHTTPClient(client *http.Client)
  • func (o *UnifiedJobsUnifiedJobsListParams) SetPage(page *int64)
  • func (o *UnifiedJobsUnifiedJobsListParams) SetPageSize(pageSize *int64)
  • func (o *UnifiedJobsUnifiedJobsListParams) SetSearch(search *string)
  • func (o *UnifiedJobsUnifiedJobsListParams) SetTimeout(timeout time.Duration)
  • func (o *UnifiedJobsUnifiedJobsListParams) WithContext(ctx context.Context) *UnifiedJobsUnifiedJobsListParams
  • func (o *UnifiedJobsUnifiedJobsListParams) WithHTTPClient(client *http.Client) *UnifiedJobsUnifiedJobsListParams
  • func (o *UnifiedJobsUnifiedJobsListParams) WithPage(page *int64) *UnifiedJobsUnifiedJobsListParams
  • func (o *UnifiedJobsUnifiedJobsListParams) WithPageSize(pageSize *int64) *UnifiedJobsUnifiedJobsListParams
  • func (o *UnifiedJobsUnifiedJobsListParams) WithSearch(search *string) *UnifiedJobsUnifiedJobsListParams
  • func (o *UnifiedJobsUnifiedJobsListParams) WithTimeout(timeout time.Duration) *UnifiedJobsUnifiedJobsListParams
  • func (o *UnifiedJobsUnifiedJobsListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type UnifiedJobsUnifiedJobsListReader
  • func (o *UnifiedJobsUnifiedJobsListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for unified jobs API

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) UnifiedJobsUnifiedJobsList

func (a *Client) UnifiedJobsUnifiedJobsList(params *UnifiedJobsUnifiedJobsListParams) (*UnifiedJobsUnifiedJobsListOK, error)

UnifiedJobsUnifiedJobsList lists unified jobs

Make a GET request to this resource to retrieve the list of unified jobs.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The `count` field indicates the total number of unified 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 unified job records.

## Results

Each unified job data structure includes the following fields:

* `id`: Database ID for this unified job. (integer) * `type`: Data type for this unified job. (choice) * `url`: URL for this unified 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 unified job was created. (datetime) * `modified`: Timestamp when this unified job was last modified. (datetime) * `name`: Name of this unified job. (string) * `description`: Optional description of this unified 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) * `controller_node`: The instance that managed the isolated execution environment. (string)

## Sorting

To specify that unified 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

type ClientService

type ClientService interface {
	UnifiedJobsUnifiedJobsList(params *UnifiedJobsUnifiedJobsListParams) (*UnifiedJobsUnifiedJobsListOK, 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 unified jobs API client.

type UnifiedJobsUnifiedJobsListOK

type UnifiedJobsUnifiedJobsListOK struct {
}

UnifiedJobsUnifiedJobsListOK handles this case with default header values.

OK

func NewUnifiedJobsUnifiedJobsListOK

func NewUnifiedJobsUnifiedJobsListOK() *UnifiedJobsUnifiedJobsListOK

NewUnifiedJobsUnifiedJobsListOK creates a UnifiedJobsUnifiedJobsListOK with default headers values

func (*UnifiedJobsUnifiedJobsListOK) Error

func (o *UnifiedJobsUnifiedJobsListOK) Error() string

type UnifiedJobsUnifiedJobsListParams

type UnifiedJobsUnifiedJobsListParams 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
}

UnifiedJobsUnifiedJobsListParams contains all the parameters to send to the API endpoint for the unified jobs unified jobs list operation typically these are written to a http.Request

func NewUnifiedJobsUnifiedJobsListParams

func NewUnifiedJobsUnifiedJobsListParams() *UnifiedJobsUnifiedJobsListParams

NewUnifiedJobsUnifiedJobsListParams creates a new UnifiedJobsUnifiedJobsListParams object with the default values initialized.

func NewUnifiedJobsUnifiedJobsListParamsWithContext

func NewUnifiedJobsUnifiedJobsListParamsWithContext(ctx context.Context) *UnifiedJobsUnifiedJobsListParams

NewUnifiedJobsUnifiedJobsListParamsWithContext creates a new UnifiedJobsUnifiedJobsListParams object with the default values initialized, and the ability to set a context for a request

func NewUnifiedJobsUnifiedJobsListParamsWithHTTPClient

func NewUnifiedJobsUnifiedJobsListParamsWithHTTPClient(client *http.Client) *UnifiedJobsUnifiedJobsListParams

NewUnifiedJobsUnifiedJobsListParamsWithHTTPClient creates a new UnifiedJobsUnifiedJobsListParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewUnifiedJobsUnifiedJobsListParamsWithTimeout

func NewUnifiedJobsUnifiedJobsListParamsWithTimeout(timeout time.Duration) *UnifiedJobsUnifiedJobsListParams

NewUnifiedJobsUnifiedJobsListParamsWithTimeout creates a new UnifiedJobsUnifiedJobsListParams object with the default values initialized, and the ability to set a timeout on a request

func (*UnifiedJobsUnifiedJobsListParams) SetContext

func (o *UnifiedJobsUnifiedJobsListParams) SetContext(ctx context.Context)

SetContext adds the context to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) SetHTTPClient

func (o *UnifiedJobsUnifiedJobsListParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) SetPage

func (o *UnifiedJobsUnifiedJobsListParams) SetPage(page *int64)

SetPage adds the page to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) SetPageSize

func (o *UnifiedJobsUnifiedJobsListParams) SetPageSize(pageSize *int64)

SetPageSize adds the pageSize to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) SetSearch

func (o *UnifiedJobsUnifiedJobsListParams) SetSearch(search *string)

SetSearch adds the search to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) SetTimeout

func (o *UnifiedJobsUnifiedJobsListParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) WithContext

func (o *UnifiedJobsUnifiedJobsListParams) WithContext(ctx context.Context) *UnifiedJobsUnifiedJobsListParams

WithContext adds the context to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) WithHTTPClient

func (o *UnifiedJobsUnifiedJobsListParams) WithHTTPClient(client *http.Client) *UnifiedJobsUnifiedJobsListParams

WithHTTPClient adds the HTTPClient to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) WithPage

func (o *UnifiedJobsUnifiedJobsListParams) WithPage(page *int64) *UnifiedJobsUnifiedJobsListParams

WithPage adds the page to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) WithPageSize

func (o *UnifiedJobsUnifiedJobsListParams) WithPageSize(pageSize *int64) *UnifiedJobsUnifiedJobsListParams

WithPageSize adds the pageSize to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) WithSearch

func (o *UnifiedJobsUnifiedJobsListParams) WithSearch(search *string) *UnifiedJobsUnifiedJobsListParams

WithSearch adds the search to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) WithTimeout

func (o *UnifiedJobsUnifiedJobsListParams) WithTimeout(timeout time.Duration) *UnifiedJobsUnifiedJobsListParams

WithTimeout adds the timeout to the unified jobs unified jobs list params

func (*UnifiedJobsUnifiedJobsListParams) WriteToRequest

func (o *UnifiedJobsUnifiedJobsListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type UnifiedJobsUnifiedJobsListReader

type UnifiedJobsUnifiedJobsListReader struct {
	// contains filtered or unexported fields
}

UnifiedJobsUnifiedJobsListReader is a Reader for the UnifiedJobsUnifiedJobsList structure.

func (*UnifiedJobsUnifiedJobsListReader) ReadResponse

func (o *UnifiedJobsUnifiedJobsListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.