ad_hoc_command_events

package
v0.0.0-...-878b285 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdHocCommandEventsAdHocCommandEventsListOK

type AdHocCommandEventsAdHocCommandEventsListOK struct {
}

AdHocCommandEventsAdHocCommandEventsListOK handles this case with default header values.

OK

func NewAdHocCommandEventsAdHocCommandEventsListOK

func NewAdHocCommandEventsAdHocCommandEventsListOK() *AdHocCommandEventsAdHocCommandEventsListOK

NewAdHocCommandEventsAdHocCommandEventsListOK creates a AdHocCommandEventsAdHocCommandEventsListOK with default headers values

func (*AdHocCommandEventsAdHocCommandEventsListOK) Error

type AdHocCommandEventsAdHocCommandEventsListParams

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

AdHocCommandEventsAdHocCommandEventsListParams contains all the parameters to send to the API endpoint for the ad hoc command events ad hoc command events list operation typically these are written to a http.Request

func NewAdHocCommandEventsAdHocCommandEventsListParams

func NewAdHocCommandEventsAdHocCommandEventsListParams() *AdHocCommandEventsAdHocCommandEventsListParams

NewAdHocCommandEventsAdHocCommandEventsListParams creates a new AdHocCommandEventsAdHocCommandEventsListParams object with the default values initialized.

func NewAdHocCommandEventsAdHocCommandEventsListParamsWithContext

func NewAdHocCommandEventsAdHocCommandEventsListParamsWithContext(ctx context.Context) *AdHocCommandEventsAdHocCommandEventsListParams

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

func NewAdHocCommandEventsAdHocCommandEventsListParamsWithHTTPClient

func NewAdHocCommandEventsAdHocCommandEventsListParamsWithHTTPClient(client *http.Client) *AdHocCommandEventsAdHocCommandEventsListParams

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

func NewAdHocCommandEventsAdHocCommandEventsListParamsWithTimeout

func NewAdHocCommandEventsAdHocCommandEventsListParamsWithTimeout(timeout time.Duration) *AdHocCommandEventsAdHocCommandEventsListParams

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

func (*AdHocCommandEventsAdHocCommandEventsListParams) SetContext

SetContext adds the context to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) SetHTTPClient

SetHTTPClient adds the HTTPClient to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) SetPage

SetPage adds the page to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) SetPageSize

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

SetPageSize adds the pageSize to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) SetSearch

SetSearch adds the search to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) SetTimeout

SetTimeout adds the timeout to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) WithContext

WithContext adds the context to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) WithPage

WithPage adds the page to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) WithPageSize

WithPageSize adds the pageSize to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) WithSearch

WithSearch adds the search to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) WithTimeout

WithTimeout adds the timeout to the ad hoc command events ad hoc command events list params

func (*AdHocCommandEventsAdHocCommandEventsListParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type AdHocCommandEventsAdHocCommandEventsListReader

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

AdHocCommandEventsAdHocCommandEventsListReader is a Reader for the AdHocCommandEventsAdHocCommandEventsList structure.

func (*AdHocCommandEventsAdHocCommandEventsListReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type AdHocCommandEventsAdHocCommandEventsReadOK

type AdHocCommandEventsAdHocCommandEventsReadOK struct {
}

AdHocCommandEventsAdHocCommandEventsReadOK handles this case with default header values.

OK

func NewAdHocCommandEventsAdHocCommandEventsReadOK

func NewAdHocCommandEventsAdHocCommandEventsReadOK() *AdHocCommandEventsAdHocCommandEventsReadOK

NewAdHocCommandEventsAdHocCommandEventsReadOK creates a AdHocCommandEventsAdHocCommandEventsReadOK with default headers values

func (*AdHocCommandEventsAdHocCommandEventsReadOK) Error

type AdHocCommandEventsAdHocCommandEventsReadParams

type AdHocCommandEventsAdHocCommandEventsReadParams struct {

	/*ID*/
	ID string
	/*Search
	  A search term.

	*/
	Search *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

AdHocCommandEventsAdHocCommandEventsReadParams contains all the parameters to send to the API endpoint for the ad hoc command events ad hoc command events read operation typically these are written to a http.Request

func NewAdHocCommandEventsAdHocCommandEventsReadParams

func NewAdHocCommandEventsAdHocCommandEventsReadParams() *AdHocCommandEventsAdHocCommandEventsReadParams

NewAdHocCommandEventsAdHocCommandEventsReadParams creates a new AdHocCommandEventsAdHocCommandEventsReadParams object with the default values initialized.

func NewAdHocCommandEventsAdHocCommandEventsReadParamsWithContext

func NewAdHocCommandEventsAdHocCommandEventsReadParamsWithContext(ctx context.Context) *AdHocCommandEventsAdHocCommandEventsReadParams

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

func NewAdHocCommandEventsAdHocCommandEventsReadParamsWithHTTPClient

func NewAdHocCommandEventsAdHocCommandEventsReadParamsWithHTTPClient(client *http.Client) *AdHocCommandEventsAdHocCommandEventsReadParams

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

func NewAdHocCommandEventsAdHocCommandEventsReadParamsWithTimeout

func NewAdHocCommandEventsAdHocCommandEventsReadParamsWithTimeout(timeout time.Duration) *AdHocCommandEventsAdHocCommandEventsReadParams

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

func (*AdHocCommandEventsAdHocCommandEventsReadParams) SetContext

SetContext adds the context to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) SetHTTPClient

SetHTTPClient adds the HTTPClient to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) SetID

SetID adds the id to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) SetSearch

