activity_streams

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 ActivityStreamsActivityStreamListOK

type ActivityStreamsActivityStreamListOK struct {
}

ActivityStreamsActivityStreamListOK handles this case with default header values.

OK

func NewActivityStreamsActivityStreamListOK

func NewActivityStreamsActivityStreamListOK() *ActivityStreamsActivityStreamListOK

NewActivityStreamsActivityStreamListOK creates a ActivityStreamsActivityStreamListOK with default headers values

func (*ActivityStreamsActivityStreamListOK) Error

type ActivityStreamsActivityStreamListParams

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

ActivityStreamsActivityStreamListParams contains all the parameters to send to the API endpoint for the activity streams activity stream list operation typically these are written to a http.Request

func NewActivityStreamsActivityStreamListParams

func NewActivityStreamsActivityStreamListParams() *ActivityStreamsActivityStreamListParams

NewActivityStreamsActivityStreamListParams creates a new ActivityStreamsActivityStreamListParams object with the default values initialized.

func NewActivityStreamsActivityStreamListParamsWithContext

func NewActivityStreamsActivityStreamListParamsWithContext(ctx context.Context) *ActivityStreamsActivityStreamListParams

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

func NewActivityStreamsActivityStreamListParamsWithHTTPClient

func NewActivityStreamsActivityStreamListParamsWithHTTPClient(client *http.Client) *ActivityStreamsActivityStreamListParams

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

func NewActivityStreamsActivityStreamListParamsWithTimeout

func NewActivityStreamsActivityStreamListParamsWithTimeout(timeout time.Duration) *ActivityStreamsActivityStreamListParams

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

func (*ActivityStreamsActivityStreamListParams) SetContext

SetContext adds the context to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) SetPage

SetPage adds the page to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) SetPageSize

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

SetPageSize adds the pageSize to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) SetSearch

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

SetSearch adds the search to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) SetTimeout

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

SetTimeout adds the timeout to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) WithContext

WithContext adds the context to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) WithPage

WithPage adds the page to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) WithPageSize

WithPageSize adds the pageSize to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) WithSearch

WithSearch adds the search to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) WithTimeout

WithTimeout adds the timeout to the activity streams activity stream list params

func (*ActivityStreamsActivityStreamListParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type ActivityStreamsActivityStreamListReader

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

ActivityStreamsActivityStreamListReader is a Reader for the ActivityStreamsActivityStreamList structure.

func (*ActivityStreamsActivityStreamListReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type ActivityStreamsActivityStreamReadOK

type ActivityStreamsActivityStreamReadOK struct {
}

ActivityStreamsActivityStreamReadOK handles this case with default header values.

OK

func NewActivityStreamsActivityStreamReadOK

func NewActivityStreamsActivityStreamReadOK() *ActivityStreamsActivityStreamReadOK

NewActivityStreamsActivityStreamReadOK creates a ActivityStreamsActivityStreamReadOK with default headers values

func (*ActivityStreamsActivityStreamReadOK) Error

type ActivityStreamsActivityStreamReadParams

type ActivityStreamsActivityStreamReadParams struct {

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

	*/
	Search *string

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

ActivityStreamsActivityStreamReadParams contains all the parameters to send to the API endpoint for the activity streams activity stream read operation typically these are written to a http.Request

func NewActivityStreamsActivityStreamReadParams

func NewActivityStreamsActivityStreamReadParams() *ActivityStreamsActivityStreamReadParams

NewActivityStreamsActivityStreamReadParams creates a new ActivityStreamsActivityStreamReadParams object with the default values initialized.

func NewActivityStreamsActivityStreamReadParamsWithContext

func NewActivityStreamsActivityStreamReadParamsWithContext(ctx context.Context) *ActivityStreamsActivityStreamReadParams

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

func NewActivityStreamsActivityStreamReadParamsWithHTTPClient

func NewActivityStreamsActivityStreamReadParamsWithHTTPClient(client *http.Client) *ActivityStreamsActivityStreamReadParams

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

func NewActivityStreamsActivityStreamReadParamsWithTimeout

func NewActivityStreamsActivityStreamReadParamsWithTimeout(timeout time.Duration) *ActivityStreamsActivityStreamReadParams

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

func (*ActivityStreamsActivityStreamReadParams) SetContext

SetContext adds the context to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) SetID

SetID adds the id to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) SetSearch

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

SetSearch adds the search to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) SetTimeout

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

