The highest tagged major version is
Documentation
¶
Index ¶
- type Client
- type GetInfoDefault
- type GetInfoOK
- type GetInfoParams
- func (o *GetInfoParams) SetContext(ctx context.Context)
- func (o *GetInfoParams) SetHTTPClient(client *http.Client)
- func (o *GetInfoParams) SetTimeout(timeout time.Duration)
- func (o *GetInfoParams) SetXGiantSwarmActivity(xGiantSwarmActivity *string)
- func (o *GetInfoParams) SetXGiantSwarmCmdLine(xGiantSwarmCmdLine *string)
- func (o *GetInfoParams) SetXRequestID(xRequestID *string)
- func (o *GetInfoParams) WithContext(ctx context.Context) *GetInfoParams
- func (o *GetInfoParams) WithHTTPClient(client *http.Client) *GetInfoParams
- func (o *GetInfoParams) WithTimeout(timeout time.Duration) *GetInfoParams
- func (o *GetInfoParams) WithXGiantSwarmActivity(xGiantSwarmActivity *string) *GetInfoParams
- func (o *GetInfoParams) WithXGiantSwarmCmdLine(xGiantSwarmCmdLine *string) *GetInfoParams
- func (o *GetInfoParams) WithXRequestID(xRequestID *string) *GetInfoParams
- func (o *GetInfoParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetInfoReader
- type GetInfoUnauthorized
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 info API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new info API client.
func (*Client) GetInfo ¶
func (a *Client) GetInfo(params *GetInfoParams, authInfo runtime.ClientAuthInfoWriter) (*GetInfoOK, error)
GetInfo gets information on the installation
Returns a set of details on the installation. The output varies based on the provider used in the installation.
This information is useful for example when creating new cluster, to prevent creating clusters with more worker nodes than possible.
### Example for an AWS-based installation
```json
{
"general": {
"installation_name": "shire",
"provider": "aws",
"datacenter": "eu-central-1",
"availability_zones": {
"max": 3,
"default": 1,
"zones": [
"eu-central-1a", "eu-central-1b", "eu-central-1c"
]
}
},
"stats": {
"cluster_creation_duration": {
"median": 750,
"p25": 700,
"p75": 800
}
},
"workers": {
"count_per_cluster": {
"max": null,
"default": 3
},
"instance_type": {
"options": [
"m3.medium", "m3.large", "m3.xlarge"
],
"default": "m3.large"
}
}
}
```
### Example for a KVM-based installation
```json
{
"general": {
"installation_name": "isengard",
"provider": "kvm",
"datacenter": "string",
"availability_zones": {
"max": 1,
"default": 1,
}
},
"stats": {
"cluster_creation_duration": {
"median": 750,
"p25": 700,
"p75": 800
}
},
"workers": {
"count_per_cluster": {
"max": 8,
"default": 3
},
}
}
```
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type GetInfoDefault ¶
type GetInfoDefault struct {
Payload *models.V4GenericResponse
// contains filtered or unexported fields
}
GetInfoDefault handles this case with default header values.
Error
func NewGetInfoDefault ¶
func NewGetInfoDefault(code int) *GetInfoDefault
NewGetInfoDefault creates a GetInfoDefault with default headers values
func (*GetInfoDefault) Code ¶
func (o *GetInfoDefault) Code() int
Code gets the status code for the get info default response
func (*GetInfoDefault) Error ¶
func (o *GetInfoDefault) Error() string
type GetInfoOK ¶
type GetInfoOK struct {
Payload *models.V4InfoResponse
}
GetInfoOK handles this case with default header values.
Information
func NewGetInfoOK ¶
func NewGetInfoOK() *GetInfoOK
NewGetInfoOK creates a GetInfoOK with default headers values
type GetInfoParams ¶
type GetInfoParams struct {
/*XGiantSwarmActivity
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
*/
XGiantSwarmActivity *string
/*XGiantSwarmCmdLine
If activity has been issued by a CLI, this header can contain the
command line
*/
XGiantSwarmCmdLine *string
/*XRequestID
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
*/
XRequestID *string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetInfoParams contains all the parameters to send to the API endpoint for the get info operation typically these are written to a http.Request
func NewGetInfoParams ¶
func NewGetInfoParams() *GetInfoParams
NewGetInfoParams creates a new GetInfoParams object with the default values initialized.
func NewGetInfoParamsWithContext ¶
func NewGetInfoParamsWithContext(ctx context.Context) *GetInfoParams
NewGetInfoParamsWithContext creates a new GetInfoParams object with the default values initialized, and the ability to set a context for a request
func NewGetInfoParamsWithHTTPClient ¶
func NewGetInfoParamsWithHTTPClient(client *http.Client) *GetInfoParams
NewGetInfoParamsWithHTTPClient creates a new GetInfoParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetInfoParamsWithTimeout ¶
func NewGetInfoParamsWithTimeout(timeout time.Duration) *GetInfoParams
NewGetInfoParamsWithTimeout creates a new GetInfoParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetInfoParams) SetContext ¶
func (o *GetInfoParams) SetContext(ctx context.Context)
SetContext adds the context to the get info params
func (*GetInfoParams) SetHTTPClient ¶
func (o *GetInfoParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get info params
func (*GetInfoParams) SetTimeout ¶
func (o *GetInfoParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get info params
func (*GetInfoParams) SetXGiantSwarmActivity ¶
func (o *GetInfoParams) SetXGiantSwarmActivity(xGiantSwarmActivity *string)
SetXGiantSwarmActivity adds the xGiantSwarmActivity to the get info params
func (*GetInfoParams) SetXGiantSwarmCmdLine ¶
func (o *GetInfoParams) SetXGiantSwarmCmdLine(xGiantSwarmCmdLine *string)
SetXGiantSwarmCmdLine adds the xGiantSwarmCmdLine to the get info params
func (*GetInfoParams) SetXRequestID ¶
func (o *GetInfoParams) SetXRequestID(xRequestID *string)
SetXRequestID adds the xRequestId to the get info params
func (*GetInfoParams) WithContext ¶
func (o *GetInfoParams) WithContext(ctx context.Context) *GetInfoParams
WithContext adds the context to the get info params
func (*GetInfoParams) WithHTTPClient ¶
func (o *GetInfoParams) WithHTTPClient(client *http.Client) *GetInfoParams
WithHTTPClient adds the HTTPClient to the get info params
func (*GetInfoParams) WithTimeout ¶
func (o *GetInfoParams) WithTimeout(timeout time.Duration) *GetInfoParams
WithTimeout adds the timeout to the get info params
func (*GetInfoParams) WithXGiantSwarmActivity ¶
func (o *GetInfoParams) WithXGiantSwarmActivity(xGiantSwarmActivity *string) *GetInfoParams
WithXGiantSwarmActivity adds the xGiantSwarmActivity to the get info params
func (*GetInfoParams) WithXGiantSwarmCmdLine ¶
func (o *GetInfoParams) WithXGiantSwarmCmdLine(xGiantSwarmCmdLine *string) *GetInfoParams
WithXGiantSwarmCmdLine adds the xGiantSwarmCmdLine to the get info params
func (*GetInfoParams) WithXRequestID ¶
func (o *GetInfoParams) WithXRequestID(xRequestID *string) *GetInfoParams
WithXRequestID adds the xRequestID to the get info params
func (*GetInfoParams) WriteToRequest ¶
func (o *GetInfoParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetInfoReader ¶
type GetInfoReader struct {
// contains filtered or unexported fields
}
GetInfoReader is a Reader for the GetInfo structure.
func (*GetInfoReader) ReadResponse ¶
func (o *GetInfoReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetInfoUnauthorized ¶
type GetInfoUnauthorized struct {
}
GetInfoUnauthorized handles this case with default header values.
Permission denied
func NewGetInfoUnauthorized ¶
func NewGetInfoUnauthorized() *GetInfoUnauthorized
NewGetInfoUnauthorized creates a GetInfoUnauthorized with default headers values
func (*GetInfoUnauthorized) Error ¶
func (o *GetInfoUnauthorized) Error() string
Source Files