a_m_s_qo_s

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Jan 3, 2025 License: MIT Imports: 15 Imported by: 1

Documentation

Index

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 a m s qo s API

func (*Client) QoSRegionsGetShort 

func (a *Client) QoSRegionsGetShort(params *QoSRegionsGetParams, authInfo runtime.ClientAuthInfoWriter) (*QoSRegionsGetResponse, error)

QoSRegionsGetShort get a list of available ams qos regions ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [READ]

This endpoint lists all QoS services available in all regions.

This endpoint is intended to be called by game client to find out all available regions. After getting a list of QoS on each region, game client is expected to ping each one with UDP connection as described below:

1. Make UDP connection to each QoS's IP:Port 2. Send string "PING" after connection established 3. Wait for string "PONG" response 4. Note the request-response latency for each QoS in each region

The game then can use ping latency information to either: 1. Inform the player on these latencies and let player choose preferred region 2. Send the latency list to Matchmaking Service so that player can be matched with other players in nearby regions

func (*Client) QoSRegionsUpdateShort 

func (a *Client) QoSRegionsUpdateShort(params *QoSRegionsUpdateParams, authInfo runtime.ClientAuthInfoWriter) (*QoSRegionsUpdateResponse, error)

QoSRegionsUpdateShort update the status of a qos region ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE]

This endpoint updates the registered QoS service's configurable configuration.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientService 

type ClientService interface {
	QoSRegionsGetShort(params *QoSRegionsGetParams, authInfo runtime.ClientAuthInfoWriter) (*QoSRegionsGetResponse, error)
	QoSRegionsUpdateShort(params *QoSRegionsUpdateParams, authInfo runtime.ClientAuthInfoWriter) (*QoSRegionsUpdateResponse, 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 a m s qo s API client.

type QoSRegionsGetBadRequest 

type QoSRegionsGetBadRequest struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsGetBadRequest handles this case with default header values. 

bad request

func NewQoSRegionsGetBadRequest 

func NewQoSRegionsGetBadRequest() *QoSRegionsGetBadRequest

NewQoSRegionsGetBadRequest creates a QoSRegionsGetBadRequest with default headers values

func (*QoSRegionsGetBadRequest) Error 

func (o *QoSRegionsGetBadRequest) Error() string

func (*QoSRegionsGetBadRequest) GetPayload 

func (o *QoSRegionsGetBadRequest) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsGetBadRequest) ToJSONString 

func (o *QoSRegionsGetBadRequest) ToJSONString() string

type QoSRegionsGetForbidden 

type QoSRegionsGetForbidden struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsGetForbidden handles this case with default header values. 

insufficient permissions

func NewQoSRegionsGetForbidden 

func NewQoSRegionsGetForbidden() *QoSRegionsGetForbidden

NewQoSRegionsGetForbidden creates a QoSRegionsGetForbidden with default headers values

func (*QoSRegionsGetForbidden) Error 

func (o *QoSRegionsGetForbidden) Error() string

func (*QoSRegionsGetForbidden) GetPayload 

func (o *QoSRegionsGetForbidden) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsGetForbidden) ToJSONString 

func (o *QoSRegionsGetForbidden) ToJSONString() string

type QoSRegionsGetInternalServerError 

type QoSRegionsGetInternalServerError struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsGetInternalServerError handles this case with default header values. 

internal server error

func NewQoSRegionsGetInternalServerError 

func NewQoSRegionsGetInternalServerError() *QoSRegionsGetInternalServerError

NewQoSRegionsGetInternalServerError creates a QoSRegionsGetInternalServerError with default headers values

func (*QoSRegionsGetInternalServerError) Error 

func (o *QoSRegionsGetInternalServerError) Error() string

func (*QoSRegionsGetInternalServerError) GetPayload 

func (o *QoSRegionsGetInternalServerError) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsGetInternalServerError) ToJSONString 

func (o *QoSRegionsGetInternalServerError) ToJSONString() string

type QoSRegionsGetOK 

type QoSRegionsGetOK struct {
	Payload *amsclientmodels.APIQoSEndpointResponse
}

QoSRegionsGetOK handles this case with default header values. 

success

func NewQoSRegionsGetOK 

func NewQoSRegionsGetOK() *QoSRegionsGetOK

NewQoSRegionsGetOK creates a QoSRegionsGetOK with default headers values

func (*QoSRegionsGetOK) Error 

func (o *QoSRegionsGetOK) Error() string

func (*QoSRegionsGetOK) GetPayload 