SetTimeout adds the timeout to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) WithContext

WithContext adds the context to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) WithID

WithID adds the id to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) WithSearch

WithSearch adds the search to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) WithTimeout

WithTimeout adds the timeout to the activity streams activity stream read params

func (*ActivityStreamsActivityStreamReadParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type ActivityStreamsActivityStreamReadReader

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

ActivityStreamsActivityStreamReadReader is a Reader for the ActivityStreamsActivityStreamRead structure.

func (*ActivityStreamsActivityStreamReadReader) ReadResponse

func (o *ActivityStreamsActivityStreamReadReader) 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 activity streams API

func (*Client) ActivityStreamsActivityStreamList

func (a *Client) ActivityStreamsActivityStreamList(params *ActivityStreamsActivityStreamListParams) (*ActivityStreamsActivityStreamListOK, error)
ActivityStreamsActivityStreamList lists activity streams

Make a GET request to this resource to retrieve the list of activity streams.

The resulting data structure contains:

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

The `count` field indicates the total number of activity streams 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 activity stream records.

## Results

Each activity stream data structure includes the following fields:

* `id`: Database ID for this activity stream. (integer) * `type`: Data type for this activity stream. (choice) * `url`: URL for this activity stream. (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) * `timestamp`: (datetime) * `operation`: The action taken with respect to the given object(s). (choice)

  • `create`: Entity Created
  • `update`: Entity Updated
  • `delete`: Entity Deleted
  • `associate`: Entity Associated with another Entity
  • `disassociate`: Entity was Disassociated with another Entity

* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json) * `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string) * `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string) * `object_association`: When present, shows the field name of the role or relationship that changed. (field) * `action_node`: The cluster node the activity took place on. (string) * `object_type`: When present, shows the model on which the role or relationship was defined. (field)

## Sorting

To specify that activity streams are returned in a particular order, use the `order_by` query string parameter on the GET request.

?order_by=

Prefix the field name with a dash `-` to sort in reverse:

?order_by=-

Multiple sorting fields may be specified by separating the field names with a comma `,`:

?order_by=,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) ActivityStreamsActivityStreamRead

func (a *Client) ActivityStreamsActivityStreamRead(params *ActivityStreamsActivityStreamReadParams) (*ActivityStreamsActivityStreamReadOK, error)
ActivityStreamsActivityStreamRead retrieves an activity stream

Make GET request to this resource to retrieve a single activity stream record containing the following fields:

* `id`: Database ID for this activity stream. (integer) * `type`: Data type for this activity stream. (choice) * `url`: URL for this activity stream. (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) * `timestamp`: (datetime) * `operation`: The action taken with respect to the given object(s). (choice)

  • `create`: Entity Created
  • `update`: Entity Updated
  • `delete`: Entity Deleted
  • `associate`: Entity Associated with another Entity
  • `disassociate`: Entity was Disassociated with another Entity

* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json) * `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string) * `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string) * `object_association`: When present, shows the field name of the role or relationship that changed. (field) * `action_node`: The cluster node the activity took place on. (string) * `object_type`: When present, shows the model on which the role or relationship was defined. (field)

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	ActivityStreamsActivityStreamList(params *ActivityStreamsActivityStreamListParams) (*ActivityStreamsActivityStreamListOK, error)

	ActivityStreamsActivityStreamRead(params *ActivityStreamsActivityStreamReadParams) (*ActivityStreamsActivityStreamReadOK, 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 activity streams API client.

Jump to

Keyboard shortcuts

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