incursions

package
v0.5.25 Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2022 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// GetIncursionsOKBodyItems0StateWithdrawing captures enum value "withdrawing"
	GetIncursionsOKBodyItems0StateWithdrawing string = "withdrawing"

	// GetIncursionsOKBodyItems0StateMobilizing captures enum value "mobilizing"
	GetIncursionsOKBodyItems0StateMobilizing string = "mobilizing"

	// GetIncursionsOKBodyItems0StateEstablished captures enum value "established"
	GetIncursionsOKBodyItems0StateEstablished string = "established"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for incursions API

func (*Client) GetIncursions 

func (a *Client) GetIncursions(params *GetIncursionsParams, opts ...ClientOption) (*GetIncursionsOK, error)
GetIncursions lists incursions

Return a list of current incursions

---

This route is cached for up to 300 seconds

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientOption added in v0.4.0 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	GetIncursions(params *GetIncursionsParams, opts ...ClientOption) (*GetIncursionsOK, 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 incursions API client.

type GetIncursionsBadRequest 

type GetIncursionsBadRequest struct {
	Payload *models.BadRequest
}
GetIncursionsBadRequest describes a response with status code 400, with default header values.

Bad request

func NewGetIncursionsBadRequest 

func NewGetIncursionsBadRequest() *GetIncursionsBadRequest

NewGetIncursionsBadRequest creates a GetIncursionsBadRequest with default headers values

func (*GetIncursionsBadRequest) Error 

func (o *GetIncursionsBadRequest) Error() string

func (*GetIncursionsBadRequest) GetPayload 

func (o *GetIncursionsBadRequest) GetPayload() *models.BadRequest

type GetIncursionsEnhanceYourCalm 

type GetIncursionsEnhanceYourCalm struct {
	Payload *models.ErrorLimited
}
GetIncursionsEnhanceYourCalm describes a response with status code 420, with default header values.

Error limited

func NewGetIncursionsEnhanceYourCalm 

func NewGetIncursionsEnhanceYourCalm() *GetIncursionsEnhanceYourCalm

NewGetIncursionsEnhanceYourCalm creates a GetIncursionsEnhanceYourCalm with default headers values

func (*GetIncursionsEnhanceYourCalm) Error 

func (o *GetIncursionsEnhanceYourCalm) Error() string

func (*GetIncursionsEnhanceYourCalm) GetPayload 

func (o *GetIncursionsEnhanceYourCalm) GetPayload() *models.ErrorLimited

type GetIncursionsGatewayTimeout 

type GetIncursionsGatewayTimeout struct {
	Payload *models.GatewayTimeout
}
GetIncursionsGatewayTimeout describes a response with status code 504, with default header values.

Gateway timeout

func NewGetIncursionsGatewayTimeout 

func NewGetIncursionsGatewayTimeout() *GetIncursionsGatewayTimeout

NewGetIncursionsGatewayTimeout creates a GetIncursionsGatewayTimeout with default headers values

func (*GetIncursionsGatewayTimeout) Error 

func (o *GetIncursionsGatewayTimeout) Error() string

func (*GetIncursionsGatewayTimeout) GetPayload 

func (o *GetIncursionsGatewayTimeout) GetPayload() *models.GatewayTimeout

type GetIncursionsInternalServerError 

type GetIncursionsInternalServerError struct {
	Payload *models.InternalServerError
}
GetIncursionsInternalServerError describes a response with status code 500, with default header values.

Internal server error

func NewGetIncursionsInternalServerError 

func NewGetIncursionsInternalServerError() *GetIncursionsInternalServerError

NewGetIncursionsInternalServerError creates a GetIncursionsInternalServerError with default headers values

func (*GetIncursionsInternalServerError) Error 

func (o *GetIncursionsInternalServerError) Error() string

func (*GetIncursionsInternalServerError) GetPayload 

func (o *GetIncursionsInternalServerError) GetPayload() *models.InternalServerError

type GetIncursionsNotModified 

type GetIncursionsNotModified struct {

	/* The caching mechanism used
	 */
	CacheControl string

	/* RFC7232 compliant entity tag
	 */
	ETag string

	/* RFC7231 formatted datetime string
	 */
	Expires string

	/* RFC7231 formatted datetime string
	 */
	LastModified string
}
GetIncursionsNotModified describes a response with status code 304, with default header values.

Not modified

func NewGetIncursionsNotModified 

func NewGetIncursionsNotModified() *GetIncursionsNotModified

NewGetIncursionsNotModified creates a GetIncursionsNotModified with default headers values

func (*GetIncursionsNotModified) Error 

func (o *GetIncursionsNotModified) Error() string

type GetIncursionsOK 

type GetIncursionsOK struct {

	/* The caching mechanism used
	 */
	CacheControl string

	/* RFC7232 compliant entity tag
	 */
	ETag string

	/* RFC7231 formatted datetime string
	 */
	Expires string

	/* RFC7231 formatted datetime string
	 */
	LastModified string

	Payload []*GetIncursionsOKBodyItems0
}
GetIncursionsOK describes a response with status code 200, with default header values.

A list of incursions

func NewGetIncursionsOK 

func NewGetIncursionsOK() *GetIncursionsOK

NewGetIncursionsOK creates a GetIncursionsOK with default headers values

func (*GetIncursionsOK) Error 

func (o *GetIncursionsOK) Error() string

func (*GetIncursionsOK) GetPayload 

func (o *GetIncursionsOK) GetPayload() []*GetIncursionsOKBodyItems0

type GetIncursionsOKBodyItems0 

type GetIncursionsOKBodyItems0 struct {

	// get_incursions_constellation_id
	//
	// The constellation id in which this incursion takes place
	// Required: true
	ConstellationID *int32 `json:"constellation_id"`

	// get_incursions_faction_id
	//
	// The attacking faction's id
	// Required: true
	FactionID *int32 `json:"faction_id"`

	// get_incursions_has_boss
	//
	// Whether the final encounter has boss or not
	// Required: true
	HasBoss *bool `json:"has_boss"`

	// get_incursions_infested_solar_systems
	//
	// A list of infested solar system ids that are a part of this incursion
	// Required: true
	// Max Items: 100
	InfestedSolarSystems []int32 `json:"infested_solar_systems"`

	// get_incursions_influence
	//
	// Influence of this incursion as a float from 0 to 1
	// Required: true
	Influence *float32 `json:"influence"`

	// get_incursions_staging_solar_system_id
	//
	// Staging solar system for this incursion
	// Required: true
	StagingSolarSystemID *int32 `json:"staging_solar_system_id"`

	// get_incursions_state
	//
	// The state of this incursion
	// Required: true
	// Enum: [withdrawing mobilizing established]
	State *string `json:"state"`

	// get_incursions_type
	//
	// The type of this incursion
	// Required: true
	Type *string `json:"type"`
}

GetIncursionsOKBodyItems0 get_incursions_200_ok // // 200 ok object swagger:model GetIncursionsOKBodyItems0

func (*GetIncursionsOKBodyItems0) ContextValidate added in v0.3.0 

func (o *GetIncursionsOKBodyItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get incursions o k body items0 based on context it is used

func (*GetIncursionsOKBodyItems0) MarshalBinary 

func (o *GetIncursionsOKBodyItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetIncursionsOKBodyItems0) UnmarshalBinary 

func (o *GetIncursionsOKBodyItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetIncursionsOKBodyItems0) Validate 

func (o *GetIncursionsOKBodyItems0) Validate(formats strfmt.Registry) error

Validate validates this get incursions o k body items0

type GetIncursionsParams 

type GetIncursionsParams struct {

	/* IfNoneMatch.

	   ETag from a previous request. A 304 will be returned if this matches the current ETag
	*/
	IfNoneMatch *string

	/* Datasource.

	   The server name you would like data from

	   Default: "tranquility"
	*/
	Datasource *string

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

GetIncursionsParams contains all the parameters to send to the API endpoint 

for the get incursions operation.

Typically these are written to a http.Request.

func NewGetIncursionsParams 

func NewGetIncursionsParams() *GetIncursionsParams

NewGetIncursionsParams creates a new GetIncursionsParams 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 NewGetIncursionsParamsWithContext 

func NewGetIncursionsParamsWithContext(ctx context.Context) *GetIncursionsParams

NewGetIncursionsParamsWithContext creates a new GetIncursionsParams object with the ability to set a context for a request.

func NewGetIncursionsParamsWithHTTPClient 

func NewGetIncursionsParamsWithHTTPClient(client *http.Client) *GetIncursionsParams

NewGetIncursionsParamsWithHTTPClient creates a new GetIncursionsParams object with the ability to set a custom HTTPClient for a request.

func NewGetIncursionsParamsWithTimeout 

func NewGetIncursionsParamsWithTimeout(timeout time.Duration) *GetIncursionsParams

NewGetIncursionsParamsWithTimeout creates a new GetIncursionsParams object with the ability to set a timeout on a request.

func (*GetIncursionsParams) SetContext 

func (o *GetIncursionsParams) SetContext(ctx context.Context)

SetContext adds the context to the get incursions params

func (*GetIncursionsParams) SetDatasource 

func (o *GetIncursionsParams) SetDatasource(datasource *string)

SetDatasource adds the datasource to the get incursions params

func (*GetIncursionsParams) SetDefaults added in v0.3.0 

func (o *GetIncursionsParams) SetDefaults()

SetDefaults hydrates default values in the get incursions params (not the query body).

All values with no default are reset to their zero value.

func (*GetIncursionsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get incursions params

func (*GetIncursionsParams) SetIfNoneMatch 

func (o *GetIncursionsParams) SetIfNoneMatch(ifNoneMatch *string)

SetIfNoneMatch adds the ifNoneMatch to the get incursions params

func (*GetIncursionsParams) SetTimeout 

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

SetTimeout adds the timeout to the get incursions params

func (*GetIncursionsParams) WithContext 

func (o *GetIncursionsParams) WithContext(ctx context.Context) *GetIncursionsParams

WithContext adds the context to the get incursions params

func (*GetIncursionsParams) WithDatasource 

func (o *GetIncursionsParams) WithDatasource(datasource *string) *GetIncursionsParams

WithDatasource adds the datasource to the get incursions params

func (*GetIncursionsParams) WithDefaults added in v0.3.0 

func (o *GetIncursionsParams) WithDefaults() *GetIncursionsParams

WithDefaults hydrates default values in the get incursions params (not the query body).

All values with no default are reset to their zero value.

func (*GetIncursionsParams) WithHTTPClient 

func (o *GetIncursionsParams) WithHTTPClient(client *http.Client) *GetIncursionsParams

WithHTTPClient adds the HTTPClient to the get incursions params

func (*GetIncursionsParams) WithIfNoneMatch 

func (o *GetIncursionsParams) WithIfNoneMatch(ifNoneMatch *string) *GetIncursionsParams

WithIfNoneMatch adds the ifNoneMatch to the get incursions params

func (*GetIncursionsParams) WithTimeout 

func (o *GetIncursionsParams) WithTimeout(timeout time.Duration) *GetIncursionsParams

WithTimeout adds the timeout to the get incursions params

func (*GetIncursionsParams) WriteToRequest 

func (o *GetIncursionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetIncursionsReader 

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

GetIncursionsReader is a Reader for the GetIncursions structure.

func (*GetIncursionsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetIncursionsServiceUnavailable 

type GetIncursionsServiceUnavailable struct {
	Payload *models.ServiceUnavailable
}
GetIncursionsServiceUnavailable describes a response with status code 503, with default header values.

Service unavailable

func NewGetIncursionsServiceUnavailable 

func NewGetIncursionsServiceUnavailable() *GetIncursionsServiceUnavailable

NewGetIncursionsServiceUnavailable creates a GetIncursionsServiceUnavailable with default headers values

func (*GetIncursionsServiceUnavailable) Error 

func (o *GetIncursionsServiceUnavailable) Error() string

func (*GetIncursionsServiceUnavailable) GetPayload 

func (o *GetIncursionsServiceUnavailable) GetPayload() *models.ServiceUnavailable

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.