Documentation ¶
Index ¶
- type Client
- type ClientService
- type GetAPI24SessionsParams
- func NewGetAPI24SessionsParams() *GetAPI24SessionsParams
- func NewGetAPI24SessionsParamsWithContext(ctx context.Context) *GetAPI24SessionsParams
- func NewGetAPI24SessionsParamsWithHTTPClient(client *http.Client) *GetAPI24SessionsParams
- func NewGetAPI24SessionsParamsWithTimeout(timeout time.Duration) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) SetAuthorization(authorization *string)
- func (o *GetAPI24SessionsParams) SetContext(ctx context.Context)
- func (o *GetAPI24SessionsParams) SetContinuationToken(continuationToken *string)
- func (o *GetAPI24SessionsParams) SetFilter(filter *string)
- func (o *GetAPI24SessionsParams) SetHTTPClient(client *http.Client)
- func (o *GetAPI24SessionsParams) SetIds(ids []string)
- func (o *GetAPI24SessionsParams) SetLimit(limit *int32)
- func (o *GetAPI24SessionsParams) SetNames(names []string)
- func (o *GetAPI24SessionsParams) SetOffset(offset *int32)
- func (o *GetAPI24SessionsParams) SetSort(sort []string)
- func (o *GetAPI24SessionsParams) SetTimeout(timeout time.Duration)
- func (o *GetAPI24SessionsParams) SetTotalItemCount(totalItemCount *bool)
- func (o *GetAPI24SessionsParams) SetXRequestID(xRequestID *string)
- func (o *GetAPI24SessionsParams) WithAuthorization(authorization *string) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithContext(ctx context.Context) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithContinuationToken(continuationToken *string) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithFilter(filter *string) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithHTTPClient(client *http.Client) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithIds(ids []string) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithLimit(limit *int32) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithNames(names []string) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithOffset(offset *int32) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithSort(sort []string) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithTimeout(timeout time.Duration) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithTotalItemCount(totalItemCount *bool) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WithXRequestID(xRequestID *string) *GetAPI24SessionsParams
- func (o *GetAPI24SessionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetAPI24SessionsReader
- type GetApi24SessionsBadRequest
- type GetApi24SessionsOK
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 sessions API
func (*Client) GetAPI24Sessions ¶
func (a *Client) GetAPI24Sessions(params *GetAPI24SessionsParams) (*GetApi24SessionsOK, error)
GetAPI24Sessions lists session data
Displays session data for user login events performed in the Purity//FA GUI, CLI, and REST API.
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface { GetAPI24Sessions(params *GetAPI24SessionsParams) (*GetApi24SessionsOK, 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 sessions API client.
type GetAPI24SessionsParams ¶
type GetAPI24SessionsParams struct { /*Authorization Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) */ Authorization *string /*XRequestID Supplied by client during request or generated by server. */ XRequestID *string /*ContinuationToken A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. */ ContinuationToken *string /*Filter Narrows down the results to only the response objects that satisfy the filter criteria. */ Filter *string /*Ids Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together. */ Ids []string /*Limit Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. */ Limit *int32 /*Names Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`. */ Names []string /*Offset The starting position based on the results of the query in relation to the full set of response objects returned. */ Offset *int32 /*Sort Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values. */ Sort []string /*TotalItemCount If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`. */ TotalItemCount *bool Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetAPI24SessionsParams contains all the parameters to send to the API endpoint for the get API 24 sessions operation typically these are written to a http.Request
func NewGetAPI24SessionsParams ¶
func NewGetAPI24SessionsParams() *GetAPI24SessionsParams
NewGetAPI24SessionsParams creates a new GetAPI24SessionsParams object with the default values initialized.
func NewGetAPI24SessionsParamsWithContext ¶
func NewGetAPI24SessionsParamsWithContext(ctx context.Context) *GetAPI24SessionsParams
NewGetAPI24SessionsParamsWithContext creates a new GetAPI24SessionsParams object with the default values initialized, and the ability to set a context for a request
func NewGetAPI24SessionsParamsWithHTTPClient ¶
func NewGetAPI24SessionsParamsWithHTTPClient(client *http.Client) *GetAPI24SessionsParams
NewGetAPI24SessionsParamsWithHTTPClient creates a new GetAPI24SessionsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetAPI24SessionsParamsWithTimeout ¶
func NewGetAPI24SessionsParamsWithTimeout(timeout time.Duration) *GetAPI24SessionsParams
NewGetAPI24SessionsParamsWithTimeout creates a new GetAPI24SessionsParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetAPI24SessionsParams) SetAuthorization ¶
func (o *GetAPI24SessionsParams) SetAuthorization(authorization *string)
SetAuthorization adds the authorization to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetContext ¶
func (o *GetAPI24SessionsParams) SetContext(ctx context.Context)
SetContext adds the context to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetContinuationToken ¶
func (o *GetAPI24SessionsParams) SetContinuationToken(continuationToken *string)
SetContinuationToken adds the continuationToken to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetFilter ¶
func (o *GetAPI24SessionsParams) SetFilter(filter *string)
SetFilter adds the filter to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetHTTPClient ¶
func (o *GetAPI24SessionsParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetIds ¶
func (o *GetAPI24SessionsParams) SetIds(ids []string)
SetIds adds the ids to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetLimit ¶
func (o *GetAPI24SessionsParams) SetLimit(limit *int32)
SetLimit adds the limit to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetNames ¶
func (o *GetAPI24SessionsParams) SetNames(names []string)
SetNames adds the names to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetOffset ¶
func (o *GetAPI24SessionsParams) SetOffset(offset *int32)
SetOffset adds the offset to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetSort ¶
func (o *GetAPI24SessionsParams) SetSort(sort []string)
SetSort adds the sort to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetTimeout ¶
func (o *GetAPI24SessionsParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetTotalItemCount ¶
func (o *GetAPI24SessionsParams) SetTotalItemCount(totalItemCount *bool)
SetTotalItemCount adds the totalItemCount to the get API 24 sessions params
func (*GetAPI24SessionsParams) SetXRequestID ¶
func (o *GetAPI24SessionsParams) SetXRequestID(xRequestID *string)
SetXRequestID adds the xRequestId to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithAuthorization ¶
func (o *GetAPI24SessionsParams) WithAuthorization(authorization *string) *GetAPI24SessionsParams
WithAuthorization adds the authorization to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithContext ¶
func (o *GetAPI24SessionsParams) WithContext(ctx context.Context) *GetAPI24SessionsParams
WithContext adds the context to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithContinuationToken ¶
func (o *GetAPI24SessionsParams) WithContinuationToken(continuationToken *string) *GetAPI24SessionsParams
WithContinuationToken adds the continuationToken to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithFilter ¶
func (o *GetAPI24SessionsParams) WithFilter(filter *string) *GetAPI24SessionsParams
WithFilter adds the filter to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithHTTPClient ¶
func (o *GetAPI24SessionsParams) WithHTTPClient(client *http.Client) *GetAPI24SessionsParams
WithHTTPClient adds the HTTPClient to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithIds ¶
func (o *GetAPI24SessionsParams) WithIds(ids []string) *GetAPI24SessionsParams
WithIds adds the ids to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithLimit ¶
func (o *GetAPI24SessionsParams) WithLimit(limit *int32) *GetAPI24SessionsParams
WithLimit adds the limit to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithNames ¶
func (o *GetAPI24SessionsParams) WithNames(names []string) *GetAPI24SessionsParams
WithNames adds the names to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithOffset ¶
func (o *GetAPI24SessionsParams) WithOffset(offset *int32) *GetAPI24SessionsParams
WithOffset adds the offset to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithSort ¶
func (o *GetAPI24SessionsParams) WithSort(sort []string) *GetAPI24SessionsParams
WithSort adds the sort to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithTimeout ¶
func (o *GetAPI24SessionsParams) WithTimeout(timeout time.Duration) *GetAPI24SessionsParams
WithTimeout adds the timeout to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithTotalItemCount ¶
func (o *GetAPI24SessionsParams) WithTotalItemCount(totalItemCount *bool) *GetAPI24SessionsParams
WithTotalItemCount adds the totalItemCount to the get API 24 sessions params
func (*GetAPI24SessionsParams) WithXRequestID ¶
func (o *GetAPI24SessionsParams) WithXRequestID(xRequestID *string) *GetAPI24SessionsParams
WithXRequestID adds the xRequestID to the get API 24 sessions params
func (*GetAPI24SessionsParams) WriteToRequest ¶
func (o *GetAPI24SessionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetAPI24SessionsReader ¶
type GetAPI24SessionsReader struct {
// contains filtered or unexported fields
}
GetAPI24SessionsReader is a Reader for the GetAPI24Sessions structure.
func (*GetAPI24SessionsReader) ReadResponse ¶
func (o *GetAPI24SessionsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetApi24SessionsBadRequest ¶
GetApi24SessionsBadRequest handles this case with default header values.
BadRequest
func NewGetApi24SessionsBadRequest ¶
func NewGetApi24SessionsBadRequest() *GetApi24SessionsBadRequest
NewGetApi24SessionsBadRequest creates a GetApi24SessionsBadRequest with default headers values
func (*GetApi24SessionsBadRequest) Error ¶
func (o *GetApi24SessionsBadRequest) Error() string
func (*GetApi24SessionsBadRequest) GetPayload ¶
func (o *GetApi24SessionsBadRequest) GetPayload() *models.Error
type GetApi24SessionsOK ¶
type GetApi24SessionsOK struct {
Payload *models.SessionGetResponse
}
GetApi24SessionsOK handles this case with default header values.
OK
func NewGetApi24SessionsOK ¶
func NewGetApi24SessionsOK() *GetApi24SessionsOK
NewGetApi24SessionsOK creates a GetApi24SessionsOK with default headers values
func (*GetApi24SessionsOK) Error ¶
func (o *GetApi24SessionsOK) Error() string
func (*GetApi24SessionsOK) GetPayload ¶
func (o *GetApi24SessionsOK) GetPayload() *models.SessionGetResponse