SetSearch adds the search to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) SetTimeout

SetTimeout adds the timeout to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) WithContext

WithContext adds the context to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) WithID

WithID adds the id to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) WithSearch

WithSearch adds the search to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) WithTimeout

WithTimeout adds the timeout to the ad hoc command events ad hoc command events read params

func (*AdHocCommandEventsAdHocCommandEventsReadParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type AdHocCommandEventsAdHocCommandEventsReadReader

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

AdHocCommandEventsAdHocCommandEventsReadReader is a Reader for the AdHocCommandEventsAdHocCommandEventsRead structure.

func (*AdHocCommandEventsAdHocCommandEventsReadReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type Client

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

Client for ad hoc command events API

func (*Client) AdHocCommandEventsAdHocCommandEventsList

func (a *Client) AdHocCommandEventsAdHocCommandEventsList(params *AdHocCommandEventsAdHocCommandEventsListParams) (*AdHocCommandEventsAdHocCommandEventsListOK, error)
AdHocCommandEventsAdHocCommandEventsList lists ad hoc command events

Make a GET request to this resource to retrieve the list of ad hoc command events.

The resulting data structure contains:

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

The `count` field indicates the total number of ad hoc command 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 ad hoc command event records.

## Results

Each ad hoc command event data structure includes the following fields:

* `id`: Database ID for this ad hoc command event. (integer) * `type`: Data type for this ad hoc command event. (choice) * `url`: URL for this ad hoc command 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 ad hoc command event was created. (datetime) * `modified`: Timestamp when this ad hoc command event was last modified. (datetime) * `ad_hoc_command`: (id) * `event`: (choice)

  • `runner_on_failed`: Host Failed
  • `runner_on_ok`: Host OK
  • `runner_on_unreachable`: Host Unreachable
  • `runner_on_skipped`: Host Skipped
  • `debug`: Debug
  • `verbose`: Verbose
  • `deprecated`: Deprecated
  • `warning`: Warning
  • `system_warning`: System Warning
  • `error`: Error

* `counter`: (integer) * `event_display`: (string) * `event_data`: (json) * `failed`: (boolean) * `changed`: (boolean) * `uuid`: (string) * `host`: (id) * `host_name`: (string) * `stdout`: (string) * `start_line`: (integer) * `end_line`: (integer) * `verbosity`: (integer)

## Sorting

To specify that ad hoc command 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) AdHocCommandEventsAdHocCommandEventsRead

func (a *Client) AdHocCommandEventsAdHocCommandEventsRead(params *AdHocCommandEventsAdHocCommandEventsReadParams) (*AdHocCommandEventsAdHocCommandEventsReadOK, error)
AdHocCommandEventsAdHocCommandEventsRead retrieves an ad hoc command event

Make GET request to this resource to retrieve a single ad hoc command event record containing the following fields:

* `id`: Database ID for this ad hoc command event. (integer) * `type`: Data type for this ad hoc command event. (choice) * `url`: URL for this ad hoc command 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 ad hoc command event was created. (datetime) * `modified`: Timestamp when this ad hoc command event was last modified. (datetime) * `ad_hoc_command`: (id) * `event`: (choice)

  • `runner_on_failed`: Host Failed
  • `runner_on_ok`: Host OK
  • `runner_on_unreachable`: Host Unreachable
  • `runner_on_skipped`: Host Skipped
  • `debug`: Debug
  • `verbose`: Verbose
  • `deprecated`: Deprecated
  • `warning`: Warning
  • `system_warning`: System Warning
  • `error`: Error

* `counter`: (integer) * `event_display`: (string) * `event_data`: (json) * `failed`: (boolean) * `changed`: (boolean) * `uuid`: (string) * `host`: (id) * `host_name`: (string) * `stdout`: (string) * `start_line`: (integer) * `end_line`: (integer) * `verbosity`: (integer)

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	AdHocCommandEventsAdHocCommandEventsList(params *AdHocCommandEventsAdHocCommandEventsListParams) (*AdHocCommandEventsAdHocCommandEventsListOK, error)

	AdHocCommandEventsAdHocCommandEventsRead(params *AdHocCommandEventsAdHocCommandEventsReadParams) (*AdHocCommandEventsAdHocCommandEventsReadOK, 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 ad hoc command events API client.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL