public_type

package
v0.68.0 Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2024 License: MIT Imports: 16 Imported by: 0

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 public type API

func (*Client) GetType deprecated

Deprecated: 2022-08-10 - Use GetTypeShort instead.

GetType get types Get available types paginated

func (*Client) GetTypeShort

func (a *Client) GetTypeShort(params *GetTypeParams, authInfo runtime.ClientAuthInfoWriter) (*GetTypeOK, error)

GetTypeShort get types Get available types paginated

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	GetType(params *GetTypeParams, authInfo runtime.ClientAuthInfoWriter) (*GetTypeOK, *GetTypeBadRequest, *GetTypeUnauthorized, *GetTypeInternalServerError, error)
	GetTypeShort(params *GetTypeParams, authInfo runtime.ClientAuthInfoWriter) (*GetTypeOK, 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 public type API client.

type GetTypeBadRequest added in v0.60.0

type GetTypeBadRequest struct {
	Payload *ugcclientmodels.ResponseError
}

GetTypeBadRequest handles this case with default header values.

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>771801</td><td>invalid paging parameter</td></tr></table>

func NewGetTypeBadRequest added in v0.60.0

func NewGetTypeBadRequest() *GetTypeBadRequest

NewGetTypeBadRequest creates a GetTypeBadRequest with default headers values

func (*GetTypeBadRequest) Error added in v0.60.0

func (o *GetTypeBadRequest) Error() string

func (*GetTypeBadRequest) GetPayload added in v0.60.0

func (*GetTypeBadRequest) ToJSONString added in v0.60.0

func (o *GetTypeBadRequest) ToJSONString() string

type GetTypeInternalServerError

type GetTypeInternalServerError struct {
	Payload *ugcclientmodels.ResponseError
}

GetTypeInternalServerError handles this case with default header values.

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>771802</td><td>Unable get types</td></tr></table>

func NewGetTypeInternalServerError

func NewGetTypeInternalServerError() *GetTypeInternalServerError

NewGetTypeInternalServerError creates a GetTypeInternalServerError with default headers values

func (*GetTypeInternalServerError) Error

func (*GetTypeInternalServerError) GetPayload

func (*GetTypeInternalServerError) ToJSONString added in v0.25.0

func (o *GetTypeInternalServerError) ToJSONString() string

type GetTypeOK

type GetTypeOK struct {
	Payload *ugcclientmodels.ModelsPaginatedGetTypeResponse
}

GetTypeOK handles this case with default header values.

Get types

func NewGetTypeOK

func NewGetTypeOK() *GetTypeOK

NewGetTypeOK creates a GetTypeOK with default headers values

func (*GetTypeOK) Error

func (o *GetTypeOK) Error() string

func (*GetTypeOK) GetPayload

func (*GetTypeOK) ToJSONString added in v0.25.0

func (o *GetTypeOK) ToJSONString() string

type GetTypeParams

type GetTypeParams struct {

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

	*/
	Namespace string
	/*Limit
	  number of content per page

	*/
	Limit *int64
	/*Offset
	  the offset number to retrieve

	*/
	Offset *int64

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

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

GetTypeParams contains all the parameters to send to the API endpoint for the get type operation typically these are written to a http.Request

func NewGetTypeParams

func NewGetTypeParams() *GetTypeParams

NewGetTypeParams creates a new GetTypeParams object with the default values initialized.

func NewGetTypeParamsWithContext

func NewGetTypeParamsWithContext(ctx context.Context) *GetTypeParams

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

func NewGetTypeParamsWithHTTPClient

func NewGetTypeParamsWithHTTPClient(client *http.Client) *GetTypeParams

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

func NewGetTypeParamsWithTimeout

func NewGetTypeParamsWithTimeout(timeout time.Duration) *GetTypeParams

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

func (*GetTypeParams) SetAuthInfoWriter added in v0.17.0

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

SetAuthInfoWriter adds the authInfoWriter to the get type params

func (*GetTypeParams) SetContext

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

SetContext adds the context to the get type params

func (*GetTypeParams) SetFlightId added in v0.63.0

func (o *GetTypeParams) SetFlightId(flightId string)

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

func (*GetTypeParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get type params

func (*GetTypeParams) SetHTTPClientTransport added in v0.19.0

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

SetHTTPClient adds the HTTPClient Transport to the get type params

func (*GetTypeParams) SetLimit

func (o *GetTypeParams) SetLimit(limit *int64)

SetLimit adds the limit to the get type params

func (*GetTypeParams) SetNamespace

func (o *GetTypeParams) SetNamespace(namespace string)

SetNamespace adds the namespace to the get type params

func (*GetTypeParams) SetOffset

func (o *GetTypeParams) SetOffset(offset *int64)

SetOffset adds the offset to the get type params

func (*GetTypeParams) SetTimeout

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

SetTimeout adds the timeout to the get type params

func (*GetTypeParams) WithContext

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

WithContext adds the context to the get type params

func (*GetTypeParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get type params

func (*GetTypeParams) WithLimit

func (o *GetTypeParams) WithLimit(limit *int64) *GetTypeParams

WithLimit adds the limit to the get type params

func (*GetTypeParams) WithNamespace

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

WithNamespace adds the namespace to the get type params

func (*GetTypeParams) WithOffset

func (o *GetTypeParams) WithOffset(offset *int64) *GetTypeParams

WithOffset adds the offset to the get type params

func (*GetTypeParams) WithTimeout

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

WithTimeout adds the timeout to the get type params

func (*GetTypeParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetTypeReader

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

GetTypeReader is a Reader for the GetType structure.

func (*GetTypeReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetTypeUnauthorized

type GetTypeUnauthorized struct {
	Payload *ugcclientmodels.ResponseError
}

GetTypeUnauthorized handles this case with default header values.

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20001</td><td>unauthorized access</td></tr></table>

func NewGetTypeUnauthorized

func NewGetTypeUnauthorized() *GetTypeUnauthorized

NewGetTypeUnauthorized creates a GetTypeUnauthorized with default headers values

func (*GetTypeUnauthorized) Error

func (o *GetTypeUnauthorized) Error() string

func (*GetTypeUnauthorized) GetPayload

func (*GetTypeUnauthorized) ToJSONString added in v0.25.0

func (o *GetTypeUnauthorized) ToJSONString() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL