swagger

package
v1.40.0 Latest Latest
Warning

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

 Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Overview

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

This code was autogenerated. Do not edit directly.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	SDKApi *SDKApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the alpha.proto API vversion not set In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AlphaBool 

type AlphaBool struct {
	Bool_ bool `json:"bool,omitempty"`
}

type AlphaCount 

type AlphaCount struct {
	Count string `json:"count,omitempty"`
}

Store a count variable.

type AlphaCounter added in v1.34.0 

type AlphaCounter struct {
	Name     string `json:"name,omitempty"`
	Count    string `json:"count,omitempty"`
	Capacity string `json:"capacity,omitempty"`
}

A representation of a Counter.

type AlphaCounterUpdateRequest added in v1.35.0 

type AlphaCounterUpdateRequest struct {
	Name      string `json:"name,omitempty"`
	Count     string `json:"count,omitempty"`
	Capacity  string `json:"capacity,omitempty"`
	CountDiff string `json:"countDiff,omitempty"`
}

A representation of a Counter Update Request.

type AlphaList added in v1.34.0 

type AlphaList struct {
	Name     string   `json:"name,omitempty"`
	Capacity string   `json:"capacity,omitempty"`
	Values   []string `json:"values,omitempty"`
}

A representation of a List.

type AlphaPlayerId 

type AlphaPlayerId struct {
	PlayerID string `json:"playerID,omitempty"`
}

The unique identifier for a given player.

type AlphaPlayerIdList 