func (o *QoSRegionsGetOK) GetPayload() *amsclientmodels.APIQoSEndpointResponse

func (*QoSRegionsGetOK) ToJSONString 

func (o *QoSRegionsGetOK) ToJSONString() string

type QoSRegionsGetParams 

type QoSRegionsGetParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Namespace
	  namespace of the game

	*/
	Namespace string
	/*Status
	  QoS status, available value: ACTIVE, INACTIVE

	*/
	Status *string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

QoSRegionsGetParams contains all the parameters to send to the API endpoint for the qo s regions get operation typically these are written to a http.Request

func NewQoSRegionsGetParams 

func NewQoSRegionsGetParams() *QoSRegionsGetParams

NewQoSRegionsGetParams creates a new QoSRegionsGetParams object with the default values initialized.

func NewQoSRegionsGetParamsWithContext 

func NewQoSRegionsGetParamsWithContext(ctx context.Context) *QoSRegionsGetParams

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

func NewQoSRegionsGetParamsWithHTTPClient 

func NewQoSRegionsGetParamsWithHTTPClient(client *http.Client) *QoSRegionsGetParams

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

func NewQoSRegionsGetParamsWithTimeout 

func NewQoSRegionsGetParamsWithTimeout(timeout time.Duration) *QoSRegionsGetParams

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

func (*QoSRegionsGetParams) SetAuthInfoWriter 

func (o *QoSRegionsGetParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the qo s regions get params

func (*QoSRegionsGetParams) SetContext 

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

SetContext adds the context to the qo s regions get params

func (*QoSRegionsGetParams) SetFlightId 

func (o *QoSRegionsGetParams) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*QoSRegionsGetParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the qo s regions get params

func (*QoSRegionsGetParams) SetHTTPClientTransport 

func (o *QoSRegionsGetParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the qo s regions get params

func (*QoSRegionsGetParams) SetNamespace 

func (o *QoSRegionsGetParams) SetNamespace(namespace string)

SetNamespace adds the namespace to the qo s regions get params

func (*QoSRegionsGetParams) SetStatus 

func (o *QoSRegionsGetParams) SetStatus(status *string)

SetStatus adds the status to the qo s regions get params

func (*QoSRegionsGetParams) SetTimeout 

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

SetTimeout adds the timeout to the qo s regions get params

func (*QoSRegionsGetParams) WithContext 

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

WithContext adds the context to the qo s regions get params

func (*QoSRegionsGetParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the qo s regions get params

func (*QoSRegionsGetParams) WithNamespace 

func (o *QoSRegionsGetParams) WithNamespace(namespace string) *QoSRegionsGetParams

WithNamespace adds the namespace to the qo s regions get params

func (*QoSRegionsGetParams) WithStatus 

func (o *QoSRegionsGetParams) WithStatus(status *string) *QoSRegionsGetParams

WithStatus adds the status to the qo s regions get params

func (*QoSRegionsGetParams) WithTimeout 

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

WithTimeout adds the timeout to the qo s regions get params

func (*QoSRegionsGetParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type QoSRegionsGetReader 

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

QoSRegionsGetReader is a Reader for the QoSRegionsGet structure.

func (*QoSRegionsGetReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type QoSRegionsGetResponse 

type QoSRegionsGetResponse struct {
	amsclientmodels.ApiResponse
	Data *amsclientmodels.APIQoSEndpointResponse

	Error400 *amsclientmodels.ResponseErrorResponse
	Error401 *amsclientmodels.ResponseErrorResponse
	Error403 *amsclientmodels.ResponseErrorResponse
	Error500 *amsclientmodels.ResponseErrorResponse
}

func (*QoSRegionsGetResponse) Unpack 

func (m *QoSRegionsGetResponse) Unpack() (*amsclientmodels.APIQoSEndpointResponse, *amsclientmodels.ApiError)

type QoSRegionsGetUnauthorized 

type QoSRegionsGetUnauthorized struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsGetUnauthorized handles this case with default header values. 

no authorization provided

func NewQoSRegionsGetUnauthorized 

func NewQoSRegionsGetUnauthorized() *QoSRegionsGetUnauthorized

NewQoSRegionsGetUnauthorized creates a QoSRegionsGetUnauthorized with default headers values

func (*QoSRegionsGetUnauthorized) Error 

func (o *QoSRegionsGetUnauthorized) Error() string

func (*QoSRegionsGetUnauthorized) GetPayload 

func (o *QoSRegionsGetUnauthorized) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsGetUnauthorized) ToJSONString 

func (o *QoSRegionsGetUnauthorized) ToJSONString() string

type QoSRegionsUpdateBadRequest 

type QoSRegionsUpdateBadRequest struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsUpdateBadRequest handles this case with default header values. 

malformed request

func NewQoSRegionsUpdateBadRequest 

func NewQoSRegionsUpdateBadRequest() *QoSRegionsUpdateBadRequest

NewQoSRegionsUpdateBadRequest creates a QoSRegionsUpdateBadRequest with default headers values

func (*QoSRegionsUpdateBadRequest) Error 

func (o *QoSRegionsUpdateBadRequest) Error() string

func (*QoSRegionsUpdateBadRequest) GetPayload 

func (o *QoSRegionsUpdateBadRequest) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsUpdateBadRequest) ToJSONString 

func (o *QoSRegionsUpdateBadRequest) ToJSONString() string

type QoSRegionsUpdateForbidden 

type QoSRegionsUpdateForbidden struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsUpdateForbidden handles this case with default header values. 

insufficient permissions

func NewQoSRegionsUpdateForbidden 

func NewQoSRegionsUpdateForbidden() *QoSRegionsUpdateForbidden

NewQoSRegionsUpdateForbidden creates a QoSRegionsUpdateForbidden with default headers values

func (*QoSRegionsUpdateForbidden) Error 

func (o *QoSRegionsUpdateForbidden) Error() string

func (*QoSRegionsUpdateForbidden) GetPayload 

func (o *QoSRegionsUpdateForbidden) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsUpdateForbidden) ToJSONString 

func (o *QoSRegionsUpdateForbidden) ToJSONString() string

type QoSRegionsUpdateInternalServerError 

type QoSRegionsUpdateInternalServerError struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsUpdateInternalServerError handles this case with default header values. 

Internal Server Error

func NewQoSRegionsUpdateInternalServerError 

func NewQoSRegionsUpdateInternalServerError() *QoSRegionsUpdateInternalServerError

NewQoSRegionsUpdateInternalServerError creates a QoSRegionsUpdateInternalServerError with default headers values

func (*QoSRegionsUpdateInternalServerError) Error 

func (o *QoSRegionsUpdateInternalServerError) Error() string

func (*QoSRegionsUpdateInternalServerError) GetPayload 

func (o *QoSRegionsUpdateInternalServerError) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsUpdateInternalServerError) ToJSONString 

func (o *QoSRegionsUpdateInternalServerError) ToJSONString() string

type QoSRegionsUpdateNoContent 

type QoSRegionsUpdateNoContent struct {
}

QoSRegionsUpdateNoContent handles this case with default header values. 

record updated

func NewQoSRegionsUpdateNoContent 

func NewQoSRegionsUpdateNoContent() *QoSRegionsUpdateNoContent

NewQoSRegionsUpdateNoContent creates a QoSRegionsUpdateNoContent with default headers values

func (*QoSRegionsUpdateNoContent) Error 

func (o *QoSRegionsUpdateNoContent) Error() string

type QoSRegionsUpdateNotFound 

type QoSRegionsUpdateNotFound struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsUpdateNotFound handles this case with default header values. 

regionial QoS record not found

func NewQoSRegionsUpdateNotFound 

func NewQoSRegionsUpdateNotFound() *QoSRegionsUpdateNotFound

NewQoSRegionsUpdateNotFound creates a QoSRegionsUpdateNotFound with default headers values

func (*QoSRegionsUpdateNotFound) Error 

func (o *QoSRegionsUpdateNotFound) Error() string

func (*QoSRegionsUpdateNotFound) GetPayload 

func (o *QoSRegionsUpdateNotFound) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsUpdateNotFound) ToJSONString 

func (o *QoSRegionsUpdateNotFound) ToJSONString() string

type QoSRegionsUpdateParams 

type QoSRegionsUpdateParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Body*/
	Body *amsclientmodels.APIUpdateServerRequest
	/*Namespace
	  namespace of the game

	*/
	Namespace string
	/*Region
	  region of the QoS

	*/
	Region string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

QoSRegionsUpdateParams contains all the parameters to send to the API endpoint for the qo s regions update operation typically these are written to a http.Request

func NewQoSRegionsUpdateParams 

func NewQoSRegionsUpdateParams() *QoSRegionsUpdateParams

NewQoSRegionsUpdateParams creates a new QoSRegionsUpdateParams object with the default values initialized.

func NewQoSRegionsUpdateParamsWithContext 

func NewQoSRegionsUpdateParamsWithContext(ctx context.Context) *QoSRegionsUpdateParams

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

func NewQoSRegionsUpdateParamsWithHTTPClient 

func NewQoSRegionsUpdateParamsWithHTTPClient(client *http.Client) *QoSRegionsUpdateParams

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

func NewQoSRegionsUpdateParamsWithTimeout 

func NewQoSRegionsUpdateParamsWithTimeout(timeout time.Duration) *QoSRegionsUpdateParams

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

func (*QoSRegionsUpdateParams) SetAuthInfoWriter 

func (o *QoSRegionsUpdateParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the qo s regions update params

func (*QoSRegionsUpdateParams) SetBody 

func (o *QoSRegionsUpdateParams) SetBody(body *amsclientmodels.APIUpdateServerRequest)

SetBody adds the body to the qo s regions update params

func (*QoSRegionsUpdateParams) SetContext 

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

SetContext adds the context to the qo s regions update params

func (*QoSRegionsUpdateParams) SetFlightId 

func (o *QoSRegionsUpdateParams) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*QoSRegionsUpdateParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the qo s regions update params

func (*QoSRegionsUpdateParams) SetHTTPClientTransport 

func (o *QoSRegionsUpdateParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the qo s regions update params

func (*QoSRegionsUpdateParams) SetNamespace 

func (o *QoSRegionsUpdateParams) SetNamespace(namespace string)

SetNamespace adds the namespace to the qo s regions update params

func (*QoSRegionsUpdateParams) SetRegion 

func (o *QoSRegionsUpdateParams) SetRegion(region string)

SetRegion adds the region to the qo s regions update params

func (*QoSRegionsUpdateParams) SetTimeout 

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

SetTimeout adds the timeout to the qo s regions update params

func (*QoSRegionsUpdateParams) WithBody 

func (o *QoSRegionsUpdateParams) WithBody(body *amsclientmodels.APIUpdateServerRequest) *QoSRegionsUpdateParams

WithBody adds the body to the qo s regions update params

func (*QoSRegionsUpdateParams) WithContext 

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

WithContext adds the context to the qo s regions update params

func (*QoSRegionsUpdateParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the qo s regions update params

func (*QoSRegionsUpdateParams) WithNamespace 

func (o *QoSRegionsUpdateParams) WithNamespace(namespace string) *QoSRegionsUpdateParams

WithNamespace adds the namespace to the qo s regions update params

func (*QoSRegionsUpdateParams) WithRegion 

func (o *QoSRegionsUpdateParams) WithRegion(region string) *QoSRegionsUpdateParams

WithRegion adds the region to the qo s regions update params

func (*QoSRegionsUpdateParams) WithTimeout 

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

WithTimeout adds the timeout to the qo s regions update params

func (*QoSRegionsUpdateParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type QoSRegionsUpdateReader 

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

QoSRegionsUpdateReader is a Reader for the QoSRegionsUpdate structure.

func (*QoSRegionsUpdateReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type QoSRegionsUpdateResponse 

type QoSRegionsUpdateResponse struct {
	amsclientmodels.ApiResponse

	Error400 *amsclientmodels.ResponseErrorResponse
	Error401 *amsclientmodels.ResponseErrorResponse
	Error403 *amsclientmodels.ResponseErrorResponse
	Error404 *amsclientmodels.ResponseErrorResponse
	Error500 *amsclientmodels.ResponseErrorResponse
}

func (*QoSRegionsUpdateResponse) Unpack 

func (m *QoSRegionsUpdateResponse) Unpack() *amsclientmodels.ApiError

type QoSRegionsUpdateUnauthorized 

type QoSRegionsUpdateUnauthorized struct {
	Payload *amsclientmodels.ResponseErrorResponse
}

QoSRegionsUpdateUnauthorized handles this case with default header values. 

no authorization provided

func NewQoSRegionsUpdateUnauthorized 

func NewQoSRegionsUpdateUnauthorized() *QoSRegionsUpdateUnauthorized

NewQoSRegionsUpdateUnauthorized creates a QoSRegionsUpdateUnauthorized with default headers values

func (*QoSRegionsUpdateUnauthorized) Error 

func (o *QoSRegionsUpdateUnauthorized) Error() string

func (*QoSRegionsUpdateUnauthorized) GetPayload 

func (o *QoSRegionsUpdateUnauthorized) GetPayload() *amsclientmodels.ResponseErrorResponse

func (*QoSRegionsUpdateUnauthorized) ToJSONString 

func (o *QoSRegionsUpdateUnauthorized) ToJSONString() string

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.