Documentation
¶
Index ¶
- type Client
- type ClientService
- type UnifiedJobTemplatesUnifiedJobTemplatesListOK
- type UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func NewUnifiedJobTemplatesUnifiedJobTemplatesListParams() *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithContext(ctx context.Context) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithHTTPClient(client *http.Client) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithTimeout(timeout time.Duration) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetContext(ctx context.Context)
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetHTTPClient(client *http.Client)
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetPage(page *int64)
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetPageSize(pageSize *int64)
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetSearch(search *string)
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetTimeout(timeout time.Duration)
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithContext(ctx context.Context) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithHTTPClient(client *http.Client) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithPage(page *int64) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithPageSize(pageSize *int64) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithSearch(search *string) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithTimeout(timeout time.Duration) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
- func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type UnifiedJobTemplatesUnifiedJobTemplatesListReader
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 unified job templates API
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) UnifiedJobTemplatesUnifiedJobTemplatesList ¶
func (a *Client) UnifiedJobTemplatesUnifiedJobTemplatesList(params *UnifiedJobTemplatesUnifiedJobTemplatesListParams) (*UnifiedJobTemplatesUnifiedJobTemplatesListOK, error)
UnifiedJobTemplatesUnifiedJobTemplatesList lists unified job templates
Make a GET request to this resource to retrieve the list of unified job templates.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The `count` field indicates the total number of unified job templates 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 template records.
## Results
Each unified job template data structure includes the following fields:
* `id`: Database ID for this unified job template. (integer) * `type`: Data type for this unified job template. (choice) * `url`: URL for this unified job template. (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 template was created. (datetime) * `modified`: Timestamp when this unified job template was last modified. (datetime) * `name`: Name of this unified job template. (string) * `description`: Optional description of this unified job template. (string) * `last_job_run`: (datetime) * `last_job_failed`: (boolean) * `next_job_run`: (datetime) * `status`: (choice)
- `new`: New
- `pending`: Pending
- `waiting`: Waiting
- `running`: Running
- `successful`: Successful
- `failed`: Failed
- `error`: Error
- `canceled`: Canceled
- `never updated`: Never Updated
- `ok`: OK
- `missing`: Missing
- `none`: No External Source
- `updating`: Updating
## Sorting
To specify that unified job templates 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 {
UnifiedJobTemplatesUnifiedJobTemplatesList(params *UnifiedJobTemplatesUnifiedJobTemplatesListParams) (*UnifiedJobTemplatesUnifiedJobTemplatesListOK, 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 job templates API client.
type UnifiedJobTemplatesUnifiedJobTemplatesListOK ¶
type UnifiedJobTemplatesUnifiedJobTemplatesListOK struct {
}
UnifiedJobTemplatesUnifiedJobTemplatesListOK handles this case with default header values.
OK
func NewUnifiedJobTemplatesUnifiedJobTemplatesListOK ¶
func NewUnifiedJobTemplatesUnifiedJobTemplatesListOK() *UnifiedJobTemplatesUnifiedJobTemplatesListOK
NewUnifiedJobTemplatesUnifiedJobTemplatesListOK creates a UnifiedJobTemplatesUnifiedJobTemplatesListOK with default headers values
func (*UnifiedJobTemplatesUnifiedJobTemplatesListOK) Error ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListOK) Error() string
type UnifiedJobTemplatesUnifiedJobTemplatesListParams ¶
type UnifiedJobTemplatesUnifiedJobTemplatesListParams 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
}
UnifiedJobTemplatesUnifiedJobTemplatesListParams contains all the parameters to send to the API endpoint for the unified job templates unified job templates list operation typically these are written to a http.Request
func NewUnifiedJobTemplatesUnifiedJobTemplatesListParams ¶
func NewUnifiedJobTemplatesUnifiedJobTemplatesListParams() *UnifiedJobTemplatesUnifiedJobTemplatesListParams
NewUnifiedJobTemplatesUnifiedJobTemplatesListParams creates a new UnifiedJobTemplatesUnifiedJobTemplatesListParams object with the default values initialized.
func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithContext ¶
func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithContext(ctx context.Context) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithContext creates a new UnifiedJobTemplatesUnifiedJobTemplatesListParams object with the default values initialized, and the ability to set a context for a request
func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithHTTPClient ¶
func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithHTTPClient(client *http.Client) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithHTTPClient creates a new UnifiedJobTemplatesUnifiedJobTemplatesListParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithTimeout ¶
func NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithTimeout(timeout time.Duration) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
NewUnifiedJobTemplatesUnifiedJobTemplatesListParamsWithTimeout creates a new UnifiedJobTemplatesUnifiedJobTemplatesListParams object with the default values initialized, and the ability to set a timeout on a request
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetContext ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetContext(ctx context.Context)
SetContext adds the context to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetHTTPClient ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetPage ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetPage(page *int64)
SetPage adds the page to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetPageSize ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetPageSize(pageSize *int64)
SetPageSize adds the pageSize to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetSearch ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetSearch(search *string)
SetSearch adds the search to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetTimeout ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithContext ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithContext(ctx context.Context) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
WithContext adds the context to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithHTTPClient ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithHTTPClient(client *http.Client) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
WithHTTPClient adds the HTTPClient to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithPage ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithPage(page *int64) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
WithPage adds the page to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithPageSize ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithPageSize(pageSize *int64) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
WithPageSize adds the pageSize to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithSearch ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithSearch(search *string) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
WithSearch adds the search to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithTimeout ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WithTimeout(timeout time.Duration) *UnifiedJobTemplatesUnifiedJobTemplatesListParams
WithTimeout adds the timeout to the unified job templates unified job templates list params
func (*UnifiedJobTemplatesUnifiedJobTemplatesListParams) WriteToRequest ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type UnifiedJobTemplatesUnifiedJobTemplatesListReader ¶
type UnifiedJobTemplatesUnifiedJobTemplatesListReader struct {
// contains filtered or unexported fields
}
UnifiedJobTemplatesUnifiedJobTemplatesListReader is a Reader for the UnifiedJobTemplatesUnifiedJobTemplatesList structure.
func (*UnifiedJobTemplatesUnifiedJobTemplatesListReader) ReadResponse ¶
func (o *UnifiedJobTemplatesUnifiedJobTemplatesListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files