type AlphaPlayerIdList struct {
	List []string `json:"list,omitempty"`
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type GenericSwaggerError 

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type ListsNameaddValueBody added in v1.37.0 

type ListsNameaddValueBody struct {
	Value string `json:"value"`
}

type ListsNameremoveValueBody added in v1.37.0 

type ListsNameremoveValueBody struct {
	Value string `json:"value"`
}

type SDKApiService 

type SDKApiService service

func (*SDKApiService) AddListValue added in v1.34.0 

func (a *SDKApiService) AddListValue(ctx context.Context, body ListsNameaddValueBody, name string) (AlphaList, *http.Response, error)

SDKApiService Adds a value to a List and returns updated List. Returns NOT_FOUND if the List does not exist. Returns ALREADY_EXISTS if the value is already in the List. Returns OUT_OF_RANGE if the List is already at Capacity.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param name The name of the List to add a value to.

@return AlphaList

func (*SDKApiService) GetConnectedPlayers 

func (a *SDKApiService) GetConnectedPlayers(ctx context.Context) (AlphaPlayerIdList, *http.Response, error)

SDKApiService Returns the list of the currently connected player ids. This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the GameServer status resource. If GameServer.Status.Players.IDs is set manually through the Kubernetes API, use SDK.GameServer() or SDK.WatchGameServer() instead to view this value.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AlphaPlayerIdList

func (*SDKApiService) GetCounter added in v1.34.0 

func (a *SDKApiService) GetCounter(ctx context.Context, name string) (AlphaCounter, *http.Response, error)

SDKApiService Gets a Counter. Returns NOT_FOUND if the Counter does not exist.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the Counter to get

@return AlphaCounter

func (*SDKApiService) GetList added in v1.34.0 

func (a *SDKApiService) GetList(ctx context.Context, name string) (AlphaList, *http.Response, error)

SDKApiService Gets a List. Returns NOT_FOUND if the List does not exist.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the List to get

@return AlphaList

func (*SDKApiService) GetPlayerCapacity 

func (a *SDKApiService) GetPlayerCapacity(ctx context.Context) (AlphaCount, *http.Response, error)

SDKApiService Retrieves the current player capacity. This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the GameServer status resource. If GameServer.Status.Players.Capacity is set manually through the Kubernetes API, use SDK.GameServer() or SDK.WatchGameServer() instead to view this value.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AlphaCount

func (*SDKApiService) GetPlayerCount 

func (a *SDKApiService) GetPlayerCount(ctx context.Context) (AlphaCount, *http.Response, error)

SDKApiService Retrieves the current player count. This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the GameServer status resource. If GameServer.Status.Players.Count is set manually through the Kubernetes API, use SDK.GameServer() or SDK.WatchGameServer() instead to view this value.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AlphaCount

func (*SDKApiService) IsPlayerConnected 

func (a *SDKApiService) IsPlayerConnected(ctx context.Context, playerID string) (AlphaBool, *http.Response, error)

SDKApiService Returns if the playerID is currently connected to the GameServer. This is always accurate from what has been set through this SDK, even if the value has yet to be updated on the GameServer status resource. If GameServer.Status.Players.IDs is set manually through the Kubernetes API, use SDK.GameServer() or SDK.WatchGameServer() instead to determine connected status.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param playerID

@return AlphaBool

func (*SDKApiService) PlayerConnect 

func (a *SDKApiService) PlayerConnect(ctx context.Context, body AlphaPlayerId) (AlphaBool, *http.Response, error)

SDKApiService PlayerConnect increases the SDK’s stored player count by one, and appends this playerID to GameServer.Status.Players.IDs. GameServer.Status.Players.Count and GameServer.Status.Players.IDs are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. PlayerConnect returns true and adds the playerID to the list of playerIDs if this playerID was not already in the list of connected playerIDs. If the playerID exists within the list of connected playerIDs, PlayerConnect will return false, and the list of connected playerIDs will be left unchanged. An error will be returned if the playerID was not already in the list of connected playerIDs but the player capacity for the server has been reached. The playerID will not be added to the list of playerIDs. Warning: Do not use this method if you are manually managing GameServer.Status.Players.IDs and GameServer.Status.Players.Count through the Kubernetes API, as indeterminate results will occur.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The unique identifier for a given player.

@return AlphaBool

func (*SDKApiService) PlayerDisconnect 

func (a *SDKApiService) PlayerDisconnect(ctx context.Context, body AlphaPlayerId) (AlphaBool, *http.Response, error)

SDKApiService Decreases the SDK’s stored player count by one, and removes the playerID from GameServer.Status.Players.IDs. GameServer.Status.Players.Count and GameServer.Status.Players.IDs are then set to update the player count and id list a second from now, unless there is already an update pending, in which case the update joins that batch operation. PlayerDisconnect will return true and remove the supplied playerID from the list of connected playerIDs if the playerID value exists within the list. If the playerID was not in the list of connected playerIDs, the call will return false, and the connected playerID list will be left unchanged. Warning: Do not use this method if you are manually managing GameServer.status.players.IDs and GameServer.status.players.Count through the Kubernetes API, as indeterminate results will occur.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The unique identifier for a given player.

@return AlphaBool

func (*SDKApiService) RemoveListValue added in v1.34.0 

func (a *SDKApiService) RemoveListValue(ctx context.Context, body ListsNameremoveValueBody, name string) (AlphaList, *http.Response, error)

SDKApiService Removes a value from a List and returns updated List. Returns NOT_FOUND if the List does not exist. Returns NOT_FOUND if the value is not in the List.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param name The name of the List to remove a value from.

@return AlphaList

func (*SDKApiService) SetPlayerCapacity 

func (a *SDKApiService) SetPlayerCapacity(ctx context.Context, body AlphaCount) (SdkalphaEmpty, *http.Response, error)

SDKApiService Update the GameServer.Status.Players.Capacity value with a new capacity.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Store a count variable.

@return SdkalphaEmpty

func (*SDKApiService) UpdateCounter added in v1.34.0 

func (a *SDKApiService) UpdateCounter(ctx context.Context, body TheRequestedUpdateToMakeToTheCounter, counterUpdateRequestName string) (AlphaCounter, *http.Response, error)

SDKApiService UpdateCounter returns the updated Counter. Returns NOT_FOUND if the Counter does not exist (name cannot be updated). Returns OUT_OF_RANGE if the Count is out of range [0,Capacity].

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The requested update to make to the Counter
  • @param counterUpdateRequestName The name of the Counter to update

@return AlphaCounter

func (*SDKApiService) UpdateList added in v1.34.0 

func (a *SDKApiService) UpdateList(ctx context.Context, body TheListToUpdate, listName string) (AlphaList, *http.Response, error)

SDKApiService UpdateList returns the updated List. Returns NOT_FOUND if the List does not exist (name cannot be updated). **THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES** Use AddListValue() or RemoveListValue() for modifying the List.Values field. Returns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the List. If a field mask path(s) is specified, but the value is not set in the request List object, then the default value for the variable will be set (i.e. 0 for \"capacity\", empty list for \"values\").

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The List to update
  • @param listName The name of the List

@return AlphaList

type SdkalphaEmpty added in v1.34.0 

type SdkalphaEmpty struct {
}

type TheListToUpdate added in v1.34.0 

type TheListToUpdate struct {
	Capacity string   `json:"capacity,omitempty"`
	Values   []string `json:"values,omitempty"`
}

type TheRequestedUpdateToMakeToTheCounter added in v1.35.0 

type TheRequestedUpdateToMakeToTheCounter struct {
	Count     string `json:"count,omitempty"`
	Capacity  string `json:"capacity,omitempty"`
	CountDiff string `json:"countDiff,omitempty"`
}

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.