Documentation
¶
Index ¶
- type CheckPoolPermissionsForbidden
- func (o *CheckPoolPermissionsForbidden) Code() int
- func (o *CheckPoolPermissionsForbidden) Error() string
- func (o *CheckPoolPermissionsForbidden) GetPayload() *models.Error
- func (o *CheckPoolPermissionsForbidden) IsClientError() bool
- func (o *CheckPoolPermissionsForbidden) IsCode(code int) bool
- func (o *CheckPoolPermissionsForbidden) IsRedirect() bool
- func (o *CheckPoolPermissionsForbidden) IsServerError() bool
- func (o *CheckPoolPermissionsForbidden) IsSuccess() bool
- func (o *CheckPoolPermissionsForbidden) String() string
- type CheckPoolPermissionsNotFound
- func (o *CheckPoolPermissionsNotFound) Code() int
- func (o *CheckPoolPermissionsNotFound) Error() string
- func (o *CheckPoolPermissionsNotFound) GetPayload() *models.Error
- func (o *CheckPoolPermissionsNotFound) IsClientError() bool
- func (o *CheckPoolPermissionsNotFound) IsCode(code int) bool
- func (o *CheckPoolPermissionsNotFound) IsRedirect() bool
- func (o *CheckPoolPermissionsNotFound) IsServerError() bool
- func (o *CheckPoolPermissionsNotFound) IsSuccess() bool
- func (o *CheckPoolPermissionsNotFound) String() string
- type CheckPoolPermissionsOK
- func (o *CheckPoolPermissionsOK) Code() int
- func (o *CheckPoolPermissionsOK) Error() string
- func (o *CheckPoolPermissionsOK) GetPayload() *models.PoolPermissionsResponse
- func (o *CheckPoolPermissionsOK) IsClientError() bool
- func (o *CheckPoolPermissionsOK) IsCode(code int) bool
- func (o *CheckPoolPermissionsOK) IsRedirect() bool
- func (o *CheckPoolPermissionsOK) IsServerError() bool
- func (o *CheckPoolPermissionsOK) IsSuccess() bool
- func (o *CheckPoolPermissionsOK) String() string
- type CheckPoolPermissionsParams
- func NewCheckPoolPermissionsParams() *CheckPoolPermissionsParams
- func NewCheckPoolPermissionsParamsWithContext(ctx context.Context) *CheckPoolPermissionsParams
- func NewCheckPoolPermissionsParamsWithHTTPClient(client *http.Client) *CheckPoolPermissionsParams
- func NewCheckPoolPermissionsParamsWithTimeout(timeout time.Duration) *CheckPoolPermissionsParams
- func (o *CheckPoolPermissionsParams) SetContext(ctx context.Context)
- func (o *CheckPoolPermissionsParams) SetDefaults()
- func (o *CheckPoolPermissionsParams) SetHTTPClient(client *http.Client)
- func (o *CheckPoolPermissionsParams) SetIPID(iPID string)
- func (o *CheckPoolPermissionsParams) SetIfMatch(ifMatch *string)
- func (o *CheckPoolPermissionsParams) SetTimeout(timeout time.Duration)
- func (o *CheckPoolPermissionsParams) WithContext(ctx context.Context) *CheckPoolPermissionsParams
- func (o *CheckPoolPermissionsParams) WithDefaults() *CheckPoolPermissionsParams
- func (o *CheckPoolPermissionsParams) WithHTTPClient(client *http.Client) *CheckPoolPermissionsParams
- func (o *CheckPoolPermissionsParams) WithIPID(iPID string) *CheckPoolPermissionsParams
- func (o *CheckPoolPermissionsParams) WithIfMatch(ifMatch *string) *CheckPoolPermissionsParams
- func (o *CheckPoolPermissionsParams) WithTimeout(timeout time.Duration) *CheckPoolPermissionsParams
- func (o *CheckPoolPermissionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type CheckPoolPermissionsReader
- type CheckPoolPermissionsTooManyRequests
- func (o *CheckPoolPermissionsTooManyRequests) Code() int
- func (o *CheckPoolPermissionsTooManyRequests) Error() string
- func (o *CheckPoolPermissionsTooManyRequests) GetPayload() *models.Error
- func (o *CheckPoolPermissionsTooManyRequests) IsClientError() bool
- func (o *CheckPoolPermissionsTooManyRequests) IsCode(code int) bool
- func (o *CheckPoolPermissionsTooManyRequests) IsRedirect() bool
- func (o *CheckPoolPermissionsTooManyRequests) IsServerError() bool
- func (o *CheckPoolPermissionsTooManyRequests) IsSuccess() bool
- func (o *CheckPoolPermissionsTooManyRequests) String() string
- type CheckPoolPermissionsUnauthorized
- func (o *CheckPoolPermissionsUnauthorized) Code() int
- func (o *CheckPoolPermissionsUnauthorized) Error() string
- func (o *CheckPoolPermissionsUnauthorized) GetPayload() *models.Error
- func (o *CheckPoolPermissionsUnauthorized) IsClientError() bool
- func (o *CheckPoolPermissionsUnauthorized) IsCode(code int) bool
- func (o *CheckPoolPermissionsUnauthorized) IsRedirect() bool
- func (o *CheckPoolPermissionsUnauthorized) IsServerError() bool
- func (o *CheckPoolPermissionsUnauthorized) IsSuccess() bool
- func (o *CheckPoolPermissionsUnauthorized) String() string
- type Client
- type ClientOption
- type ClientService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CheckPoolPermissionsForbidden ¶
CheckPoolPermissionsForbidden describes a response with status code 403, with default header values.
Forbidden
func NewCheckPoolPermissionsForbidden ¶
func NewCheckPoolPermissionsForbidden() *CheckPoolPermissionsForbidden
NewCheckPoolPermissionsForbidden creates a CheckPoolPermissionsForbidden with default headers values
func (*CheckPoolPermissionsForbidden) Code ¶
func (o *CheckPoolPermissionsForbidden) Code() int
Code gets the status code for the check pool permissions forbidden response
func (*CheckPoolPermissionsForbidden) Error ¶
func (o *CheckPoolPermissionsForbidden) Error() string
func (*CheckPoolPermissionsForbidden) GetPayload ¶
func (o *CheckPoolPermissionsForbidden) GetPayload() *models.Error
func (*CheckPoolPermissionsForbidden) IsClientError ¶
func (o *CheckPoolPermissionsForbidden) IsClientError() bool
IsClientError returns true when this check pool permissions forbidden response has a 4xx status code
func (*CheckPoolPermissionsForbidden) IsCode ¶
func (o *CheckPoolPermissionsForbidden) IsCode(code int) bool
IsCode returns true when this check pool permissions forbidden response a status code equal to that given
func (*CheckPoolPermissionsForbidden) IsRedirect ¶
func (o *CheckPoolPermissionsForbidden) IsRedirect() bool
IsRedirect returns true when this check pool permissions forbidden response has a 3xx status code
func (*CheckPoolPermissionsForbidden) IsServerError ¶
func (o *CheckPoolPermissionsForbidden) IsServerError() bool
IsServerError returns true when this check pool permissions forbidden response has a 5xx status code
func (*CheckPoolPermissionsForbidden) IsSuccess ¶
func (o *CheckPoolPermissionsForbidden) IsSuccess() bool
IsSuccess returns true when this check pool permissions forbidden response has a 2xx status code
func (*CheckPoolPermissionsForbidden) String ¶
func (o *CheckPoolPermissionsForbidden) String() string
type CheckPoolPermissionsNotFound ¶
CheckPoolPermissionsNotFound describes a response with status code 404, with default header values.
Not found
func NewCheckPoolPermissionsNotFound ¶
func NewCheckPoolPermissionsNotFound() *CheckPoolPermissionsNotFound
NewCheckPoolPermissionsNotFound creates a CheckPoolPermissionsNotFound with default headers values
func (*CheckPoolPermissionsNotFound) Code ¶
func (o *CheckPoolPermissionsNotFound) Code() int
Code gets the status code for the check pool permissions not found response
func (*CheckPoolPermissionsNotFound) Error ¶
func (o *CheckPoolPermissionsNotFound) Error() string
func (*CheckPoolPermissionsNotFound) GetPayload ¶
func (o *CheckPoolPermissionsNotFound) GetPayload() *models.Error
func (*CheckPoolPermissionsNotFound) IsClientError ¶
func (o *CheckPoolPermissionsNotFound) IsClientError() bool
IsClientError returns true when this check pool permissions not found response has a 4xx status code
func (*CheckPoolPermissionsNotFound) IsCode ¶
func (o *CheckPoolPermissionsNotFound) IsCode(code int) bool
IsCode returns true when this check pool permissions not found response a status code equal to that given
func (*CheckPoolPermissionsNotFound) IsRedirect ¶
func (o *CheckPoolPermissionsNotFound) IsRedirect() bool
IsRedirect returns true when this check pool permissions not found response has a 3xx status code
func (*CheckPoolPermissionsNotFound) IsServerError ¶
func (o *CheckPoolPermissionsNotFound) IsServerError() bool
IsServerError returns true when this check pool permissions not found response has a 5xx status code
func (*CheckPoolPermissionsNotFound) IsSuccess ¶
func (o *CheckPoolPermissionsNotFound) IsSuccess() bool
IsSuccess returns true when this check pool permissions not found response has a 2xx status code
func (*CheckPoolPermissionsNotFound) String ¶
func (o *CheckPoolPermissionsNotFound) String() string
type CheckPoolPermissionsOK ¶
type CheckPoolPermissionsOK struct { /* The ETag HTTP header is an identifier for a specific version of a resource in:header Format: etag */ Etag string Payload *models.PoolPermissionsResponse }
CheckPoolPermissionsOK describes a response with status code 200, with default header values.
PoolPermissions
func NewCheckPoolPermissionsOK ¶
func NewCheckPoolPermissionsOK() *CheckPoolPermissionsOK
NewCheckPoolPermissionsOK creates a CheckPoolPermissionsOK with default headers values
func (*CheckPoolPermissionsOK) Code ¶
func (o *CheckPoolPermissionsOK) Code() int
Code gets the status code for the check pool permissions o k response
func (*CheckPoolPermissionsOK) Error ¶
func (o *CheckPoolPermissionsOK) Error() string
func (*CheckPoolPermissionsOK) GetPayload ¶
func (o *CheckPoolPermissionsOK) GetPayload() *models.PoolPermissionsResponse
func (*CheckPoolPermissionsOK) IsClientError ¶
func (o *CheckPoolPermissionsOK) IsClientError() bool
IsClientError returns true when this check pool permissions o k response has a 4xx status code
func (*CheckPoolPermissionsOK) IsCode ¶
func (o *CheckPoolPermissionsOK) IsCode(code int) bool
IsCode returns true when this check pool permissions o k response a status code equal to that given
func (*CheckPoolPermissionsOK) IsRedirect ¶
func (o *CheckPoolPermissionsOK) IsRedirect() bool
IsRedirect returns true when this check pool permissions o k response has a 3xx status code
func (*CheckPoolPermissionsOK) IsServerError ¶
func (o *CheckPoolPermissionsOK) IsServerError() bool
IsServerError returns true when this check pool permissions o k response has a 5xx status code
func (*CheckPoolPermissionsOK) IsSuccess ¶
func (o *CheckPoolPermissionsOK) IsSuccess() bool
IsSuccess returns true when this check pool permissions o k response has a 2xx status code
func (*CheckPoolPermissionsOK) String ¶
func (o *CheckPoolPermissionsOK) String() string
type CheckPoolPermissionsParams ¶
type CheckPoolPermissionsParams struct { /* IfMatch. A server will only return requested resources if the resource matches one of the listed ETag value Format: etag */ IfMatch *string // IPID. IPID string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
CheckPoolPermissionsParams contains all the parameters to send to the API endpoint
for the check pool permissions operation. Typically these are written to a http.Request.
func NewCheckPoolPermissionsParams ¶
func NewCheckPoolPermissionsParams() *CheckPoolPermissionsParams
NewCheckPoolPermissionsParams creates a new CheckPoolPermissionsParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewCheckPoolPermissionsParamsWithContext ¶
func NewCheckPoolPermissionsParamsWithContext(ctx context.Context) *CheckPoolPermissionsParams
NewCheckPoolPermissionsParamsWithContext creates a new CheckPoolPermissionsParams object with the ability to set a context for a request.
func NewCheckPoolPermissionsParamsWithHTTPClient ¶
func NewCheckPoolPermissionsParamsWithHTTPClient(client *http.Client) *CheckPoolPermissionsParams
NewCheckPoolPermissionsParamsWithHTTPClient creates a new CheckPoolPermissionsParams object with the ability to set a custom HTTPClient for a request.
func NewCheckPoolPermissionsParamsWithTimeout ¶
func NewCheckPoolPermissionsParamsWithTimeout(timeout time.Duration) *CheckPoolPermissionsParams
NewCheckPoolPermissionsParamsWithTimeout creates a new CheckPoolPermissionsParams object with the ability to set a timeout on a request.
func (*CheckPoolPermissionsParams) SetContext ¶
func (o *CheckPoolPermissionsParams) SetContext(ctx context.Context)
SetContext adds the context to the check pool permissions params
func (*CheckPoolPermissionsParams) SetDefaults ¶
func (o *CheckPoolPermissionsParams) SetDefaults()
SetDefaults hydrates default values in the check pool permissions params (not the query body).
All values with no default are reset to their zero value.
func (*CheckPoolPermissionsParams) SetHTTPClient ¶
func (o *CheckPoolPermissionsParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the check pool permissions params
func (*CheckPoolPermissionsParams) SetIPID ¶
func (o *CheckPoolPermissionsParams) SetIPID(iPID string)
SetIPID adds the ipId to the check pool permissions params
func (*CheckPoolPermissionsParams) SetIfMatch ¶
func (o *CheckPoolPermissionsParams) SetIfMatch(ifMatch *string)
SetIfMatch adds the ifMatch to the check pool permissions params
func (*CheckPoolPermissionsParams) SetTimeout ¶
func (o *CheckPoolPermissionsParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the check pool permissions params
func (*CheckPoolPermissionsParams) WithContext ¶
func (o *CheckPoolPermissionsParams) WithContext(ctx context.Context) *CheckPoolPermissionsParams
WithContext adds the context to the check pool permissions params
func (*CheckPoolPermissionsParams) WithDefaults ¶
func (o *CheckPoolPermissionsParams) WithDefaults() *CheckPoolPermissionsParams
WithDefaults hydrates default values in the check pool permissions params (not the query body).
All values with no default are reset to their zero value.
func (*CheckPoolPermissionsParams) WithHTTPClient ¶
func (o *CheckPoolPermissionsParams) WithHTTPClient(client *http.Client) *CheckPoolPermissionsParams
WithHTTPClient adds the HTTPClient to the check pool permissions params
func (*CheckPoolPermissionsParams) WithIPID ¶
func (o *CheckPoolPermissionsParams) WithIPID(iPID string) *CheckPoolPermissionsParams
WithIPID adds the iPID to the check pool permissions params
func (*CheckPoolPermissionsParams) WithIfMatch ¶
func (o *CheckPoolPermissionsParams) WithIfMatch(ifMatch *string) *CheckPoolPermissionsParams
WithIfMatch adds the ifMatch to the check pool permissions params
func (*CheckPoolPermissionsParams) WithTimeout ¶
func (o *CheckPoolPermissionsParams) WithTimeout(timeout time.Duration) *CheckPoolPermissionsParams
WithTimeout adds the timeout to the check pool permissions params
func (*CheckPoolPermissionsParams) WriteToRequest ¶
func (o *CheckPoolPermissionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type CheckPoolPermissionsReader ¶
type CheckPoolPermissionsReader struct {
// contains filtered or unexported fields
}
CheckPoolPermissionsReader is a Reader for the CheckPoolPermissions structure.
func (*CheckPoolPermissionsReader) ReadResponse ¶
func (o *CheckPoolPermissionsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type CheckPoolPermissionsTooManyRequests ¶
CheckPoolPermissionsTooManyRequests describes a response with status code 429, with default header values.
Too many requests
func NewCheckPoolPermissionsTooManyRequests ¶
func NewCheckPoolPermissionsTooManyRequests() *CheckPoolPermissionsTooManyRequests
NewCheckPoolPermissionsTooManyRequests creates a CheckPoolPermissionsTooManyRequests with default headers values
func (*CheckPoolPermissionsTooManyRequests) Code ¶
func (o *CheckPoolPermissionsTooManyRequests) Code() int
Code gets the status code for the check pool permissions too many requests response
func (*CheckPoolPermissionsTooManyRequests) Error ¶
func (o *CheckPoolPermissionsTooManyRequests) Error() string
func (*CheckPoolPermissionsTooManyRequests) GetPayload ¶
func (o *CheckPoolPermissionsTooManyRequests) GetPayload() *models.Error
func (*CheckPoolPermissionsTooManyRequests) IsClientError ¶
func (o *CheckPoolPermissionsTooManyRequests) IsClientError() bool
IsClientError returns true when this check pool permissions too many requests response has a 4xx status code
func (*CheckPoolPermissionsTooManyRequests) IsCode ¶
func (o *CheckPoolPermissionsTooManyRequests) IsCode(code int) bool
IsCode returns true when this check pool permissions too many requests response a status code equal to that given
func (*CheckPoolPermissionsTooManyRequests) IsRedirect ¶
func (o *CheckPoolPermissionsTooManyRequests) IsRedirect() bool
IsRedirect returns true when this check pool permissions too many requests response has a 3xx status code
func (*CheckPoolPermissionsTooManyRequests) IsServerError ¶
func (o *CheckPoolPermissionsTooManyRequests) IsServerError() bool
IsServerError returns true when this check pool permissions too many requests response has a 5xx status code
func (*CheckPoolPermissionsTooManyRequests) IsSuccess ¶
func (o *CheckPoolPermissionsTooManyRequests) IsSuccess() bool
IsSuccess returns true when this check pool permissions too many requests response has a 2xx status code
func (*CheckPoolPermissionsTooManyRequests) String ¶
func (o *CheckPoolPermissionsTooManyRequests) String() string
type CheckPoolPermissionsUnauthorized ¶
type CheckPoolPermissionsUnauthorized struct {
}CheckPoolPermissionsUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewCheckPoolPermissionsUnauthorized ¶
func NewCheckPoolPermissionsUnauthorized() *CheckPoolPermissionsUnauthorized
NewCheckPoolPermissionsUnauthorized creates a CheckPoolPermissionsUnauthorized with default headers values
func (*CheckPoolPermissionsUnauthorized) Code ¶
func (o *CheckPoolPermissionsUnauthorized) Code() int
Code gets the status code for the check pool permissions unauthorized response
func (*CheckPoolPermissionsUnauthorized) Error ¶
func (o *CheckPoolPermissionsUnauthorized) Error() string
func (*CheckPoolPermissionsUnauthorized) GetPayload ¶
func (o *CheckPoolPermissionsUnauthorized) GetPayload() *models.Error
func (*CheckPoolPermissionsUnauthorized) IsClientError ¶
func (o *CheckPoolPermissionsUnauthorized) IsClientError() bool
IsClientError returns true when this check pool permissions unauthorized response has a 4xx status code
func (*CheckPoolPermissionsUnauthorized) IsCode ¶
func (o *CheckPoolPermissionsUnauthorized) IsCode(code int) bool
IsCode returns true when this check pool permissions unauthorized response a status code equal to that given
func (*CheckPoolPermissionsUnauthorized) IsRedirect ¶
func (o *CheckPoolPermissionsUnauthorized) IsRedirect() bool
IsRedirect returns true when this check pool permissions unauthorized response has a 3xx status code
func (*CheckPoolPermissionsUnauthorized) IsServerError ¶
func (o *CheckPoolPermissionsUnauthorized) IsServerError() bool
IsServerError returns true when this check pool permissions unauthorized response has a 5xx status code
func (*CheckPoolPermissionsUnauthorized) IsSuccess ¶
func (o *CheckPoolPermissionsUnauthorized) IsSuccess() bool
IsSuccess returns true when this check pool permissions unauthorized response has a 2xx status code
func (*CheckPoolPermissionsUnauthorized) String ¶
func (o *CheckPoolPermissionsUnauthorized) String() string
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for permissions API
func (*Client) CheckPoolPermissions ¶
func (a *Client) CheckPoolPermissions(params *CheckPoolPermissionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CheckPoolPermissionsOK, error)
CheckPoolPermissions checks identity pool permissions Check permissions granted to the current administrator relating to the identity pool specified.
Pass the required identity pool identifier as the value of the `ipID` path parameter.
For authorization, include the `if-match` header with the ETag value.
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientOption ¶
type ClientOption func(*runtime.ClientOperation)
ClientOption may be used to customize the behavior of Client methods.
type ClientService ¶
type ClientService interface { CheckPoolPermissions(params *CheckPoolPermissionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CheckPoolPermissionsOK, 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 permissions API client.
func NewClientWithBasicAuth ¶
func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService
New creates a new permissions API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.
func NewClientWithBearerToken ¶
func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService
New creates a new permissions API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.