Documentation ¶
Overview ¶
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
This code was autogenerated. Do not edit directly.
- sdk.proto *
- No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *
- API version: version not set
- Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type BasicAuth
- type Configuration
- type GameServerObjectMeta
- type GameServerSpec
- type GenericSwaggerError
- type GooglerpcStatus
- type SDKApiService
- func (a *SDKApiService) Allocate(ctx context.Context, body SdkEmpty) (SdkEmpty, *http.Response, error)
- func (a *SDKApiService) GetGameServer(ctx context.Context) (SdkGameServer, *http.Response, error)
- func (a *SDKApiService) Health(ctx context.Context, body SdkEmpty) (SdkEmpty, *http.Response, error)
- func (a *SDKApiService) Ready(ctx context.Context, body SdkEmpty) (SdkEmpty, *http.Response, error)
- func (a *SDKApiService) Reserve(ctx context.Context, body SdkDuration) (SdkEmpty, *http.Response, error)
- func (a *SDKApiService) SetAnnotation(ctx context.Context, body SdkKeyValue) (SdkEmpty, *http.Response, error)
- func (a *SDKApiService) SetLabel(ctx context.Context, body SdkKeyValue) (SdkEmpty, *http.Response, error)
- func (a *SDKApiService) Shutdown(ctx context.Context, body SdkEmpty) (SdkEmpty, *http.Response, error)
- func (a *SDKApiService) WatchGameServer(ctx context.Context) (StreamResultOfSdkGameServer, *http.Response, error)
- type SdkDuration
- type SdkEmpty
- type SdkGameServer
- type SdkGameServerStatus
- type SdkKeyValue
- type SpecHealth
- type StatusAddress
- type StatusCounterStatus
- type StatusListStatus
- type StatusPlayerStatus
- type StatusPort
- type StreamResultOfSdkGameServer
Constants ¶
This section is empty.
Variables ¶
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 ¶
Types ¶
type APIClient ¶
type APIClient struct { SDKApi *SDKApiService // contains filtered or unexported fields }
APIClient manages communication with the sdk.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 ¶
Change base path to allow switching to mocks
type APIKey ¶
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 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 GameServerObjectMeta ¶
type GameServerObjectMeta struct { Name string `json:"name,omitempty"` Namespace string `json:"namespace,omitempty"` Uid string `json:"uid,omitempty"` ResourceVersion string `json:"resource_version,omitempty"` Generation string `json:"generation,omitempty"` CreationTimestamp string `json:"creation_timestamp,omitempty"` DeletionTimestamp string `json:"deletion_timestamp,omitempty"` Annotations map[string]string `json:"annotations,omitempty"` Labels map[string]string `json:"labels,omitempty"` }
type GameServerSpec ¶
type GameServerSpec struct {
Health *SpecHealth `json:"health,omitempty"`
}
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 GooglerpcStatus ¶ added in v1.29.0
type SDKApiService ¶
type SDKApiService service
func (*SDKApiService) Allocate ¶
func (a *SDKApiService) Allocate(ctx context.Context, body SdkEmpty) (SdkEmpty, *http.Response, error)
SDKApiService Call to self Allocation the GameServer
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return SdkEmpty
func (*SDKApiService) GetGameServer ¶
func (a *SDKApiService) GetGameServer(ctx context.Context) (SdkGameServer, *http.Response, error)
SDKApiService Retrieve the current GameServer data
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return SdkGameServer
func (*SDKApiService) Health ¶
func (a *SDKApiService) Health(ctx context.Context, body SdkEmpty) (SdkEmpty, *http.Response, error)
SDKApiService Send a Empty every d Duration to declare that this GameSever is healthy
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body (streaming inputs)
@return SdkEmpty
func (*SDKApiService) Ready ¶
SDKApiService Call when the GameServer is ready
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return SdkEmpty
func (*SDKApiService) Reserve ¶
func (a *SDKApiService) Reserve(ctx context.Context, body SdkDuration) (SdkEmpty, *http.Response, error)
SDKApiService Marks the GameServer as the Reserved state for Duration
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return SdkEmpty
func (*SDKApiService) SetAnnotation ¶
func (a *SDKApiService) SetAnnotation(ctx context.Context, body SdkKeyValue) (SdkEmpty, *http.Response, error)
SDKApiService Apply a Annotation to the backing GameServer metadata
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return SdkEmpty
func (*SDKApiService) SetLabel ¶
func (a *SDKApiService) SetLabel(ctx context.Context, body SdkKeyValue) (SdkEmpty, *http.Response, error)
SDKApiService Apply a Label to the backing GameServer metadata
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return SdkEmpty
func (*SDKApiService) Shutdown ¶
func (a *SDKApiService) Shutdown(ctx context.Context, body SdkEmpty) (SdkEmpty, *http.Response, error)
SDKApiService Call when the GameServer is shutting down
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return SdkEmpty
func (*SDKApiService) WatchGameServer ¶
func (a *SDKApiService) WatchGameServer(ctx context.Context) (StreamResultOfSdkGameServer, *http.Response, error)
SDKApiService Send GameServer details whenever the GameServer is updated
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return StreamResultOfSdkGameServer
type SdkDuration ¶
type SdkDuration struct {
Seconds string `json:"seconds,omitempty"`
}
type SdkGameServer ¶
type SdkGameServer struct { ObjectMeta *GameServerObjectMeta `json:"object_meta,omitempty"` Spec *GameServerSpec `json:"spec,omitempty"` Status *SdkGameServerStatus `json:"status,omitempty"` }
A GameServer Custom Resource Definition object We will only export those resources that make the most sense. Can always expand to more as needed.
type SdkGameServerStatus ¶ added in v1.29.0
type SdkGameServerStatus struct { State string `json:"state,omitempty"` Address string `json:"address,omitempty"` Addresses []StatusAddress `json:"addresses,omitempty"` Ports []StatusPort `json:"ports,omitempty"` Players *StatusPlayerStatus `json:"players,omitempty"` Counters map[string]StatusCounterStatus `json:"counters,omitempty"` Lists map[string]StatusListStatus `json:"lists,omitempty"` }
type SdkKeyValue ¶
type SpecHealth ¶
type StatusAddress ¶ added in v1.34.0
type StatusCounterStatus ¶ added in v1.34.0
type StatusListStatus ¶ added in v1.34.0
type StatusPlayerStatus ¶
type StatusPort ¶
type StreamResultOfSdkGameServer ¶ added in v1.29.0
type StreamResultOfSdkGameServer struct {
Result *SdkGameServer `json:"result,omitempty"`
}
Source Files ¶
- api_sdk.go
- client.go
- configuration.go
- model_game_server_object_meta.go
- model_game_server_spec.go
- model_googlerpc_status.go
- model_sdk_duration.go
- model_sdk_empty.go
- model_sdk_game_server.go
- model_sdk_game_server_status.go
- model_sdk_key_value.go
- model_spec_health.go
- model_status_address.go
- model_status_counter_status.go
- model_status_list_status.go
- model_status_player_status.go
- model_status_port.go
- model_stream_result_of_sdk_game_server.go
- response.go