swagger

package module
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Jul 24, 2024 License: MIT Imports: 21 Imported by: 1

README

Go API client for swagger

Introduction

The Edgegap API lets you manage all your resources from standard HTTP requests. We promote using them to automate all your processes that are using Edgegap.

If you have any questions, don't hesitate to contact us via email, or you can also jump on our Discord. We will be happy to help. Feel free to make features request; we also love those.

Pagination - Response​

The GET response body can be returned with pagination to avoid requesting all the data at once.

Pagination object will always be under the paginator key.

{
  \"number\": \"The Current page, default=1\",
  \"next_page_number\": \"The Next page number or null\",
  \"previous_page_number\": \"The Previous page number or null\",
  \"paginator\": {
    \"num_pages\": \"The total numbers of pages\"
  },
  \"has_next\": \"Boolean if there is a next page\",
  \"has_previous\": \"Boolean if there is a previous page\"
}

Full Body Example:

{
  \"count\": 100,
  \"data\": [\"value-0\", \"[...]\", \"value-9\"],
  \"success\": true,
  \"pagination\": {
    \"number\": 1,
    \"next_page_number\": 2,
    \"previous_page_number\": null,
    \"paginator\": {
      \"num_pages\": 10
    },
    \"has_next\": true,
    \"has_previous\": false
  }
}

Pagination - Parameters​

You can add those values to manipulate the pagination object in the URL Parameters.

  • page
  • limit

Example:

# To get the second page
GET - https://api.edgegap.com/v1/apps?page=2

# To change the count of element in one page (20/page)
GET - https://api.edgegap.com/v1/apps?limit=20

# You can mix those (20/page, second page)
GET - https://api.edgegap.com/v1/apps?page=2&limit=20

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen For more information, please visit https://edgegap.com

Installation

Put the package under your project folder and add the following in import:

import "github.com/cajun-pro-llc/edgegap-swagger"

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
ApplicationsApi AppVersionDelete Delete /v1/app/{app_name}/version/{version_name} Delete an Application Version
ApplicationsApi AppVersionGet Get /v1/app/{app_name}/version/{version_name} Get an Application Version
ApplicationsApi AppVersionPost Post /v1/app/{app_name}/version Create a New Application Version
ApplicationsApi AppVersionWhitelistEntryDelete Delete /v1/app/{app_name}/version/{version_name}/whitelist/{entry_id} Delete an ACL Entry
ApplicationsApi AppVersionWhitelistEntryGet Get /v1/app/{app_name}/version/{version_name}/whitelist/{entry_id} Get an ACL Entry
ApplicationsApi AppVersionWhitelistGet Get /v1/app/{app_name}/version/{version_name}/whitelist List All ACL Entries for an Application Version
ApplicationsApi AppVersionWhitelistPost Post /v1/app/{app_name}/version/{version_name}/whitelist Create an ACL Entry
ApplicationsApi AppVersionsGet Get /v1/app/{app_name}/versions List All Versions for an Application
ApplicationsApi AppVersionsPatch Patch /v1/app/{app_name}/version/{version_name} Update an Application Version
ApplicationsApi ApplicationDelete Delete /v1/app/{app_name} Delete an Application
ApplicationsApi ApplicationGet Get /v1/app/{app_name} Get an Application
ApplicationsApi ApplicationPatch Patch /v1/app/{app_name} Update an Application
ApplicationsApi ApplicationPost Post /v1/app Create a New Application
ApplicationsApi ApplicationsGet Get /v1/apps List All Applications
ContextApi ContextCreateDeploymentTag Post /v1/context/{request_id}/{security_number}/tags Create a Tag for a Running Deployment
ContextApi ContextDeleteDeploymentTag Delete /v1/context/{request_id}/{security_number}/tags/{tag_name} Delete a Tag from a Running Deployment
ContextApi ContextGet Get /v1/context/{request_id}/{security_number} Get the Context of a Deployment
CustomSessionsApi DeleteCustomSession Delete /v1/deployment/{request_id}/custom/session/{custom_id} Delete a Custom Session
CustomSessionsApi DeleteCustomSessions Delete /v1/deployment/{request_id}/custom/sessions Delete Custom Sessions in Bulk
CustomSessionsApi GetCustomSession Get /v1/deployment/{request_id}/custom/session/{custom_id} Get a Custom Session
CustomSessionsApi GetCustomSessions Get /v1/deployment/{request_id}/custom/sessions List All Custom Session of a Deployment
CustomSessionsApi PatchCustomSession Patch /v1/deployment/{request_id}/custom/session/{custom_id} Update a Custom Session
CustomSessionsApi PostCustomSession Post /v1/deployment/{request_id}/custom/session/{custom_id} Create a New Custom Session
CustomSessionsApi PostCustomSessions Post /v1/deployment/{request_id}/custom/sessions Create Custom Sessions in Bulk
DeploymentTagsApi DeploymentsTagsCreate Post /v1/deployments/{request_id}/tags Create Tag for a Deployment
DeploymentTagsApi DeploymentsTagsDelete Delete /v1/deployments/{request_id}/tags/{tag_name} Delete Tag for a Deployment
DeploymentTagsApi DeploymentsTagsList Get /v1/deployments/{request_id}/tags List tags for a Deployment
DeploymentTagsApi DeploymentsTagsRead Get /v1/deployments/{request_id}/tags/{tag_name} Get tag for a Deployment
DeploymentTagsApi DeploymentsTagsUpdate Patch /v1/deployments/{request_id}/tags/{tag_name} Update Tag for a Deployment
DeploymentsApi Deploy Post /v1/deploy Create a Deployment
DeploymentsApi DeploymentDelete Delete /v1/stop/{request_id} Delete a Deployment
DeploymentsApi DeploymentGetLogs Get /v1/deployment/{request_id}/container-logs Get Deployment Container Logs
DeploymentsApi DeploymentStatusGet Get /v1/status/{request_id} Get a Deployment Status and Information
DeploymentsApi DeploymentUpdate Patch /v1/deployments/{request_id} Updates properties of a deployment
DeploymentsApi DeploymentsBulkDelete Post /v1/deployments/bulk-stop Delete Deployments in Bulk
DeploymentsApi DeploymentsGet Get /v1/deployments List All Deployments
DeploymentsApi SelfDeploymentDelete Delete /v1/self/stop/{request_id}/{access_point_id} Delete a Deployment from inside the container
EndpointStorageApi EndpointCreate Post /v1/storage/endpoint Create a New Endpoint Storage
EndpointStorageApi EndpointDelete Delete /v1/storage/endpoint/{endpoint_name} Delete an Endpoint Storage
EndpointStorageApi EndpointGet Get /v1/storage/endpoint/{endpoint_name} Get an Endpoint Storage
EndpointStorageApi EndpointUpdate Patch /v1/storage/endpoint/{endpoint_name} Update an Endpoint Storage
EndpointStorageApi EndpointsList Get /v1/storage/endpoints List All Endpoint Storage
EndpointStorageApi PullProfileCreate Post /v1/storage/endpoint/{endpoint_name}/pull-profile Create a New Pull Profile
EndpointStorageApi PullProfileDelete Delete /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} Delete a Pull Profile
EndpointStorageApi PullProfileGet Get /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} Get a Pull Profile
EndpointStorageApi PullProfileLinkAppVersion Put /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name} Link a Pull Profile to an Application Version
EndpointStorageApi PullProfileList Get /v1/storage/endpoint/{endpoint_name}/pull-profiles List All Pull Profile of an Endpoint Storage
EndpointStorageApi PullProfileUnlinkAppVersion Delete /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name} Unlink a Pull Profile From an Application Version
EndpointStorageApi PullProfileUpdate Patch /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} Update a Pull Profile
FleetsApi FleetCreate Post /v1/fleet Create a Fleet
FleetsApi FleetDelete Delete /v1/fleet/{fleet_name} Delete a Fleet
FleetsApi FleetGet Get /v1/fleet/{fleet_name} Get a Fleet
FleetsApi FleetLinkAppVersion Put /v1/fleet/{fleet_name}/app/{app_name}/version/{version_name} Link an Application Version to a Fleet
FleetsApi FleetPoliciesCreate Post /v1/fleet/{fleet_name}/policies Create a Fleet Policy
FleetsApi FleetPoliciesDelete Delete /v1/fleet/{fleet_name}/policies/{policy_name} Delete a Policy
FleetsApi FleetPoliciesGet Get /v1/fleet/{fleet_name}/policies/{policy_name} Get a Policy
FleetsApi FleetPoliciesList Get /v1/fleet/{fleet_name}/policies List All Policies of a Fleet
FleetsApi FleetPoliciesUpdate Patch /v1/fleet/{fleet_name}/policies/{policy_name} Update a Policy
FleetsApi FleetUnlinkAppVersion Delete /v1/fleet/{fleet_name}/app/{app_name}/version/{version_name} Unlink an Application Version From a Fleet
FleetsApi FleetUpdate Patch /v1/fleet/{fleet_name} Update a Fleet
FleetsApi Fleets Get /v1/fleets List All Fleets
IPLookupApi IP Get /v1/ip Get Your Public IP
IPLookupApi IPLookup Get /v1/ip/{ip}/lookup Get an IP's information
IPLookupApi IPsLookup Post /v1/ips/lookup Get IPs Information in Bulk
LobbiesApi LobbyCreate Post /v1/lobbies Create a Lobby
LobbiesApi LobbyDeploy Post /v1/lobbies:deploy Deploy a Lobby
LobbiesApi LobbyGet Get /v1/lobbies/{lobby_name} Get a Lobby
LobbiesApi LobbyTerminate Post /v1/lobbies:terminate Terminate a Lobby
LocationsApi LocationBeaconList Get /v1/locations/beacons List All Location Beacons
LocationsApi LocationsGet Get /v1/locations List All Locations
MatchmakerApi DeleteMatchmaker Delete /v1/aom/matchmaker/{matchmaker_name} Delete a Matchmaker
MatchmakerApi DeleteMatchmakerComponent Delete /v1/aom/component/{component_name} Delete a Matchmaker Component
MatchmakerApi DeleteMatchmakerComponentEnv Delete /v1/aom/component/{component_name}/env/{env_key} Delete a Matchmaker Component ENV
MatchmakerApi DeleteMatchmakerManagedRelease Delete /v1/aom/matchmaker/{matchmaker_name}/release/managed/{release_version} Delete a Matchmaker Managed Release
MatchmakerApi DeleteMatchmakerRelease Delete /v1/aom/matchmaker/{matchmaker_name}/release/{release_version} Delete a Matchmaker Release
MatchmakerApi DeleteMatchmakerReleaseConfig Delete /v1/aom/release/config/{config_name} Delete a Matchmaker Release Config
MatchmakerApi GetComponentList Get /v1/aom/components List All Matchmaker Components
MatchmakerApi GetEnvsList Get /v1/aom/component/{component_name}/envs List All Matchmaker Component ENVs
MatchmakerApi GetMatchmaker Get /v1/aom/matchmaker/{matchmaker_name} Get a Matchmaker
MatchmakerApi GetMatchmakerComponent Get /v1/aom/component/{component_name} Get a Matchmaker Component
MatchmakerApi GetMatchmakerComponentEnv Get /v1/aom/component/{component_name}/env/{env_key} Get a Matchmaker Component ENV
MatchmakerApi GetMatchmakerList Get /v1/aom/matchmakers List All Matchmakers
MatchmakerApi GetMatchmakerManagedRelease Get /v1/aom/matchmaker/{matchmaker_name}/release/managed/{release_version} Get a Matchmaker Managed Release
MatchmakerApi GetMatchmakerRelease Get /v1/aom/matchmaker/{matchmaker_name}/release/{release_version} Get a Matchmaker Release
MatchmakerApi GetMatchmakerReleaseConfig Get /v1/aom/release/config/{config_name} Get a Matchmaker Release Config
MatchmakerApi GetReleaseConfigsList Get /v1/aom/release/configs List All Matchmaker Release Configs
MatchmakerApi GetReleaseList Get /v1/aom/matchmaker/{matchmaker_name}/releases List All Matchmaker Releases
MatchmakerApi PatchMatchmaker Patch /v1/aom/matchmaker/{matchmaker_name} Update a Matchmaker
MatchmakerApi PatchMatchmakerComponent Patch /v1/aom/component/{component_name} Update a Matchmaker Component
MatchmakerApi PatchMatchmakerComponentEnv Patch /v1/aom/component/{component_name}/env/{env_key} Update a Matchmaker Component ENV
MatchmakerApi PatchMatchmakerManagedRelease Patch /v1/aom/matchmaker/{matchmaker_name}/release/managed/{release_version} Update a Matchmaker Managed Release
MatchmakerApi PatchMatchmakerRelease Patch /v1/aom/matchmaker/{matchmaker_name}/release/{release_version} Update a Matchmaker Release
MatchmakerApi PatchMatchmakerReleaseConfig Patch /v1/aom/release/config/{config_name} Update a Matchmaker Release Config
MatchmakerApi PostMatchmaker Post /v1/aom/matchmaker Create a Matchmaker
MatchmakerApi PostMatchmakerComponent Post /v1/aom/component Create a Matchmaker Component
MatchmakerApi PostMatchmakerComponentEnv Post /v1/aom/component/{component_name}/env Create a Matchmaker Component ENV
MatchmakerApi PostMatchmakerManagedRelease Post /v1/aom/matchmaker/{matchmaker_name}/release/managed Create a Matchmaker Managed Release
MatchmakerApi PostMatchmakerRelease Post /v1/aom/matchmaker/{matchmaker_name}/release Create a Matchmaker Release
MatchmakerApi PostMatchmakerReleaseConfig Post /v1/aom/release/config Create a Matchmaker Release Config
MetricsApi DeploymentMetricsGet Get /v1/metrics/deployment/{request_id} Get a Deployment Metrics
MonitoringApi Monitoring Get /monitor
RelaysApi RelaySessionCreate Post /v1/relays/sessions Create a Relay Session
RelaysApi RelaySessionDelete Delete /v1/relays/sessions/{session_id} Delete a Relay Session
RelaysApi RelaySessionGet Get /v1/relays/sessions/{session_id} Get a Relay Session
RelaysApi RelaySessionList Get /v1/relays/sessions List all Relay Sessions
RelaysApi RelayUserAuthorize Post /v1/relays/sessions:authorize-user Authorize a user on a Relay Session
RelaysApi RelayUserRevoke Post /v1/relays/sessions:revoke-user Remove a user on a Relay Session
SessionsApi DeleteUsersSession Delete /v1/session/{session_id}/users Delete Users From a Session
SessionsApi GetSession Get /v1/session/{session_id} Get a Session
SessionsApi GetUsersSession Get /v1/session/{session_id}/users List Users of a Session
SessionsApi ListSessions Get /v1/sessions List All Sessions
SessionsApi PutUsersSession Put /v1/session/{session_id}/users Put Users in a Session
SessionsApi SessionDelete Delete /v1/session/{session_id} Delete a Session
SessionsApi SessionPost Post /v1/session Create a Session
SessionsApi SessionsBulkStop Post /v1/sessions/bulk-stop Delete Sessions in Bulk
TelemetryApi ActiveDeploymentTelemetryGet Get /v1/telemetry/active-deployments/{retrieval_key} Get the Result of an Active Deployment Telemetry Request
TelemetryApi ActiveDeploymentTelemetryPost Post /v1/telemetry/active-deployments Create a New Active Deployment Telemetry Request

Documentation For Models

Documentation For Authorization

apiKey

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

info@edgegap.com

Documentation

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 {
	ApplicationsApi *ApplicationsApiService

	ContextApi *ContextApiService

	CustomSessionsApi *CustomSessionsApiService

	DeploymentTagsApi *DeploymentTagsApiService

	DeploymentsApi *DeploymentsApiService

	EndpointStorageApi *EndpointStorageApiService

	FleetsApi *FleetsApiService

	IPLookupApi *IPLookupApiService

	LobbiesApi *LobbiesApiService

	LocationsApi *LocationsApiService

	MatchmakerApi *MatchmakerApiService

	MetricsApi *MetricsApiService

	MonitoringApi *MonitoringApiService

	RelaysApi *RelaysApiService

	SessionsApi *SessionsApiService

	TelemetryApi *TelemetryApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Edgegap V1 API v1.0.0 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 ActiveDeploymentTelemetryGetResult 

type ActiveDeploymentTelemetryGetResult struct {
	// Unique retrieval key to get the telemetry response.
	RetrievalKey string `json:"retrieval_key"`
	// Result sorted by best score. Index 0 is the best one.
	Scores []ActiveDeploymentTelemetryScore `json:"scores"`
	// If the score list is incomplete and missing request IDs. Can occur if you request the results before we receive telemetry from every deployment.
	PartialResult bool `json:"partial_result"`
}

type ActiveDeploymentTelemetryRequest 

type ActiveDeploymentTelemetryRequest struct {
	// List of Deployment request ID to get telemetry.
	Deployments []string `json:"deployments"`
	Ips         []string `json:"ips"`
	// Webhook URL that we should call to send the telemetry response back.
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type ActiveDeploymentTelemetryResponse 

type ActiveDeploymentTelemetryResponse struct {
	// Unique retrieval key to get the telemetry response.
	RetrievalKey string `json:"retrieval_key"`
	// Expiration date of the retrieval key.
	Expire string `json:"expire"`
}

type ActiveDeploymentTelemetryScore 

type ActiveDeploymentTelemetryScore struct {
	// The request ID of the tested deployment
	RequestId string `json:"request_id"`
}

type ApiModelContainercrashdata 

type ApiModelContainercrashdata struct {
	// Auto Generated Field for exit_code
	ExitCode int32 `json:"exit_code,omitempty"`
	// Auto Generated Field for message
	Message string `json:"message,omitempty"`
	// Auto Generated Field for restart_count
	RestartCount int32 `json:"restart_count,omitempty"`
}

type ApiModelContainerlogs 

type ApiModelContainerlogs struct {
	// Auto Generated Field for logs
	Logs string `json:"logs,omitempty"`
	// Auto Generated Field for encoding
	Encoding string `json:"encoding,omitempty"`
	// Auto Generated Field for crash_logs
	CrashLogs string                      `json:"crash_logs,omitempty"`
	CrashData *ApiModelContainercrashdata `json:"crash_data,omitempty"`
	// Auto Generated Field for logs_link
	LogsLink string `json:"logs_link,omitempty"`
}

type ApiModelDeploymentfilter 

type ApiModelDeploymentfilter struct {
	// Auto Generated Field for field
	Field string `json:"field"`
	// Auto Generated Field for values
	Values []string `json:"values"`
	// Auto Generated Field for filter_type
	FilterType string `json:"filter_type"`
}

type ApiModelLocation 

type ApiModelLocation struct {
	// City of the object
	City string `json:"city"`
	// Country of the object
	Country string `json:"country"`
	// Continent of the object
	Continent string `json:"continent"`
	// Administrative division of the object
	AdministrativeDivision string `json:"administrative_division"`
	// Timezone of the object
	Timezone string `json:"timezone"`
	// Latitude of the object
	Latitude float32 `json:"latitude"`
	// Longitude of the object
	Longitude float32 `json:"longitude"`
}

type ApiModelLocationbeacon 

type ApiModelLocationbeacon struct {
	// The URL of the pingable location.
	Host string `json:"host"`
	// The open UDP port number for UDP pings, if available.
	UdpPort int32 `json:"udp_port,omitempty"`
	// The open TCP port number for TCP pings, if available.
	TcpPort  int32             `json:"tcp_port,omitempty"`
	Location *ApiModelLocation `json:"location"`
}

type AppVersionCreateResponse 

type AppVersionCreateResponse struct {
	// If the creation happened correctly
	Success bool               `json:"success,omitempty"`
	Version *AppVersionPayload `json:"version,omitempty"`
}

type AppVersionCreateSessionConfig 

type AppVersionCreateSessionConfig struct {
	// The kind of session to create. If 'Default' if chosen, the 'session_config' will be ignored. The kind of session must be: Default, Seat, Match
	Kind string `json:"kind"`
	// The number of game slots on each deployment of this app version.
	Sockets int32 `json:"sockets"`
	// If a deployment should be made autonomously if there is not enough sockets open on a new session.
	Autodeploy bool `json:"autodeploy,omitempty"`
	// The number of minutes a deployment of this app version can spend with no session connected before being terminated.
	EmptyTtl int32 `json:"empty_ttl,omitempty"`
	// The number of minutes after a session-type deployment has been terminated to remove all the session information connected to your deployment. Minimum and default value is set to 60 minutes so you can manage your session termination before it is removed.
	SessionMaxDuration int32 `json:"session_max_duration,omitempty"`
}

type AppVersionDelete 

type AppVersionDelete struct {
	// If the creation happened correctly
	Success bool   `json:"success,omitempty"`
	Message string `json:"message,omitempty"`
}

type AppVersionEnv 

type AppVersionEnv struct {
	// The Key where the Environment Variable will be set
	Key string `json:"key"`
	// The Value to retrieve at the Key
	Value string `json:"value"`
	// This will encrypt the value in our database, won't be readable by external source
	IsSecret bool `json:"is_secret,omitempty"`
}

type AppVersionList 

type AppVersionList struct {
	Versions   []AppVersionPayload `json:"versions,omitempty"`
	TotalCount int32               `json:"total_count,omitempty"`
}

type AppVersionPayload 

type AppVersionPayload struct {
	// The Version Name
	Name string `json:"name"`
	// If the Version is active currently in the system
	IsActive bool `json:"is_active,omitempty"`
	// The Repository where the image is (i.e. 'harbor.edgegap.com' or 'docker.io')
	DockerRepository string `json:"docker_repository"`
	// The name of your image (i.e. 'edgegap/demo')
	DockerImage string `json:"docker_image"`
	// The tag of your image (i.e. '0.1.2')
	DockerTag string `json:"docker_tag"`
	// The username to access the docker repository
	PrivateUsername string `json:"private_username,omitempty"`
	// The Private Password or Token of the username (We recommend to use a token)
	PrivateToken string `json:"private_token,omitempty"`
	// Units of vCPU needed (1024 = 1vcpu)
	ReqCpu int32 `json:"req_cpu"`
	// Units of memory in MB needed (1024 = 1GB)
	ReqMemory int32 `json:"req_memory"`
	// Units of GPU needed (1024 = 1 GPU)
	ReqVideo int32 `json:"req_video,omitempty"`
	// The Max duration of the game in minute. 0 means forever.
	MaxDuration int32 `json:"max_duration,omitempty"`
	// Allow to inject ASA Variables
	UseTelemetry bool `json:"use_telemetry,omitempty"`
	// DEPRECATED - The context environment variables are now injected into all deployments by default. No changes are required. (https://docs.edgegap.com/docs/deployment/injected-variables)
	InjectContextEnv bool `json:"inject_context_env,omitempty"`
	// ACL Protection is active
	WhitelistingActive bool `json:"whitelisting_active,omitempty"`
	// Allow faster deployment by caching your container image in every Edge site
	ForceCache bool `json:"force_cache,omitempty"`
	// Start of the preferred interval for caching your container
	CacheMinHour int32 `json:"cache_min_hour,omitempty"`
	// End of the preferred interval for caching your container
	CacheMaxHour int32 `json:"cache_max_hour,omitempty"`
	// Estimated maximum time in seconds to deploy, after this time we will consider it not working and retry.
	TimeToDeploy int32 `json:"time_to_deploy,omitempty"`
	// Enable every location available. By enabling this, your request will use every potential location, including those which may require a longer time to deploy. This means that your application could take significantly more time before being ready. We do not recommend this feature for live games. This functionality does not support ACL and Caching at the moment.
	EnableAllLocations bool `json:"enable_all_locations,omitempty"`
	// Parameters defining the behavior of a session-based app version. If set, the app is considered to be session-based.
	SessionConfig *AppVersionCreateSessionConfig `json:"session_config,omitempty"`
	Ports         []AppVersionPort               `json:"ports,omitempty"`
	Probe         *AppVersionProbe               `json:"probe,omitempty"`
	Envs          []AppVersionEnv                `json:"envs,omitempty"`
	// By enabling the verify_image option, your image infos (docker_repository, docker_image, docker_tag) will be tested.
	VerifyImage bool `json:"verify_image,omitempty"`
	// Termination grace period in seconds after the SIGTERM signal has been sent
	TerminationGracePeriodSeconds int32 `json:"termination_grace_period_seconds,omitempty"`
	// The name of the endpoint storage to link
	EndpointStorage string `json:"endpoint_storage,omitempty"`
}

type AppVersionPort 

type AppVersionPort struct {
	// The Port to Expose your service. Port 0 reserved for one-to-one port mapping. See our doc for more information.
	Port int32 `json:"port"`
	// Available protocols: TCP, UDP, TCP/UDP, HTTP, HTTPS, WS or WSS
	Protocol string `json:"protocol"`
	// If the port must be verified by our port validations
	ToCheck bool `json:"to_check,omitempty"`
	// Enabling with HTTP or WS will inject a sidecar proxy that upgrades the connection with TLS
	TlsUpgrade bool `json:"tls_upgrade,omitempty"`
	// An optional name for the port for easier handling. Mandatory if using port 0
	Name string `json:"name,omitempty"`
}

type AppVersionProbe 

type AppVersionProbe struct {
	// Your optimal value for Latency
	OptimalPing int32 `json:"optimal_ping"`
	// Your reject value for Latency
	RejectedPing int32 `json:"rejected_ping"`
}

type AppVersionUpdatePayload 

type AppVersionUpdatePayload struct {
	// The Version Name
	Name string `json:"name,omitempty"`
	// If the Version is active currently in the system
	IsActive bool `json:"is_active,omitempty"`
	// The Repository where the image is (i.e. 'harbor.edgegap.com' or 'docker.io')
	DockerRepository string `json:"docker_repository,omitempty"`
	// The name of your image (i.e. 'edgegap/demo')
	DockerImage string `json:"docker_image,omitempty"`
	// The tag of your image (i.e. '0.1.2')
	DockerTag string `json:"docker_tag,omitempty"`
	// The username to access the docker repository
	PrivateUsername string `json:"private_username,omitempty"`
	// The Private Password or Token of the username (We recommend to use a token)
	PrivateToken string `json:"private_token,omitempty"`
	// Units of vCPU needed (1024 = 1vcpu)
	ReqCpu int32 `json:"req_cpu,omitempty"`
	// Units of memory in MB needed (1024 = 1GB)
	ReqMemory int32 `json:"req_memory,omitempty"`
	// Units of GPU needed (1024= 1 GPU)
	ReqVideo int32 `json:"req_video,omitempty"`
	// Allow to inject ASA Variables
	UseTelemetry bool `json:"use_telemetry,omitempty"`
	// DEPRECATED - The context environment variables are now injected into all deployments by default. No changes are required. (https://docs.edgegap.com/docs/deployment/injected-variables)
	InjectContextEnv bool `json:"inject_context_env,omitempty"`
	// ACL Protection is active
	WhitelistingActive bool `json:"whitelisting_active,omitempty"`
	// Allow faster deployment by caching your container image in every Edge site
	ForceCache bool `json:"force_cache,omitempty"`
	// Start of the preferred interval for caching your container
	CacheMinHour int32 `json:"cache_min_hour,omitempty"`
	// End of the preferred interval for caching your container
	CacheMaxHour int32 `json:"cache_max_hour,omitempty"`
	// Estimated maximum time in seconds to deploy, after this time we will consider it not working and retry.
	TimeToDeploy int32 `json:"time_to_deploy,omitempty"`
	// Enable every location available. By enabling this, your request will use every potential location, including those which may require a longer time to deploy. This means that your application may take up to 2 minutes before being up and ready. This functionality does not support ACL and Caching at the moment.
	EnableAllLocations bool `json:"enable_all_locations,omitempty"`
	// Parameters defining the behavior of a session-based app version. If set, the app is considered to be session-based.
	SessionConfig *AppVersionUpdateSessionConfig `json:"session_config,omitempty"`
	Ports         []AppVersionPort               `json:"ports,omitempty"`
	Probe         *AppVersionProbe               `json:"probe,omitempty"`
	Envs          []AppVersionEnv                `json:"envs,omitempty"`
	// Termination grace period in seconds after the SIGTERM signal has been sent
	TerminationGracePeriodSeconds int32 `json:"termination_grace_period_seconds,omitempty"`
	// By enabling the verify_image option, your image infos (docker_repository, docker_image, docker_tag) will be tested.
	VerifyImage bool `json:"verify_image,omitempty"`
	// The name of the endpoint storage to link
	EndpointStorage string `json:"endpoint_storage,omitempty"`
}

type AppVersionUpdateResponse 

type AppVersionUpdateResponse struct {
	// If the creation happened correctly
	Success bool               `json:"success,omitempty"`
	Version *AppVersionPayload `json:"version,omitempty"`
}

type AppVersionUpdateSessionConfig 

type AppVersionUpdateSessionConfig struct {
	// The kind of session to create. If 'Default' if chosen, the application will be handled like a normal application. The kind of session must be: Default, Seat, Match
	Kind string `json:"kind,omitempty"`
	// The number of game slots on each deployment of this app version.
	Sockets int32 `json:"sockets,omitempty"`
	// If a deployment should be made autonomously if there is not enough sockets open on a new session.
	Autodeploy bool `json:"autodeploy,omitempty"`
	// The number of minutes a deployment of this app version can spend with no session connected before being terminated.
	EmptyTtl int32 `json:"empty_ttl,omitempty"`
	// The number of minutes after a session-type deployment has been terminated to remove all the session information connected to your deployment. Minimum and default value is set to 60 minutes so you can manage your session termination before it is removed.
	SessionMaxDuration int32 `json:"session_max_duration,omitempty"`
}

type AppVersionWhitelistEntry 

type AppVersionWhitelistEntry struct {
	// Unique ID of the entry
	Id string `json:"id"`
	// CIDR to allow
	Cidr string `json:"cidr"`
	// Label to organized your entries
	Label string `json:"label,omitempty"`
	// If the Rule will be applied on runtime
	IsActive bool `json:"is_active,omitempty"`
}

type AppVersionWhitelistEntryPayload 

type AppVersionWhitelistEntryPayload struct {
	// CIDR to allow
	Cidr string `json:"cidr"`
	// Label to organized your entries
	Label string `json:"label,omitempty"`
	// If the Rule will be applied on runtime
	IsActive bool `json:"is_active,omitempty"`
}

type AppVersionWhitelistEntrySuccess 

type AppVersionWhitelistEntrySuccess struct {
	// if the operation succeed
	Success        bool                      `json:"success"`
	WhitelistEntry *AppVersionWhitelistEntry `json:"whitelist_entry,omitempty"`
}

type AppVersionWhitelistResponse 

type AppVersionWhitelistResponse struct {
	WhitelistEntries []AppVersionWhitelistEntry `json:"whitelist_entries,omitempty"`
}

type Application 

type Application struct {
	// Application name
	Name string `json:"name"`
	// If the application can be deployed
	IsActive bool `json:"is_active"`
	// If the telemetry agent is installed on the versions of this app.
	IsTelemetryAgentActive bool `json:"is_telemetry_agent_active,omitempty"`
	// Image base64 string
	Image string `json:"image,omitempty"`
	// Creation date
	CreateTime string `json:"create_time"`
	// Date of the last update
	LastUpdated string `json:"last_updated"`
}

type ApplicationPatch 

type ApplicationPatch struct {
	// Application name
	Name string `json:"name,omitempty"`
	// If the application can be deployed
	IsActive bool `json:"is_active,omitempty"`
	// If the telemetry agent is installed on the versions of this app.
	IsTelemetryAgentActive bool `json:"is_telemetry_agent_active,omitempty"`
	// Image base64 string
	Image string `json:"image,omitempty"`
}

type ApplicationPost 

type ApplicationPost struct {
	// The application name
	Name string `json:"name"`
	// If the application can be deployed
	IsActive bool `json:"is_active"`
	// If the telemetry agent is installed on the versions of this app.
	IsTelemetryAgentActive bool `json:"is_telemetry_agent_active,omitempty"`
	// Image base64 string
	Image string `json:"image"`
}

type Applications 

type Applications struct {
	Applications []Application `json:"applications,omitempty"`
}

type ApplicationsApiService 

type ApplicationsApiService service

func (*ApplicationsApiService) AppVersionDelete 

func (a *ApplicationsApiService) AppVersionDelete(ctx context.Context, appName string, versionName string) (AppVersionDelete, *http.Response, error)

ApplicationsApiService Delete an Application Version Delete a specific version of an application.

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

@return AppVersionDelete

func (*ApplicationsApiService) AppVersionGet 

func (a *ApplicationsApiService) AppVersionGet(ctx context.Context, appName string, versionName string) (AppVersionPayload, *http.Response, error)

ApplicationsApiService Get an Application Version Retrieve the specifications of an application version.

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

@return AppVersionPayload

func (*ApplicationsApiService) AppVersionPost 

func (a *ApplicationsApiService) AppVersionPost(ctx context.Context, appName string, payload AppVersionPayload) (AppVersionCreateResponse, *http.Response, error)

ApplicationsApiService Create a New Application Version Create an application version associated with an application. The version contains all the specifications to create a deployment.

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

@return AppVersionCreateResponse

func (*ApplicationsApiService) AppVersionWhitelistEntryDelete 

func (a *ApplicationsApiService) AppVersionWhitelistEntryDelete(ctx context.Context, appName string, versionName string, entryId string) (AppVersionWhitelistEntrySuccess, *http.Response, error)

ApplicationsApiService Delete an ACL Entry Delete an access control list entry for a specific application version

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appName The name of the application
  • @param versionName The name of the application version
  • @param entryId The unique ID of the entry

@return AppVersionWhitelistEntrySuccess

func (*ApplicationsApiService) AppVersionWhitelistEntryGet 

func (a *ApplicationsApiService) AppVersionWhitelistEntryGet(ctx context.Context, appName string, versionName string, entryId string) (AppVersionWhitelistEntry, *http.Response, error)

ApplicationsApiService Get an ACL Entry Retrieve a specific access control list entry for an application version.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appName The name of the application
  • @param versionName The name of the application version
  • @param entryId The unique ID of the entry

@return AppVersionWhitelistEntry

func (*ApplicationsApiService) AppVersionWhitelistGet 

func (a *ApplicationsApiService) AppVersionWhitelistGet(ctx context.Context, appName string, versionName string) (AppVersionWhitelistResponse, *http.Response, error)

ApplicationsApiService List All ACL Entries for an Application Version List all the access control list entries for a specific application version.

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

@return AppVersionWhitelistResponse

func (*ApplicationsApiService) AppVersionWhitelistPost 

func (a *ApplicationsApiService) AppVersionWhitelistPost(ctx context.Context, appName string, versionName string, payload AppVersionWhitelistEntryPayload) (AppVersionWhitelistEntrySuccess, *http.Response, error)

ApplicationsApiService Create an ACL Entry Create an access control list entry for an app version. This will allow the specified CIDR to connect to the deployment. The option ```whitelisting_active``` must be activated in the application version.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appName The name of the application
  • @param versionName The name of the application version
  • @param payload

@return AppVersionWhitelistEntrySuccess

func (*ApplicationsApiService) AppVersionsGet 

func (a *ApplicationsApiService) AppVersionsGet(ctx context.Context, appName string) (AppVersionList, *http.Response, error)

ApplicationsApiService List All Versions for an Application List all versions of a specific application.

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

@return AppVersionList

func (*ApplicationsApiService) AppVersionsPatch 

func (a *ApplicationsApiService) AppVersionsPatch(ctx context.Context, appName string, versionName string, payload AppVersionUpdatePayload) (AppVersionUpdateResponse, *http.Response, error)

ApplicationsApiService Update an Application Version Update an application version with new specifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appName The name of the application
  • @param versionName The name of the application version
  • @param payload

@return AppVersionUpdateResponse

func (*ApplicationsApiService) ApplicationDelete 

func (a *ApplicationsApiService) ApplicationDelete(ctx context.Context, appName string) (*http.Response, error)

ApplicationsApiService Delete an Application Delete an application and all its current versions.

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

func (*ApplicationsApiService) ApplicationGet 

func (a *ApplicationsApiService) ApplicationGet(ctx context.Context, appName string) (Application, *http.Response, error)

ApplicationsApiService Get an Application Retrieve an application and its information.

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

@return Application

func (*ApplicationsApiService) ApplicationPatch 

func (a *ApplicationsApiService) ApplicationPatch(ctx context.Context, appName string, payload ApplicationPatch) (Application, *http.Response, error)

ApplicationsApiService Update an Application Update an application with new information.

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

@return Application

func (*ApplicationsApiService) ApplicationPost 

func (a *ApplicationsApiService) ApplicationPost(ctx context.Context, payload ApplicationPost) (Application, *http.Response, error)

ApplicationsApiService Create a New Application Create an application that will regroup application versions.

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

@return Application

func (*ApplicationsApiService) ApplicationsGet 

func (a *ApplicationsApiService) ApplicationsGet(ctx context.Context) (Applications, *http.Response, error)

ApplicationsApiService List All Applications List all the applications that you own.

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

@return Applications

type BaseModel 

type BaseModel struct {
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

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 BulkSessionDelete 

type BulkSessionDelete struct {
	// List of Delete
	Sessions []SessionDelete `json:"sessions"`
	// List of Delete Errors
	Errors []string `json:"errors"`
}

type BulkSessionPost 

type BulkSessionPost struct {
	// List of Creation Reply
	Sessions []SessionRequest `json:"sessions"`
	// List of Creation Errors Reply
	Errors []string `json:"errors"`
}

type ClientRelayPort 

type ClientRelayPort struct {
	// The port number
	Port int32 `json:"port,omitempty"`
	// The protocol of the port
	Protocol string `json:"protocol,omitempty"`
	// The link to the port
	Link string `json:"link,omitempty"`
}

type ComponentCredentials 

type ComponentCredentials struct {
	// Username for the component's private repository.
	Username string `json:"username"`
	// Password (token) of the component's private repository.
	Token string `json:"token"`
}

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 ContainerLogStorageModel 

type ContainerLogStorageModel struct {
	// Will override the app version container log storage for this deployment
	Enabled bool `json:"enabled"`
	// The name of your endpoint storage. If container log storage is enabled without this parameter, we will try to take the app version endpoint storage. If there is no endpoint storage in your app version, the container logs will not be stored. If we don't find any endpoint storage associated with this name, the container logs will not be stored.
	EndpointStorage string `json:"endpoint_storage,omitempty"`
}

type ContextApiService 

type ContextApiService service

func (*ContextApiService) ContextCreateDeploymentTag 

func (a *ContextApiService) ContextCreateDeploymentTag(ctx context.Context, requestId string, securityNumber int32, authorization string, payload Payload) (ContextDeploymentTagResponse, *http.Response, error)

ContextApiService Create a Tag for a Running Deployment Create a tag for a running deployment. You should use this URL inside your deployment container. The URL is injected in your deployment and accessible via the environment variable ARBITRIUM_CONTEXT_URL and you need to append \"/tags\" at the end of this URL.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param requestId Unique Identifier to keep track of your request across all Arbitrium ecosystem.
  • @param securityNumber Random Security number generate to validate the request id.
  • @param authorization Auto Generated token. This token is injected in your deployment and can be found via the environment variable named ARBITRIUM_CONTEXT_TOKEN
  • @param payload

@return ContextDeploymentTagResponse

func (*ContextApiService) ContextDeleteDeploymentTag 

func (a *ContextApiService) ContextDeleteDeploymentTag(ctx context.Context, tagName string, requestId string, securityNumber int32, authorization string) (*http.Response, error)

ContextApiService Delete a Tag from a Running Deployment Delete a tag from a running deployment. You should use this URL inside your deployment container. The URL is injected in your deployment and accessible via the environment variable ARBITRIUM_CONTEXT_URL and you need to append \"/tags/{tag_name}\" at the end of this URL.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tagName
  • @param requestId Unique Identifier to keep track of your request across all Arbitrium ecosystem.
  • @param securityNumber Random Security number generate to validate the request id.
  • @param authorization Auto Generated token. This token is injected in your deployment and can be found via the environment variable named ARBITRIUM_CONTEXT_TOKEN

func (*ContextApiService) ContextGet 

func (a *ContextApiService) ContextGet(ctx context.Context, requestId string, securityNumber int32, authorization string) (Deployment, *http.Response, error)

ContextApiService Get the Context of a Deployment Retrieve contextual information about your live deployment. You should use this URL inside your deployment container. The URL is injected in your deployment and accessible via the environment variable ARBITRIUM_CONTEXT_URL.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param requestId Unique Identifier to keep track of your request across all Arbitrium ecosystem.
  • @param securityNumber Random Security number generate to validate the request id.
  • @param authorization Auto Generated token. This token is injected in your deployment and can be found via the environment variable named ARBITRIUM_CONTEXT_TOKEN

@return Deployment

type ContextDeploymentTagResponse 

type ContextDeploymentTagResponse struct {
	// Name of the tag
	Name string `json:"name"`
	// UTC time of tag creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of tag last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type CustomBulkSessionModel 

type CustomBulkSessionModel struct {
	// Custom Session ID
	CustomId string `json:"custom_id"`
	// The List of IP of your user, Array of String, example:     [\"162.254.103.13\",\"198.12.116.39\", \"162.254.135.39\", \"162.254.129.34\"]
	IpList []string `json:"ip_list"`
	// When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type CustomBulkSessionsModel 

type CustomBulkSessionsModel struct {
	Sessions []CustomBulkSessionModel `json:"sessions,omitempty"`
}

type CustomSessionDeleteModel 

type CustomSessionDeleteModel struct {
	// List of Custom IDs to Delete
	Sessions []string `json:"sessions"`
}

type CustomSessionModel 

type CustomSessionModel struct {
	// The List of IP of your user, Array of String, example:     [\"162.254.103.13\",\"198.12.116.39\", \"162.254.135.39\", \"162.254.129.34\"]
	IpList []string `json:"ip_list"`
	// When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type CustomSessionsApiService 

type CustomSessionsApiService service

func (*CustomSessionsApiService) DeleteCustomSession 

func (a *CustomSessionsApiService) DeleteCustomSession(ctx context.Context, customId string, requestId string) (SessionDelete, *http.Response, error)

CustomSessionsApiService Delete a Custom Session Delete a custom session. Once deleted, a custom session is no more accessible and does not have a history. The deployment associated will not be deleted.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customId Custom ID Managed by you
  • @param requestId Deployment Request ID

@return SessionDelete

func (*CustomSessionsApiService) DeleteCustomSessions 

func (a *CustomSessionsApiService) DeleteCustomSessions(ctx context.Context, requestId string, payload CustomSessionDeleteModel) (BulkSessionDelete, *http.Response, error)

CustomSessionsApiService Delete Custom Sessions in Bulk Delete multiple custom sessions from a specific deployment.

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

@return BulkSessionDelete

func (*CustomSessionsApiService) GetCustomSession 

func (a *CustomSessionsApiService) GetCustomSession(ctx context.Context, customId string, requestId string) (SessionGet, *http.Response, error)

CustomSessionsApiService Get a Custom Session Retrieve the information of a custom session.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customId Custom ID Managed by you
  • @param requestId Deployment Request ID

@return SessionGet

func (*CustomSessionsApiService) GetCustomSessions 

func (a *CustomSessionsApiService) GetCustomSessions(ctx context.Context, requestId string) (Sessions, *http.Response, error)

CustomSessionsApiService List All Custom Session of a Deployment List all custom sessions of a deployment.

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

@return Sessions

func (*CustomSessionsApiService) PatchCustomSession 

func (a *CustomSessionsApiService) PatchCustomSession(ctx context.Context, customId string, requestId string, payload CustomSessionModel) (SessionGet, *http.Response, error)

CustomSessionsApiService Update a Custom Session Update a custom session with new specifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customId Custom ID Managed by you
  • @param requestId Deployment Request ID
  • @param payload

@return SessionGet

func (*CustomSessionsApiService) PostCustomSession 

func (a *CustomSessionsApiService) PostCustomSession(ctx context.Context, customId string, requestId string, payload CustomSessionModel) (SessionRequest, *http.Response, error)

CustomSessionsApiService Create a New Custom Session Create a custom session with users. You must specify a custom ID and a deployment request ID.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customId Custom ID Managed by you
  • @param requestId Deployment Request ID
  • @param payload

@return SessionRequest

func (*CustomSessionsApiService) PostCustomSessions 

func (a *CustomSessionsApiService) PostCustomSessions(ctx context.Context, requestId string, payload CustomBulkSessionsModel) (BulkSessionPost, *http.Response, error)

CustomSessionsApiService Create Custom Sessions in Bulk Create multiple custom sessions in a deployment. You must specify a custom ID for each.

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

@return BulkSessionPost

type Delete 

type Delete struct {
	// A message depending of the request termination
	Message string `json:"message"`
	// The status/summary of the deployment
	DeploymentSummary *Status `json:"deployment_summary,omitempty"`
}

type DeleteRequestReceived 

type DeleteRequestReceived struct {
	// Message to confirm that the delete request has been received
	Message string `json:"message"`
}

type DeployEnvModel 

type DeployEnvModel struct {
	// The Key to retrieve the value in your instance
	Key string `json:"key"`
	// The value to set in your instance
	Value string `json:"value"`
	// If set to true, the value will be encrypted during the process of deployment
	IsHidden bool `json:"is_hidden,omitempty"`
}

type DeployModel 

type DeployModel struct {
	// The name of the App you want to deploy
	AppName string `json:"app_name"`
	// The name of the App Version you want to deploy, if not present, the last version created is picked
	VersionName string `json:"version_name,omitempty"`
	// If the Application is public or private. If not specified, we will look for a private Application
	IsPublicApp bool `json:"is_public_app,omitempty"`
	// The List of IP of your user
	IpList []string `json:"ip_list,omitempty"`
	// The list of IP of your user with their location (latitude, longitude)
	GeoIpList                []GeoIpListModel `json:"geo_ip_list,omitempty"`
	TelemetryProfileUuidList []string         `json:"telemetry_profile_uuid_list,omitempty"`
	// A list of deployment variables
	EnvVars []DeployEnvModel `json:"env_vars,omitempty"`
	// If you want to skip the Telemetry and use a geolocations decision only
	SkipTelemetry bool `json:"skip_telemetry,omitempty"`
	// If you want to specify a centroid for your deployment.
	Location *LocationModel `json:"location,omitempty"`
	// DEPRECATED - See `filters` instead.
	City string `json:"city,omitempty"`
	// DEPRECATED - See `filters` instead.
	Country string `json:"country,omitempty"`
	// DEPRECATED - See `filters` instead.
	Continent string `json:"continent,omitempty"`
	// DEPRECATED - See `filters` instead.
	Region string `json:"region,omitempty"`
	// DEPRECATED - See `filters` instead.
	AdministrativeDivision string `json:"administrative_division,omitempty"`
	// A web URL. This url will be called with method POST. The deployment status will be send in JSON format
	WebhookUrl string `json:"webhook_url,omitempty"`
	// The list of tags for your deployment
	Tags []string `json:"tags,omitempty"`
	// The container log storage options for the deployment
	ContainerLogStorage *ContainerLogStorageModel `json:"container_log_storage,omitempty"`
	// Filters to use while choosing the deployment location.
	Filters []ApiModelDeploymentfilter `json:"filters,omitempty"`
	// Algorithm used to select the edge location
	ApSortStrategy string `json:"ap_sort_strategy,omitempty"`
}

type Deployment 

type Deployment struct {
	// Unique UUID
	RequestId string `json:"request_id"`
	// The public IP
	PublicIp string `json:"public_ip"`
	// Current status of Deployment
	Status string `json:"status"`
	// if the deployment is ready
	Ready bool `json:"ready"`
	// if the deployment ACL is active
	WhitelistingActive bool `json:"whitelisting_active"`
	//
	Fqdn  string                 `json:"fqdn"`
	Ports map[string]PortMapping `json:"ports,omitempty"`
	// Location related information
	Location *DeploymentLocation `json:"location,omitempty"`
	// List of tags associated with the deployment
	Tags []string `json:"tags,omitempty"`
	// The Capacity of the Deployment
	Sockets int32 `json:"sockets,omitempty"`
	// The Capacity Usage of the Deployment
	SocketsUsage int32 `json:"sockets_usage,omitempty"`
	// If the deployment is joinable by sessions
	IsJoinableBySession bool `json:"is_joinable_by_session,omitempty"`
}

type DeploymentBulkStopFiltersPayload 

type DeploymentBulkStopFiltersPayload struct {
	// The field on which to apply the filter
	Field string `json:"field"`
	// Values that will be used for the filter
	Values []string `json:"values"`
	// Types of filter used. Possible values are: ['any', 'all', 'not']
	FilterType string `json:"filter_type"`
}

type DeploymentBulkStopPayload 

type DeploymentBulkStopPayload struct {
	// Filters used to match with deployments
	Filters []DeploymentBulkStopFiltersPayload `json:"filters"`
}

type DeploymentBulkStopResponse 

type DeploymentBulkStopResponse struct {
	// A list deployments that can be processed to be stopped
	Processable []DeploymentStopResponse `json:"processable"`
}

type DeploymentListData 

type DeploymentListData struct {
	// Unique UUID
	RequestId string `json:"request_id"`
	// The FQDN that allow to connect to your deployment
	Fqdn string `json:"fqdn"`
	// Timestamp of the deployment when it is up and running
	StartTime string `json:"start_time"`
	// If the deployment is ready
	Ready bool `json:"ready"`
	// The public IP
	PublicIp string                 `json:"public_ip"`
	Ports    map[string]PortMapping `json:"ports,omitempty"`
	// List of tags associated with the deployment
	Tags []string `json:"tags,omitempty"`
	// The capacity of the deployment
	Sockets int32 `json:"sockets,omitempty"`
	// The capacity usage of the deployment
	SocketsUsage int32 `json:"sockets_usage,omitempty"`
	// If the deployment is joinable by sessions
	IsJoinableBySession bool `json:"is_joinable_by_session,omitempty"`
}

type DeploymentLocation 

type DeploymentLocation struct {
	// City of the deployment
	City string `json:"city"`
	// Country of the deployment
	Country string `json:"country"`
	// Continent of the deployment
	Continent string `json:"continent"`
	// Administrative division of the deployment
	AdministrativeDivision string `json:"administrative_division"`
	// Timezone of the deployment
	Timezone string `json:"timezone"`
	// Latitude of the deployment
	Latitude float32 `json:"latitude"`
	// Longitude of the deployment
	Longitude float32 `json:"longitude"`
}

type DeploymentSessionContext 

type DeploymentSessionContext struct {
	// Unique UUID
	SessionId string `json:"session_id"`
	// Current status of the session
	Status string `json:"status"`
	// If the session is linked to a Ready deployment
	Ready bool `json:"ready"`
	// If the session is linked to a deployment
	Linked bool `json:"linked"`
	// Type of session created
	Kind string `json:"kind"`
	// Count of user this session currently have
	UserCount int32 `json:"user_count"`
}

type DeploymentStopResponse 

type DeploymentStopResponse struct {
	// The id of the request for a deployment
	RequestId string `json:"request_id"`
}

type DeploymentTagListResponse 

type DeploymentTagListResponse struct {
	Tags       []DeploymentTagResponse `json:"tags,omitempty"`
	Count      int32                   `json:"count,omitempty"`
	Pagination interface{}             `json:"pagination,omitempty"`
}

type DeploymentTagPayload 

type DeploymentTagPayload struct {
	// The name of the tag
	Name string `json:"name"`
}

type DeploymentTagResponse 

type DeploymentTagResponse struct {
	// The name of the tag
	Name string `json:"name"`
	// UTC time of policy creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of policy last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type DeploymentTagsApiService 

type DeploymentTagsApiService service

func (*DeploymentTagsApiService) DeploymentsTagsCreate 

func (a *DeploymentTagsApiService) DeploymentsTagsCreate(ctx context.Context, requestId string, payload DeploymentTagPayload) (DeploymentTagResponse, *http.Response, error)

DeploymentTagsApiService Create Tag for a Deployment Create a tag for a deployment. The tag will however not be injected into a running container.

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

@return DeploymentTagResponse

func (*DeploymentTagsApiService) DeploymentsTagsDelete 

func (a *DeploymentTagsApiService) DeploymentsTagsDelete(ctx context.Context, requestId string, tagName string) (*http.Response, error)

DeploymentTagsApiService Delete Tag for a Deployment Delete a tag for a deployment. The tag will however not be removed from the environment of a running container.

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

func (*DeploymentTagsApiService) DeploymentsTagsList 

func (a *DeploymentTagsApiService) DeploymentsTagsList(ctx context.Context, requestId string) (DeploymentTagListResponse, *http.Response, error)

DeploymentTagsApiService List tags for a Deployment List tags for a deployment.

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

@return DeploymentTagListResponse

func (*DeploymentTagsApiService) DeploymentsTagsRead 

func (a *DeploymentTagsApiService) DeploymentsTagsRead(ctx context.Context, requestId string, tagName string) (DeploymentTagResponse, *http.Response, error)

DeploymentTagsApiService Get tag for a Deployment Get tag for a deployment.

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

@return DeploymentTagResponse

func (*DeploymentTagsApiService) DeploymentsTagsUpdate 

func (a *DeploymentTagsApiService) DeploymentsTagsUpdate(ctx context.Context, requestId string, tagName string, payload DeploymentTagPayload) (DeploymentTagResponse, *http.Response, error)

DeploymentTagsApiService Update Tag for a Deployment Update a tag for a deployment.

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

@return DeploymentTagResponse

type DeploymentUpdatePayload 

type DeploymentUpdatePayload struct {
	// Whether a session can connect to this deployment or not.
	IsJoinableBySession bool `json:"is_joinable_by_session,omitempty"`
}

type DeploymentUpdateResponse 

type DeploymentUpdateResponse struct {
	// If the deployment is joinable by sessions
	IsJoinableBySession bool `json:"is_joinable_by_session"`
}

type Deployments 

type Deployments struct {
	// List of active deployments
	Data []DeploymentListData `json:"data,omitempty"`
	// Total Objects in the Database
	TotalCount int32 `json:"total_count,omitempty"`
	// Pagination Object
	Pagination *Pagination `json:"pagination,omitempty"`
	// Extra Messages for the query
	Message []string `json:"message,omitempty"`
}

type DeploymentsApiDeploymentDeleteOpts 

type DeploymentsApiDeploymentDeleteOpts struct {
	ContainerLogStorage optional.String
}

type DeploymentsApiSelfDeploymentDeleteOpts 

type DeploymentsApiSelfDeploymentDeleteOpts struct {
	ContainerLogStorage optional.String
}

type DeploymentsApiService 

type DeploymentsApiService service

func (*DeploymentsApiService) Deploy 

func (a *DeploymentsApiService) Deploy(ctx context.Context, payload DeployModel) (Request, *http.Response, error)

DeploymentsApiService Create a Deployment Create a new deployment. Deployment is a server instance of your application version.

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

@return Request

func (*DeploymentsApiService) DeploymentDelete 

func (a *DeploymentsApiService) DeploymentDelete(ctx context.Context, requestId string, localVarOptionals *DeploymentsApiDeploymentDeleteOpts) (Delete, *http.Response, error)

func (*DeploymentsApiService) DeploymentGetLogs 

func (a *DeploymentsApiService) DeploymentGetLogs(ctx context.Context, requestId string) (ApiModelContainerlogs, *http.Response, error)

DeploymentsApiService Get Deployment Container Logs Retrieve the logs of your container. Logs are not available when your deployment is terminated. You can set up an endpoint storage to save your logs. <a target='_blank' href='https://docs.edgegap.com/docs/deployment/endpoint-storage'>Endpoint Storage Documentation</a>

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

@return ApiModelContainerlogs

func (*DeploymentsApiService) DeploymentStatusGet 

func (a *DeploymentsApiService) DeploymentStatusGet(ctx context.Context, requestId string) (Status, *http.Response, error)

DeploymentsApiService Get a Deployment Status and Information Retrieve the information for a deployment.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param requestId Unique Identifier to keep track of your request across all Arbitrium ecosystem. It's included in the response of the app deploy, example: 93924761ccde

@return Status

func (*DeploymentsApiService) DeploymentUpdate 

func (a *DeploymentsApiService) DeploymentUpdate(ctx context.Context, requestId string, payload DeploymentUpdatePayload) (DeploymentUpdateResponse, *http.Response, error)

DeploymentsApiService Updates properties of a deployment Updates properties of a deployment. Currently only the `is_joinable_by_session` property can be updated.

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

@return DeploymentUpdateResponse

func (*DeploymentsApiService) DeploymentsBulkDelete 

func (a *DeploymentsApiService) DeploymentsBulkDelete(ctx context.Context, payload DeploymentBulkStopPayload) (DeploymentBulkStopResponse, *http.Response, error)

DeploymentsApiService Delete Deployments in Bulk Make a bulk delete of deployments using filters. All the deployments matching the given filters will be permanently deleted.

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

@return DeploymentBulkStopResponse

func (*DeploymentsApiService) DeploymentsGet 

func (a *DeploymentsApiService) DeploymentsGet(ctx context.Context) (Deployments, *http.Response, error)

DeploymentsApiService List All Deployments List all deployments.

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

@return Deployments

func (*DeploymentsApiService) SelfDeploymentDelete 

func (a *DeploymentsApiService) SelfDeploymentDelete(ctx context.Context, requestId string, accessPointId int32, authorization string, localVarOptionals *DeploymentsApiSelfDeploymentDeleteOpts) (Delete, *http.Response, error)

type EndpointStorageApiEndpointsListOpts 

type EndpointStorageApiEndpointsListOpts struct {
	Page    optional.Int32
	Limit   optional.Int32
	XFields optional.String
}

type EndpointStorageApiPullProfileListOpts 

type EndpointStorageApiPullProfileListOpts struct {
	Page  optional.Int32
	Limit optional.Int32
}

type EndpointStorageApiService 

type EndpointStorageApiService service

func (*EndpointStorageApiService) EndpointCreate 

func (a *EndpointStorageApiService) EndpointCreate(ctx context.Context, payload EndpointStoragePostPayload) (EndpointStoragePostResponse, *http.Response, error)

EndpointStorageApiService Create a New Endpoint Storage Create an endpoint storage to store your container logs at the end of a deployment.

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

@return EndpointStoragePostResponse

func (*EndpointStorageApiService) EndpointDelete 

func (a *EndpointStorageApiService) EndpointDelete(ctx context.Context, endpointName string) (EndpointStorageDeleteResponse, *http.Response, error)

EndpointStorageApiService Delete an Endpoint Storage Delete an endpoint storage. All the application versions linked to it won't be able to store logs anymore.

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

@return EndpointStorageDeleteResponse

func (*EndpointStorageApiService) EndpointGet 

func (a *EndpointStorageApiService) EndpointGet(ctx context.Context, endpointName string) (EndpointStorageGetResponse, *http.Response, error)

EndpointStorageApiService Get an Endpoint Storage Retrieve an endpoint storage. The ```secret_access_key``` won't be displayed.

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

@return EndpointStorageGetResponse

func (*EndpointStorageApiService) EndpointUpdate 

func (a *EndpointStorageApiService) EndpointUpdate(ctx context.Context, endpointName string, payload EndpointStoragePatchPayload) (EndpointStoragePatchResponse, *http.Response, error)

EndpointStorageApiService Update an Endpoint Storage Update an Endpoint Storage with new specifications.

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

@return EndpointStoragePatchResponse

func (*EndpointStorageApiService) EndpointsList 

func (a *EndpointStorageApiService) EndpointsList(ctx context.Context, localVarOptionals *EndpointStorageApiEndpointsListOpts) (EndpointStorageListResponse, *http.Response, error)

func (*EndpointStorageApiService) PullProfileCreate 

func (a *EndpointStorageApiService) PullProfileCreate(ctx context.Context, endpointName string, payload PullProfilePostPayload) (PullProfilePostResponse, *http.Response, error)

EndpointStorageApiService Create a New Pull Profile Create a pull profile. Pull profile will upload data from an endpoint storage to a deployment container on boot. You must link the application version to the pull profile first.

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

@return PullProfilePostResponse

func (*EndpointStorageApiService) PullProfileDelete 

func (a *EndpointStorageApiService) PullProfileDelete(ctx context.Context, endpointName string, pullProfileName string) (*http.Response, error)

EndpointStorageApiService Delete a Pull Profile Delete a pull profile. All the application versions linked won't receive the data upload anymore. It will not delete your endpoint storage.

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

func (*EndpointStorageApiService) PullProfileGet 

func (a *EndpointStorageApiService) PullProfileGet(ctx context.Context, endpointName string, pullProfileName string) (PullProfileGetResponse, *http.Response, error)

EndpointStorageApiService Get a Pull Profile Retrieve a pull profile and its specifications.

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

@return PullProfileGetResponse

func (*EndpointStorageApiService) PullProfileLinkAppVersion 

func (a *EndpointStorageApiService) PullProfileLinkAppVersion(ctx context.Context, endpointName string, pullProfileName string, appName string, versionName string) (PullProfileAppVersionLinkResponse, *http.Response, error)

EndpointStorageApiService Link a Pull Profile to an Application Version Link a pull profile to an app version. Without a link, the pull profile by itself will do nothing.

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

@return PullProfileAppVersionLinkResponse

func (*EndpointStorageApiService) PullProfileList 

func (a *EndpointStorageApiService) PullProfileList(ctx context.Context, endpointName string, localVarOptionals *EndpointStorageApiPullProfileListOpts) (PullProfilesListResponse, *http.Response, error)

func (*EndpointStorageApiService) PullProfileUnlinkAppVersion 

func (a *EndpointStorageApiService) PullProfileUnlinkAppVersion(ctx context.Context, endpointName string, pullProfileName string, appName string, versionName string) (*http.Response, error)

EndpointStorageApiService Unlink a Pull Profile From an Application Version Unlink a pull profile from an app version. It will not delete the pull profile.

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

func (*EndpointStorageApiService) PullProfileUpdate 

func (a *EndpointStorageApiService) PullProfileUpdate(ctx context.Context, endpointName string, pullProfileName string, payload PullProfilePatchPayload) (PulloProfilePatchResponse, *http.Response, error)

EndpointStorageApiService Update a Pull Profile Update a pull profile with new specifications.

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

@return PulloProfilePatchResponse

type EndpointStorageDeleteResponse 

type EndpointStorageDeleteResponse struct {
	// Success Message
	Message string `json:"message"`
}

type EndpointStorageGetResponse 

type EndpointStorageGetResponse struct {
	// Name of the Endpoint Storage
	Name string `json:"name"`
	// Your access key ID to connect to your S3 Bucket.
	AccessKeyId string `json:"access_key_id"`
	// Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain
	Endpoint string `json:"endpoint"`
	// Your secret access key to connect to your S3 Bucket. Will be encrypted.
	Bucket string `json:"bucket"`
	// UTC time of endpoint storage creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of endpoint storage last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type EndpointStorageListResponse 

type EndpointStorageListResponse struct {
	Endpoints []EndpointStorageGetResponse `json:"endpoints,omitempty"`
	// Pagination Object
	Pagination *Pagination `json:"pagination,omitempty"`
}

type EndpointStoragePatchPayload 

type EndpointStoragePatchPayload struct {
	// Name of the Endpoint Storage
	Name string `json:"name,omitempty"`
	// Your access key ID to connect to your S3 Bucket.
	AccessKeyId string `json:"access_key_id,omitempty"`
	// Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain
	Endpoint string `json:"endpoint,omitempty"`
	// Your secret access key to connect to your S3 Bucket. Will be encrypted.
	Bucket string `json:"bucket,omitempty"`
	// Your secret access key to connect to your S3 Bucket. Will be encrypted.
	SecretAccessKey string `json:"secret_access_key,omitempty"`
}

type EndpointStoragePatchResponse 

type EndpointStoragePatchResponse struct {
	// Name of the Endpoint Storage
	Name string `json:"name,omitempty"`
	// Your access key ID to connect to your S3 Bucket.
	AccessKeyId string `json:"access_key_id,omitempty"`
	// Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain
	Endpoint string `json:"endpoint,omitempty"`
	// Your secret access key to connect to your S3 Bucket. Will be encrypted.
	Bucket string `json:"bucket,omitempty"`
	// UTC time of endpoint storage creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of endpoint storage last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type EndpointStoragePostPayload 

type EndpointStoragePostPayload struct {
	// Name of the Endpoint Storage
	Name string `json:"name"`
	// Your access key ID to connect to your S3 Bucket.
	AccessKeyId string `json:"access_key_id"`
	// Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain
	Endpoint string `json:"endpoint"`
	// Your secret access key to connect to your S3 Bucket. Will be encrypted.
	Bucket string `json:"bucket"`
	// Your secret access key to connect to your S3 Bucket. Will be encrypted.
	SecretAccessKey string `json:"secret_access_key"`
}

type EndpointStoragePostResponse 

type EndpointStoragePostResponse struct {
	// Name of the Endpoint Storage
	Name string `json:"name"`
	// Your access key ID to connect to your S3 Bucket.
	AccessKeyId string `json:"access_key_id"`
	// Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain
	Endpoint string `json:"endpoint"`
	// Your secret access key to connect to your S3 Bucket. Will be encrypted.
	Bucket string `json:"bucket"`
	// UTC time of endpoint creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of endpoint last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type FleetDeleteResponse 

type FleetDeleteResponse struct {
	// Success Message
	Message string `json:"message"`
}

type FleetGetResponse 

type FleetGetResponse struct {
	// Name of the Fleet
	Name string `json:"name"`
	// If the Fleet is enabled. Defaults to false.
	Enabled bool `json:"enabled,omitempty"`
	// UTC time of fleet creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of fleet last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type FleetList 

type FleetList struct {
	// List of Fleets
	Fleets []FleetGetResponse `json:"fleets,omitempty"`
	// Pagination Object
	Pagination *Pagination `json:"pagination,omitempty"`
}

type FleetPatchPayload 

type FleetPatchPayload struct {
	// Name of the Fleet
	Name string `json:"name,omitempty"`
	// If the Fleet is enabled
	Enabled bool `json:"enabled,omitempty"`
}

type FleetPatchResponse 

type FleetPatchResponse struct {
	// Name of the Fleet
	Name string `json:"name,omitempty"`
	// If the Fleet is enabled
	Enabled bool `json:"enabled,omitempty"`
	// UTC time of fleet creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of fleet last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type FleetPoliciesGetResponse 

type FleetPoliciesGetResponse struct {
	// Name of the Policy
	Name string `json:"name"`
	// If the Policy is enabled. Defaults to true.
	Enabled bool `json:"enabled"`
	// Type of the Policy. See our documentation for more information on the type and it's data.
	Type_ string `json:"type"`
	// Minimum deployments at all time
	Minimum int32 `json:"minimum"`
	// Maximum deployments for the provided type.
	Maximum int32 `json:"maximum"`
	// Based on the number of sockets connected, how filled should a session deployment be before initiating a scale-up deployment. Float between 0.1 and 1.
	Threshold float32 `json:"threshold"`
	// JSON object for your filters. See our documentation for more information.
	Data interface{} `json:"data"`
	// UTC time of policy creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of policy last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type FleetPoliciesPatchPayload 

type FleetPoliciesPatchPayload struct {
	// Name of the Policy
	Name string `json:"name,omitempty"`
	// If the Policy is enabled. Defaults to true.
	Enabled bool `json:"enabled,omitempty"`
	// Type of the Policy. See our documentation for more information on the type and it's data.
	Type_ string `json:"type,omitempty"`
	// Minimum deployments at all time
	Minimum int32 `json:"minimum,omitempty"`
	// Maximum deployments for the provided type.
	Maximum int32 `json:"maximum,omitempty"`
	// Based on the number of sockets connected, how filled should a session deployment be before initiating a scale-up deployment. Float between 0.1 and 1.
	Threshold float32 `json:"threshold,omitempty"`
	// JSON object for your filters. See our documentation for more information.
	Data interface{} `json:"data,omitempty"`
	// UTC time of policy creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of policy last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type FleetPoliciesPostPayload 

type FleetPoliciesPostPayload struct {
	// Name of the Policy
	Name string `json:"name"`
	// If the Policy is enabled. Defaults to true.
	Enabled bool `json:"enabled"`
	// Type of the Policy. See our documentation for more information on the type and it's data.
	Type_ string `json:"type"`
	// Minimum deployments at all time
	Minimum int32 `json:"minimum"`
	// Maximum deployments for the provided type.
	Maximum int32 `json:"maximum"`
	// Based on the number of sockets connected, how filled should a session deployment be before initiating a scale-up deployment. Float between 0.1 and 1.
	Threshold float32 `json:"threshold"`
	// JSON object for your filters. See our documentation for more information.
	Data interface{} `json:"data"`
}

type FleetPoliciesPostResponse 

type FleetPoliciesPostResponse struct {
	// Name of the Policy
	Name string `json:"name"`
	// If the Policy is enabled. Defaults to true.
	Enabled bool `json:"enabled"`
	// Type of the Policy. See our documentation for more information on the type and it's data.
	Type_ string `json:"type"`
	// Minimum deployments at all time
	Minimum int32 `json:"minimum"`
	// Maximum deployments for the provided type.
	Maximum int32 `json:"maximum"`
	// Based on the number of sockets connected, how filled should a session deployment be before initiating a scale-up deployment. Float between 0.1 and 1.
	Threshold float32 `json:"threshold"`
	// JSON object for your filters. See our documentation for more information.
	Data interface{} `json:"data"`
	// UTC time of policy creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of policy last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type FleetPostPayload 

type FleetPostPayload struct {
	// Name of the Fleet
	Name string `json:"name"`
	// If the Fleet is enabled. Defaults to false.
	Enabled bool `json:"enabled,omitempty"`
}

type FleetPostResponse 

type FleetPostResponse struct {
	// Name of the Fleet
	Name string `json:"name"`
	// If the Fleet is enabled. Defaults to false.
	Enabled bool `json:"enabled,omitempty"`
	// UTC time of fleet creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of fleet last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type FleetsApiFleetPoliciesListOpts 

type FleetsApiFleetPoliciesListOpts struct {
	Page    optional.Int32
	Limit   optional.Int32
	XFields optional.String
}

type FleetsApiFleetsOpts 

type FleetsApiFleetsOpts struct {
	Page  optional.Int32
	Limit optional.Int32
}

type FleetsApiService 

type FleetsApiService service

func (*FleetsApiService) FleetCreate 

func (a *FleetsApiService) FleetCreate(ctx context.Context, payload FleetPostPayload) (FleetPostResponse, *http.Response, error)

FleetsApiService Create a Fleet Create a fleet. A fleet is a top-level object; you must create child resources to work properly.

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

@return FleetPostResponse

func (*FleetsApiService) FleetDelete 

func (a *FleetsApiService) FleetDelete(ctx context.Context, fleetName string) (FleetDeleteResponse, *http.Response, error)

FleetsApiService Delete a Fleet Delete a fleet, its policies and links between the application versions.

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

@return FleetDeleteResponse

func (*FleetsApiService) FleetGet 

func (a *FleetsApiService) FleetGet(ctx context.Context, fleetName string) (FleetGetResponse, *http.Response, error)

FleetsApiService Get a Fleet Retrieve a fleet with its details.

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

@return FleetGetResponse

func (*FleetsApiService) FleetLinkAppVersion 

func (a *FleetsApiService) FleetLinkAppVersion(ctx context.Context, fleetName string, appName string, versionName string) (HorizontalScalerAppVersionLink, *http.Response, error)

FleetsApiService Link an Application Version to a Fleet Link an application version to a fleet. By linking this version, the fleet will automatically create deployments of this version according to the fleet policies.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fleetName The name of the fleet
  • @param appName The name of the application to link
  • @param versionName The name of the application version to link

@return HorizontalScalerAppVersionLink

func (*FleetsApiService) FleetPoliciesCreate 

func (a *FleetsApiService) FleetPoliciesCreate(ctx context.Context, fleetName string, payload FleetPoliciesPostPayload) (FleetPoliciesPostResponse, *http.Response, error)

FleetsApiService Create a Fleet Policy Create a fleet policy. Policies are conditions that the fleet must respect.

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

@return FleetPoliciesPostResponse

func (*FleetsApiService) FleetPoliciesDelete 

func (a *FleetsApiService) FleetPoliciesDelete(ctx context.Context, fleetName string, policyName string) (*http.Response, error)

FleetsApiService Delete a Policy Delete a policy. It will not delete the fleet.

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

func (*FleetsApiService) FleetPoliciesGet 

func (a *FleetsApiService) FleetPoliciesGet(ctx context.Context, fleetName string, policyName string) (FleetPoliciesGetResponse, *http.Response, error)

FleetsApiService Get a Policy Retrieve a specific policy of a fleet.

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

@return FleetPoliciesGetResponse

func (*FleetsApiService) FleetPoliciesList 

func (a *FleetsApiService) FleetPoliciesList(ctx context.Context, fleetName string, localVarOptionals *FleetsApiFleetPoliciesListOpts) (HorizontalScalerConstraintList, *http.Response, error)

func (*FleetsApiService) FleetPoliciesUpdate 

func (a *FleetsApiService) FleetPoliciesUpdate(ctx context.Context, fleetName string, policyName string, payload FleetPoliciesPatchPayload) (FleetPoliciesPatchPayload, *http.Response, error)

FleetsApiService Update a Policy Update a policy with new specifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fleetName The name of the fleet
  • @param policyName The name of the policy
  • @param payload

@return FleetPoliciesPatchPayload

func (*FleetsApiService) FleetUnlinkAppVersion 

func (a *FleetsApiService) FleetUnlinkAppVersion(ctx context.Context, fleetName string, appName string, versionName string) (*http.Response, error)

FleetsApiService Unlink an Application Version From a Fleet Unlink an application version from a fleet. It will not delete the application version or the fleet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fleetName The name of the fleet
  • @param appName The name of the application to link
  • @param versionName The name of the application version to link

func (*FleetsApiService) FleetUpdate 

func (a *FleetsApiService) FleetUpdate(ctx context.Context, fleetName string, payload FleetPatchPayload) (FleetPatchResponse, *http.Response, error)

FleetsApiService Update a Fleet Update a fleet with new specifications.

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

@return FleetPatchResponse

func (*FleetsApiService) Fleets 

func (a *FleetsApiService) Fleets(ctx context.Context, localVarOptionals *FleetsApiFleetsOpts) (FleetList, *http.Response, error)

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 GeoIpListModel 

type GeoIpListModel struct {
	// IP
	Ip string `json:"ip"`
	// Latitude
	Latitude float32 `json:"latitude"`
	// Longitude
	Longitude float32 `json:"longitude"`
}
type HorizontalScalerAppVersionLink struct {
	// Name of the linked app of the linked version
	App string `json:"app"`
	// Name of the linked app version.
	AppVersion string `json:"app_version"`
	// Name of the fleet the app version is linked to.
	Fleet string `json:"fleet"`
	// UTC time of link creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of link last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type HorizontalScalerConstraintList 

type HorizontalScalerConstraintList struct {
	Policies []FleetPoliciesGetResponse `json:"policies,omitempty"`
	// Pagination Object
	Pagination *Pagination `json:"pagination,omitempty"`
}

type IPLookupApiService 

type IPLookupApiService service

func (*IPLookupApiService) IP 

func (a *IPLookupApiService) IP(ctx context.Context) (IpAddressResponse, *http.Response, error)

IPLookupApiService Get Your Public IP Retrieve your public IP address.

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

@return IpAddressResponse

func (*IPLookupApiService) IPLookup 

func (a *IPLookupApiService) IPLookup(ctx context.Context, ip string) (IpAddressLookupResponse, *http.Response, error)

IPLookupApiService Get an IP's information Lookup an IP address and return the associated information.

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

@return IpAddressLookupResponse

func (*IPLookupApiService) IPsLookup 

func (a *IPLookupApiService) IPsLookup(ctx context.Context, payload IpAddressesLookupPayload) (IpAddressesLookupResponse, *http.Response, error)

IPLookupApiService Get IPs Information in Bulk Lookup IP addresses and return the associated information. Maximum of 20 IPs.

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

@return IpAddressesLookupResponse

type IpAddressLookupLocation 

type IpAddressLookupLocation struct {
	Continent *IpAddressLookupLocationContinent `json:"continent,omitempty"`
	Country   *IpAddressLookupLocationCountry   `json:"country,omitempty"`
	// Latitude
	Latitude float32 `json:"latitude,omitempty"`
	// Longitude
	Longitude float32 `json:"longitude,omitempty"`
}

type IpAddressLookupLocationContinent 

type IpAddressLookupLocationContinent struct {
	// Continent code
	Code string `json:"code,omitempty"`
	// Continent name
	Name string `json:"name,omitempty"`
}

type IpAddressLookupLocationCountry 

type IpAddressLookupLocationCountry struct {
	// Country code
	Code string `json:"code,omitempty"`
	// Country name
	Name string `json:"name,omitempty"`
}

type IpAddressLookupResponse 

type IpAddressLookupResponse struct {
	// IP address type
	Type_ string `json:"type,omitempty"`
	// IP address
	IpAddress string                   `json:"ip_address"`
	Location  *IpAddressLookupLocation `json:"location,omitempty"`
}

type IpAddressResponse 

type IpAddressResponse struct {
	// Public IP Address
	PublicIp string `json:"public_ip"`
}

type IpAddressesLookupPayload 

type IpAddressesLookupPayload struct {
	// IP Addresses
	Addresses []string `json:"addresses"`
}

type IpAddressesLookupResponse 

type IpAddressesLookupResponse struct {
	// IP Addresses
	Addresses []IpAddressLookupResponse `json:"addresses"`
}

type LobbiesApiService 

type LobbiesApiService service

func (*LobbiesApiService) LobbyCreate 

func (a *LobbiesApiService) LobbyCreate(ctx context.Context, payload LobbyCreatePayload) (LobbyReadResponse, *http.Response, error)

LobbiesApiService Create a Lobby Create a named lobby.

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

@return LobbyReadResponse

func (*LobbiesApiService) LobbyDeploy 

func (a *LobbiesApiService) LobbyDeploy(ctx context.Context, payload LobbyDeployPayload) (LobbyReadResponse, *http.Response, error)

LobbiesApiService Deploy a Lobby Deploy the lobby with the given name.

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

@return LobbyReadResponse

func (*LobbiesApiService) LobbyGet 

func (a *LobbiesApiService) LobbyGet(ctx context.Context, lobbyName string) (LobbyReadResponse, *http.Response, error)

LobbiesApiService Get a Lobby Get a named lobby.

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

@return LobbyReadResponse

func (*LobbiesApiService) LobbyTerminate 

func (a *LobbiesApiService) LobbyTerminate(ctx context.Context, payload LobbyTerminatePayload) (LobbyReadResponse, *http.Response, error)

LobbiesApiService Terminate a Lobby Terminate the lobby with the given name.

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

@return LobbyReadResponse

type LobbyCreatePayload 

type LobbyCreatePayload struct {
	// Name of the lobby
	Name string `json:"name"`
}

type LobbyDeployPayload 

type LobbyDeployPayload struct {
	// Name of the lobby
	Name string `json:"name"`
}

type LobbyReadResponse 

type LobbyReadResponse struct {
	// Name of the lobby
	Name string `json:"name"`
	// URL of the lobby
	Url string `json:"url"`
	// Status of the lobby
	Status string `json:"status"`
}

type LobbyTerminatePayload 

type LobbyTerminatePayload struct {
	// Name of the lobby
	Name string `json:"name"`
}

type Location 

type Location struct {
	// City Name
	City string `json:"city"`
	// Continent Name
	Continent string `json:"continent"`
	// Country name
	Country string `json:"country"`
	// Timezone name
	Timezone string `json:"timezone"`
	// Administrative Division
	AdministrativeDivision string `json:"administrative_division"`
	// The Latitude in decimal
	Latitude float32 `json:"latitude"`
	// The Longitude in decimal
	Longitude float32 `json:"longitude"`
	// The type of location
	Type_ string `json:"type"`
	Tags  []Tag  `json:"tags,omitempty"`
}

type LocationBeaconList 

type LocationBeaconList struct {
	// Total number of active location beacons
	Locations []ApiModelLocationbeacon `json:"locations,omitempty"`
	// List of active location beacons
	Count int32 `json:"count,omitempty"`
}

type LocationModel 

type LocationModel struct {
	// Latitude
	Latitude float32 `json:"latitude"`
	// Longitude
	Longitude float32 `json:"longitude"`
}

type Locations 

type Locations struct {
	Locations []Location `json:"locations,omitempty"`
	// Extra Messages for the query
	Messages []string `json:"messages,omitempty"`
}

type LocationsApiLocationsGetOpts 

type LocationsApiLocationsGetOpts struct {
	App     optional.String
	Version optional.String
	Type_   optional.String
	Tags    optional.String
}

type LocationsApiService 

type LocationsApiService service

func (*LocationsApiService) LocationBeaconList 

func (a *LocationsApiService) LocationBeaconList(ctx context.Context) (LocationBeaconList, *http.Response, error)

LocationsApiService List All Location Beacons List all the active location beacons. They can be used to ping them for your matchmaking system. You cannot deploy on beacons.

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

@return LocationBeaconList

func (*LocationsApiService) LocationsGet 

func (a *LocationsApiService) LocationsGet(ctx context.Context, localVarOptionals *LocationsApiLocationsGetOpts) (Locations, *http.Response, error)

type MappedPortResponse 

type MappedPortResponse struct {
	Server *ServerRelayPort `json:"server,omitempty"`
	Client *ClientRelayPort `json:"client,omitempty"`
}

type MatchmakerApiService 

type MatchmakerApiService service

func (*MatchmakerApiService) DeleteMatchmaker 

func (a *MatchmakerApiService) DeleteMatchmaker(ctx context.Context, matchmakerName string) (*http.Response, error)

MatchmakerApiService Delete a Matchmaker Delete a matchmaker.

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

func (*MatchmakerApiService) DeleteMatchmakerComponent 

func (a *MatchmakerApiService) DeleteMatchmakerComponent(ctx context.Context, componentName string) (*http.Response, error)

MatchmakerApiService Delete a Matchmaker Component Delete a matchmaker component. It will not delete the matchmaker.

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

func (*MatchmakerApiService) DeleteMatchmakerComponentEnv 

func (a *MatchmakerApiService) DeleteMatchmakerComponentEnv(ctx context.Context, componentName string, envKey string) (*http.Response, error)

MatchmakerApiService Delete a Matchmaker Component ENV Delete a matchmaker component ENV. It will not delete the component or the matchmaker.

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

func (*MatchmakerApiService) DeleteMatchmakerManagedRelease 

func (a *MatchmakerApiService) DeleteMatchmakerManagedRelease(ctx context.Context, matchmakerName string, releaseVersion string) (*http.Response, error)

MatchmakerApiService Delete a Matchmaker Managed Release Delete a matchmaker managed release. It will not delete the matchmaker.

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

func (*MatchmakerApiService) DeleteMatchmakerRelease 

func (a *MatchmakerApiService) DeleteMatchmakerRelease(ctx context.Context, matchmakerName string, releaseVersion string) (*http.Response, error)

MatchmakerApiService Delete a Matchmaker Release Delete a matchmaker release.

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

func (*MatchmakerApiService) DeleteMatchmakerReleaseConfig 

func (a *MatchmakerApiService) DeleteMatchmakerReleaseConfig(ctx context.Context, configName string) (*http.Response, error)

MatchmakerApiService Delete a Matchmaker Release Config Delete a matchmaker release config.

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

func (*MatchmakerApiService) GetComponentList 

func (a *MatchmakerApiService) GetComponentList(ctx context.Context) (MatchmakerComponentListResponse, *http.Response, error)

MatchmakerApiService List All Matchmaker Components List all components for a specific matchmaker.

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

@return MatchmakerComponentListResponse

func (*MatchmakerApiService) GetEnvsList 

func (a *MatchmakerApiService) GetEnvsList(ctx context.Context, componentName string) (MatchmakerComponentEnvListResponse, *http.Response, error)

MatchmakerApiService List All Matchmaker Component ENVs List all ENVs for a specific matchmaker component.

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

@return MatchmakerComponentEnvListResponse

func (*MatchmakerApiService) GetMatchmaker 

func (a *MatchmakerApiService) GetMatchmaker(ctx context.Context, matchmakerName string) (MatchmakerResponse, *http.Response, error)

MatchmakerApiService Get a Matchmaker Retrieve a matchmaker.

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

@return MatchmakerResponse

func (*MatchmakerApiService) GetMatchmakerComponent 

func (a *MatchmakerApiService) GetMatchmakerComponent(ctx context.Context, componentName string) (MatchmakerComponentResponse, *http.Response, error)

MatchmakerApiService Get a Matchmaker Component Retrieve a matchmaker component.

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

@return MatchmakerComponentResponse

func (*MatchmakerApiService) GetMatchmakerComponentEnv 

func (a *MatchmakerApiService) GetMatchmakerComponentEnv(ctx context.Context, componentName string, envKey string) (MatchmakerComponentEnvsResponse, *http.Response, error)

MatchmakerApiService Get a Matchmaker Component ENV Retrieve a matchmaker component ENV.

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

@return MatchmakerComponentEnvsResponse

func (*MatchmakerApiService) GetMatchmakerList 

func (a *MatchmakerApiService) GetMatchmakerList(ctx context.Context) (MatchmakerListResponse, *http.Response, error)

MatchmakerApiService List All Matchmakers List all matchmakers.

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

@return MatchmakerListResponse

func (*MatchmakerApiService) GetMatchmakerManagedRelease 

func (a *MatchmakerApiService) GetMatchmakerManagedRelease(ctx context.Context, matchmakerName string, releaseVersion string) (MatchmakerManagedReleaseResponse, *http.Response, error)

MatchmakerApiService Get a Matchmaker Managed Release Retrieve a matchmaker managed release.

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

@return MatchmakerManagedReleaseResponse

func (*MatchmakerApiService) GetMatchmakerRelease 

func (a *MatchmakerApiService) GetMatchmakerRelease(ctx context.Context, matchmakerName string, releaseVersion string) (MatchmakerReleaseResponse, *http.Response, error)

MatchmakerApiService Get a Matchmaker Release Retrieve a matchmaker release.

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

@return MatchmakerReleaseResponse

func (*MatchmakerApiService) GetMatchmakerReleaseConfig 

func (a *MatchmakerApiService) GetMatchmakerReleaseConfig(ctx context.Context, configName string) (MatchmakerReleaseConfigResponse, *http.Response, error)

MatchmakerApiService Get a Matchmaker Release Config Get a matchmaker release config.

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

@return MatchmakerReleaseConfigResponse

func (*MatchmakerApiService) GetReleaseConfigsList 

func (a *MatchmakerApiService) GetReleaseConfigsList(ctx context.Context) (MatchmakerComponentEnvListResponse, *http.Response, error)

MatchmakerApiService List All Matchmaker Release Configs List all configs for a specific matchmaker release.

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

@return MatchmakerComponentEnvListResponse

func (*MatchmakerApiService) GetReleaseList 

func (a *MatchmakerApiService) GetReleaseList(ctx context.Context, matchmakerName string) (MatchmakerComponentEnvListResponse, *http.Response, error)

MatchmakerApiService List All Matchmaker Releases List all releases of a specific matchmaker.

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

@return MatchmakerComponentEnvListResponse

func (*MatchmakerApiService) PatchMatchmaker 

func (a *MatchmakerApiService) PatchMatchmaker(ctx context.Context, matchmakerName string, payload MatchmakerUpdate) (MatchmakerResponse, *http.Response, error)

MatchmakerApiService Update a Matchmaker Update a matchmaker with new specifications.

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

@return MatchmakerResponse

func (*MatchmakerApiService) PatchMatchmakerComponent 

func (a *MatchmakerApiService) PatchMatchmakerComponent(ctx context.Context, componentName string, payload MatchmakerComponentUpdate) (MatchmakerComponentResponse, *http.Response, error)

MatchmakerApiService Update a Matchmaker Component Update a matchmaker component with new specifications.

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

@return MatchmakerComponentResponse

func (*MatchmakerApiService) PatchMatchmakerComponentEnv 

func (a *MatchmakerApiService) PatchMatchmakerComponentEnv(ctx context.Context, componentName string, envKey string, payload MatchmakerComponentEnvsUpdate) (MatchmakerComponentEnvsResponse, *http.Response, error)

MatchmakerApiService Update a Matchmaker Component ENV Update a matchmaker component ENV.

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

@return MatchmakerComponentEnvsResponse

func (*MatchmakerApiService) PatchMatchmakerManagedRelease 

func (a *MatchmakerApiService) PatchMatchmakerManagedRelease(ctx context.Context, matchmakerName string, releaseVersion string, payload MatchmakerManagedReleaseUpdate) (MatchmakerManagedReleaseResponse, *http.Response, error)

MatchmakerApiService Update a Matchmaker Managed Release Update a matchmaker managed release.

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

@return MatchmakerManagedReleaseResponse

func (*MatchmakerApiService) PatchMatchmakerRelease 

func (a *MatchmakerApiService) PatchMatchmakerRelease(ctx context.Context, matchmakerName string, releaseVersion string, payload MatchmakerReleaseUpdate) (MatchmakerReleaseResponse, *http.Response, error)

MatchmakerApiService Update a Matchmaker Release Update a matchmaker release.

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

@return MatchmakerReleaseResponse

func (*MatchmakerApiService) PatchMatchmakerReleaseConfig 

func (a *MatchmakerApiService) PatchMatchmakerReleaseConfig(ctx context.Context, configName string, payload MatchmakerReleaseConfigUpdate) (MatchmakerReleaseConfigResponse, *http.Response, error)

MatchmakerApiService Update a Matchmaker Release Config Update a matchmaker release config.

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

@return MatchmakerReleaseConfigResponse

func (*MatchmakerApiService) PostMatchmaker 

func (a *MatchmakerApiService) PostMatchmaker(ctx context.Context, payload MatchmakerCreate) (MatchmakerResponse, *http.Response, error)

MatchmakerApiService Create a Matchmaker Create a new matchmaker. A matchmaker is a top-level object; you must create child resources to work properly.

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

@return MatchmakerResponse

func (*MatchmakerApiService) PostMatchmakerComponent 

func (a *MatchmakerApiService) PostMatchmakerComponent(ctx context.Context, payload MatchmakerComponentCreate) (MatchmakerComponentResponse, *http.Response, error)

MatchmakerApiService Create a Matchmaker Component Create a new matchmaker component.

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

@return MatchmakerComponentResponse

func (*MatchmakerApiService) PostMatchmakerComponentEnv 

func (a *MatchmakerApiService) PostMatchmakerComponentEnv(ctx context.Context, componentName string, payload MatchmakerComponentEnvsCreate) (MatchmakerComponentEnvsResponse, *http.Response, error)

MatchmakerApiService Create a Matchmaker Component ENV Create a new matchmaker component ENV.

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

@return MatchmakerComponentEnvsResponse

func (*MatchmakerApiService) PostMatchmakerManagedRelease 

func (a *MatchmakerApiService) PostMatchmakerManagedRelease(ctx context.Context, matchmakerName string, payload MatchmakerManagedReleaseCreate) (MatchmakerManagedReleaseResponse, *http.Response, error)

MatchmakerApiService Create a Matchmaker Managed Release Create a matchmaker managed release.

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

@return MatchmakerManagedReleaseResponse

func (*MatchmakerApiService) PostMatchmakerRelease 

func (a *MatchmakerApiService) PostMatchmakerRelease(ctx context.Context, matchmakerName string, payload MatchmakerReleaseCreate) (MatchmakerReleaseResponse, *http.Response, error)

MatchmakerApiService Create a Matchmaker Release Create a matchmaker release.

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

@return MatchmakerReleaseResponse

func (*MatchmakerApiService) PostMatchmakerReleaseConfig 

func (a *MatchmakerApiService) PostMatchmakerReleaseConfig(ctx context.Context, payload MatchmakerReleaseConfigCreate) (MatchmakerReleaseConfigResponse, *http.Response, error)

MatchmakerApiService Create a Matchmaker Release Config Create a matchmaker release config.

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

@return MatchmakerReleaseConfigResponse

type MatchmakerAuth added in v1.1.0 

type MatchmakerAuth struct {
	// Type of authentication used by the Front End (possible values are -> NoAuth|Token)
	Type string `json:"type"`
	// Configuration of authentication's type. (optional)
	Configuration *MatchmakerAuthConfiguration `json:"configuration"`
}

MatchmakerAuth Configuration for the authentication method of your matchmaker

type MatchmakerAuthConfiguration added in v1.1.0 

type MatchmakerAuthConfiguration struct {
	// Token used to authenticate the request. The token will be fetched from the headers at key authorization.
	//
	// Note: This is only used in Token authentication type
	Token string `json:"token"`
	// This is not used for the moment (optional)
	Key string `json:"key"`
}

MatchmakerAuthConfiguration Configuration of authentication's type. (optional)

type MatchmakerComponentCreate 

type MatchmakerComponentCreate struct {
	// Matchmaker component name. Must be unique.
	Name string `json:"name"`
	// Container repository where the component's image is hosted.
	Repository string `json:"repository"`
	// Container image to use for this component.
	Image string `json:"image"`
	// Tag of the container image to use for this component.
	Tag         string                                  `json:"tag"`
	Credentials *MatchmakerComponentResponseCredentials `json:"credentials,omitempty"`
}

type MatchmakerComponentEnvListResponse 

type MatchmakerComponentEnvListResponse struct {
	// Number of matchmaker component envs for the component.
	Count int32                             `json:"count"`
	Data  []MatchmakerComponentEnvsResponse `json:"data,omitempty"`
}

type MatchmakerComponentEnvsCreate 

type MatchmakerComponentEnvsCreate struct {
	// Name of the ENV variable.
	Key string `json:"key"`
	// Value of the ENV variable.
	Value string `json:"value"`
}

type MatchmakerComponentEnvsResponse 

type MatchmakerComponentEnvsResponse struct {
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	// Name of the ENV variable.
	Key string `json:"key"`
	// Value of the ENV variable.
	Value string `json:"value"`
}

type MatchmakerComponentEnvsUpdate 

type MatchmakerComponentEnvsUpdate struct {
	// Name of the ENV variable.
	Key string `json:"key,omitempty"`
	// Value of the ENV variable.
	Value string `json:"value,omitempty"`
}

type MatchmakerComponentListResponse 

type MatchmakerComponentListResponse struct {
	// Number of matchmaker components owned by the user.
	Count int32 `json:"count"`
	// List of the user's matchmaker components.
	Data *MatchmakerComponentResponse `json:"data"`
}

type MatchmakerComponentResponse 

type MatchmakerComponentResponse struct {
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	// Matchmaker component name. Must be unique.
	Name string `json:"name"`
	// Container repository where the component's image is hosted.
	Repository string `json:"repository"`
	// Container image to use for this component.
	Image string `json:"image"`
	// Tag of the container image to use for this component.
	Tag         string                                  `json:"tag"`
	Credentials *MatchmakerComponentResponseCredentials `json:"credentials"`
}

type MatchmakerComponentResponseCredentials 

type MatchmakerComponentResponseCredentials struct {
}

Private repo credentials to use for pulling the image, if applicable.

type MatchmakerComponentUpdate 

type MatchmakerComponentUpdate struct {
	// Matchmaker component name. Must be unique.
	Name string `json:"name,omitempty"`
	// Container repository where the component's image is hosted.
	Repository string `json:"repository,omitempty"`
	// Container image to use for this component.
	Image string `json:"image,omitempty"`
	// Tag of the container image to use for this component.
	Tag         string                                  `json:"tag,omitempty"`
	Credentials *MatchmakerComponentResponseCredentials `json:"credentials,omitempty"`
}

type MatchmakerCreate 

type MatchmakerCreate struct {
	// Name of the Matchmaker.
	Name string `json:"name"`
}

type MatchmakerFilter added in v1.1.0 

type MatchmakerFilter struct {
	// A unique ID to identify the filter
	//
	// Constraint: profile unique
	Key string `json:"key"`
	// The displayable name of the filter
	Name string `json:"name"`
	// Whether the client is required to send data for this filter.
	// If the filter is required and the player doesn't send data, it will deny the player's request.
	Required bool `json:"required"`
	// Maximum value of the range - inclusive
	Maximum float64 `json:"maximum"`
	// Minimum value of the range - inclusive
	Minimum float64 `json:"minimum"`
	// Configuration of the range
	Difference *MatchmakerFilterDifference `json:"difference"`
}

MatchmakerFilter represents range values. Only players within the same range will be matched together.

type MatchmakerFilterDifference added in v1.1.0 

type MatchmakerFilterDifference struct {
	// Negative value of the range. If the player value is 200 and the negative value is 40, he
	// can be matched with players that have a value down to 160 inclusive.
	Negative float64 `json:"negative"`
	// Positive value of the range. If the player value is 200 and the positive value is 40, he
	// can be matched with players that have a value up to 240 inclusive.
	Positive float64 `json:"positive"`
}

MatchmakerFilterDifference Configuration of the MatchmakerFilter range

type MatchmakerListResponse 

type MatchmakerListResponse struct {
	// Number of matchmakers owned by the user.
	Count int32                `json:"count"`
	Data  []MatchmakerResponse `json:"data"`
}

type MatchmakerManagedReleaseCreate 

type MatchmakerManagedReleaseCreate struct {
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version"`
	// Name of the matchmaker release configuration to use for this managed release.
	ReleaseConfigName string `json:"release_config_name"`
}

type MatchmakerManagedReleaseResponse 

type MatchmakerManagedReleaseResponse struct {
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	// Name of the app to deploy using the matchmaker.
	AppName string `json:"app_name"`
	// Name of the version of the specified app to deploy using the matchmaker.
	VersionName string `json:"version_name"`
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version"`
	// Name of the matchmaker release configuration to use for this managed release.
	ReleaseConfigName string `json:"release_config_name"`
}

type MatchmakerManagedReleaseUpdate 

type MatchmakerManagedReleaseUpdate struct {
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version,omitempty"`
	// Name of the matchmaker release configuration to use for this managed release.
	ReleaseConfigName string `json:"release_config_name,omitempty"`
}

type MatchmakerProfile added in v1.1.0 

type MatchmakerProfile struct {
	// A unique ID to identify the profile.
	//
	// Constraint: globally unique
	Id string `json:"profile_id"`
	// The displayable name of the profile
	Name string `json:"name"`
	// The arbitrium application to deploy by this profile
	App string `json:"app"`
	// The version of your application that will be deployed
	Version string `json:"version"`
	// The port name you assigned to the port in your application version, which is used by the player to connect
	GamePort string `json:"game_port"`
	// The delay in seconds before your matchmaker start
	//
	// Recommended value range: 2-10
	DelayToStart int32 `json:"delay_to_start"`
	// The time in seconds between each iteration of matchmaking.
	//
	// Recommended value range: 5-10 - Any values under 5 will be ignored
	Refresh int32 `json:"refresh"`
	// The number of player in a match
	MatchPlayerCount int32 `json:"match_player_count"`
	// Whether the values are injected into the deployment - optional
	InjectEnv bool `json:"inject_env"`
	// A list of selectors. They represent a choice between discreet values.
	// Only players with the same choices in all selectors will be matched together.
	Selectors []*MatchmakerSelector `json:"selectors"`
	// A list of range values. They represent a choice between 2 numerical values.
	// Only players within the same range will be matched together. (Only support 1 filter at the moment)
	Filters []*MatchmakerFilter `json:"filters"`
}

MatchmakerProfile A profile for your matchmaker

type MatchmakerReleaseConfig added in v1.1.0 

type MatchmakerReleaseConfig struct {
	// Configuration for the authentication method of your matchmaker
	Auth *MatchmakerAuth `json:"auth"`
	// A List of profiles for your matchmaker. (must contain at least 1 element)
	Profiles []*MatchmakerProfile `json:"profiles"`
}

MatchmakerReleaseConfig Uses a JSON/YAML configuration to configure your matchmaker, so you don't have to.

type MatchmakerReleaseConfigCreate 

type MatchmakerReleaseConfigCreate struct {
	// Matchmaker configuration name. Must be unique.
	Name string `json:"name"`
	// Matchmaker configuration, parsed as a string.
	Configuration string `json:"configuration"`
}

type MatchmakerReleaseConfigResponse 

type MatchmakerReleaseConfigResponse struct {
	CreateTime  string `json:"create_time"`
	LastUpdated string `json:"last_updated"`
	// Matchmaker configuration name. Must be unique.
	Name string `json:"name"`
	// Base Format - 0 = JSON / 1 = YAML
	BaseFormat int `json:"base_format"`
	// Base Format Label (JSON/YAML)
	BaseFormatLabel string `json:"base_format_label"`
	// Matchmaker configuration, as interface while waiting for swagger update.
	Configuration MatchmakerReleaseConfig `json:"configuration"`
}

type MatchmakerReleaseConfigUpdate 

type MatchmakerReleaseConfigUpdate struct {
	// Matchmaker configuration name. Must be unique.
	Name string `json:"name,omitempty"`
	// Matchmaker configuration, parsed as a string.
	Configuration string `json:"configuration,omitempty"`
}

type MatchmakerReleaseCreate 

type MatchmakerReleaseCreate struct {
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version"`
	// Name of the matchmaker component to use as the Open Match frontend.
	FrontendComponentName string `json:"frontend_component_name"`
	// Name of the matchmaker component to use as the Open Match director.
	DirectorComponentName string `json:"director_component_name"`
	// Name of the matchmaker component to use as the Open Match match function.
	MatchFunctionComponentName string `json:"match_function_component_name"`
}

type MatchmakerReleaseCreateBase 

type MatchmakerReleaseCreateBase struct {
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version"`
}

type MatchmakerReleaseResponse 

type MatchmakerReleaseResponse struct {
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	// Name of the app to deploy using the matchmaker.
	AppName string `json:"app_name"`
	// Name of the version of the specified app to deploy using the matchmaker.
	VersionName string `json:"version_name"`
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version"`
	// Name of the matchmaker component to use as the Open Match frontend.
	FrontendComponentName string `json:"frontend_component_name"`
	// Name of the matchmaker component to use as the Open Match director.
	DirectorComponentName string `json:"director_component_name"`
	// Name of the matchmaker component to use as the Open Match match function.
	MatchFunctionComponentName string `json:"match_function_component_name"`
}

type MatchmakerReleaseResponseBase 

type MatchmakerReleaseResponseBase struct {
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	// Name of the app to deploy using the matchmaker.
	AppName string `json:"app_name"`
	// Name of the version of the specified app to deploy using the matchmaker.
	VersionName string `json:"version_name"`
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version"`
}

type MatchmakerReleaseUpdate 

type MatchmakerReleaseUpdate struct {
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version,omitempty"`
	// Name of the matchmaker component to use as the Open Match frontend.
	FrontendComponentName string `json:"frontend_component_name,omitempty"`
	// Name of the matchmaker component to use as the Open Match director.
	DirectorComponentName string `json:"director_component_name,omitempty"`
	// Name of the matchmaker component to use as the Open Match match function.
	MatchFunctionComponentName string `json:"match_function_component_name,omitempty"`
}

type MatchmakerReleaseUpdateBase 

type MatchmakerReleaseUpdateBase struct {
	// Name of the matchmaker release. Should be unique, and will be used to differentiate your releases.
	Version string `json:"version,omitempty"`
}

type MatchmakerResponse 

type MatchmakerResponse struct {
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	// Name of the Matchmaker.
	Name string `json:"name"`
}

type MatchmakerSelector added in v1.1.0 

type MatchmakerSelector struct {
	// A unique ID to identify the selector.
	//
	// Constraint: profile unique
	Key string `json:"key"`
	// The displayable name of the selector
	Name string `json:"name"`
	// The default value for this selector - optional
	Default string `json:"default"`
	// Whether the client is required to send data for this selector.
	// If the selector is required and the player doesn't send data, it will deny the player's request.
	Required bool `json:"required"`
	// Whether the values are injected into the deployment - optional
	InjectEnv bool `json:"inject_env"`
	// A list of possible values for this selector. Must contain at least 1 element.
	Items []string `json:"items"`
}

MatchmakerSelector represents a choice between discreet values. Only players with the same choices in all selectors will be matched together.

type MatchmakerUpdate 

type MatchmakerUpdate struct {
	// Name of the Matchmaker.
	Name string `json:"name,omitempty"`
}

type MetricsApiDeploymentMetricsGetOpts 

type MetricsApiDeploymentMetricsGetOpts struct {
	StartTime optional.String
	EndTime   optional.String
	Steps     optional.String
	Raw       optional.String
}

type MetricsApiService 

type MetricsApiService service

func (*MetricsApiService) DeploymentMetricsGet 

func (a *MetricsApiService) DeploymentMetricsGet(ctx context.Context, requestId string, localVarOptionals *MetricsApiDeploymentMetricsGetOpts) (MetricsResponse, *http.Response, error)

type MetricsModel 

type MetricsModel struct {
	Labels     []string  `json:"labels,omitempty"`
	Datasets   []float32 `json:"datasets,omitempty"`
	Timestamps []string  `json:"timestamps,omitempty"`
}

type MetricsResponse 

type MetricsResponse struct {
	Total   *TotalMetricsModel   `json:"total,omitempty"`
	Cpu     *MetricsModel        `json:"cpu,omitempty"`
	Mem     *MetricsModel        `json:"mem,omitempty"`
	Network *NetworkMetricsModel `json:"network,omitempty"`
}

type ModelError 

type ModelError struct {
	// A message depending of the request termination
	Message string `json:"message"`
}

type Monitor 

type Monitor struct {
	// API Name
	Name string `json:"name"`
	// API Version
	Version string `json:"version"`
	// API Host
	Host string `json:"host"`
	// API Host URL
	HostUrl string `json:"host_url"`
	// API Swagger Specification Location
	SpecUrl string `json:"spec_url"`
	// API Messages
	Messages []string `json:"messages,omitempty"`
	// API Errors
	Errors []string `json:"errors,omitempty"`
}

type MonitoringApiService 

type MonitoringApiService service

func (*MonitoringApiService) Monitoring 

func (a *MonitoringApiService) Monitoring(ctx context.Context) (Monitor, *http.Response, error)

MonitoringApiService Monitor the API

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

@return Monitor

type NetworkMetricsModel 

type NetworkMetricsModel struct {
	Receive  *MetricsModel `json:"receive,omitempty"`
	Transmit *MetricsModel `json:"transmit,omitempty"`
}

type Pagination 

type Pagination struct {
	// Current page number
	Number int32 `json:"number,omitempty"`
	// Next page number
	NextPageNumber int32 `json:"next_page_number,omitempty"`
	// Previous page number
	PreviousPageNumber int32      `json:"previous_page_number,omitempty"`
	Paginator          *Paginator `json:"paginator,omitempty"`
	// If there is a next page
	HasNext bool `json:"has_next,omitempty"`
	// If there is a previous page
	HasPrevious bool `json:"has_previous,omitempty"`
}

type Paginator 

type Paginator struct {
	// Total pages count
	NumPages int32 `json:"num_pages,omitempty"`
}

type PatchSessionModel 

type PatchSessionModel struct {
	// The List of IP of your user, Array of String, example:     [\"162.254.103.13\",\"198.12.116.39\", \"162.254.135.39\", \"162.254.129.34\"]
	IpList []string `json:"ip_list"`
}

type Payload 

type Payload struct {
	Name string `json:"name,omitempty"`
}

type PortMapping 

type PortMapping struct {
	// The Port to Connect from Internet
	External int32 `json:"external,omitempty"`
	// The internal Port of the Container
	Internal int32 `json:"internal,omitempty"`
	// The Protocol (i.e. 'TCP')
	Protocol string `json:"protocol,omitempty"`
	// The Name of the port if given, default to internal port in string
	Name string `json:"name,omitempty"`
	// If the port require TLS Upgrade
	TlsUpgrade bool `json:"tls_upgrade,omitempty"`
	// link of the port with scheme depending of the protocol
	Link string `json:"link,omitempty"`
	// Internal Proxy Mapping
	Proxy int32 `json:"proxy,omitempty"`
}

type PullProfileAppVersionLinkResponse 

type PullProfileAppVersionLinkResponse struct {
	// Name of the linked app of the linked version
	App string `json:"app"`
	// Name of the linked app version.
	AppVersion string `json:"app_version"`
	// Name of the endpoint storage
	Endpoint string `json:"endpoint"`
	// Name of the pull profile the app version is linked to.
	PullProfile string `json:"pull_profile"`
	// UTC time of link creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of link last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type PullProfileGetResponse 

type PullProfileGetResponse struct {
	// Name of the pull profile
	Name string `json:"name"`
	// Source in the S3 bucket to fetch from
	Source string `json:"source"`
	// If the source is a File or a Directory
	SourceType string `json:"source_type"`
	// Destination path where your source will be uploaded in your container. Make sure to avoid protected destinations, such as `/etc/`, as this will prevent the files from being copied to your deployment, and will make your deployment fail. Make sure a normal user can write to the destination folder.
	Destination string `json:"destination"`
	// UTC time of pull profile creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of pull profile last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type PullProfilePatchPayload 

type PullProfilePatchPayload struct {
	// Name of the pull profile
	Name string `json:"name,omitempty"`
	// Source in the S3 bucket to fetch from
	Source string `json:"source,omitempty"`
	// If the source is a File or a Directory
	SourceType string `json:"source_type,omitempty"`
	// Destination path where your source will be uploaded in your container. Make sure to avoid protected destinations, such as `/etc/`, as this will prevent the files from being copied to your deployment, and will make your deployment fail. Make sure a normal user can write to the destination folder.
	Destination string `json:"destination,omitempty"`
}

type PullProfilePostPayload 

type PullProfilePostPayload struct {
	// Name of the pull profile
	Name string `json:"name"`
	// Source in the S3 bucket to fetch from
	Source string `json:"source"`
	// If the source is a File or a Directory
	SourceType string `json:"source_type"`
	// Destination path where your source will be uploaded in your container. Make sure to avoid protected destinations, such as `/etc/`, as this will prevent the files from being copied to your deployment, and will make your deployment fail. Make sure a normal user can write to the destination folder.
	Destination string `json:"destination"`
}

type PullProfilePostResponse 

type PullProfilePostResponse struct {
	// Name of the pull profile
	Name string `json:"name"`
	// Source in the S3 bucket to fetch from
	Source string `json:"source"`
	// If the source is a File or a Directory
	SourceType string `json:"source_type"`
	// Destination path where your source will be uploaded in your container. Make sure to avoid protected destinations, such as `/etc/`, as this will prevent the files from being copied to your deployment, and will make your deployment fail. Make sure a normal user can write to the destination folder.
	Destination string `json:"destination"`
	// UTC time of pull profile creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of pull profile last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type PullProfilesListResponse 

type PullProfilesListResponse struct {
	PullProfiles []PullProfileGetResponse `json:"pull_profiles,omitempty"`
	// Pagination Object
	Pagination *Pagination `json:"pagination,omitempty"`
}

type PulloProfilePatchResponse 

type PulloProfilePatchResponse struct {
	// Name of the pull profile
	Name string `json:"name,omitempty"`
	// Source in the S3 bucket to fetch from
	Source string `json:"source,omitempty"`
	// If the source is a File or a Directory
	SourceType string `json:"source_type,omitempty"`
	// Destination path where your source will be uploaded in your container. Make sure to avoid protected destinations, such as `/etc/`, as this will prevent the files from being copied to your deployment, and will make your deployment fail. Make sure a normal user can write to the destination folder.
	Destination string `json:"destination,omitempty"`
	// UTC time of pull profile creation
	CreateTime string `json:"create_time,omitempty"`
	// UTC time of pull profile last update
	LastUpdated string `json:"last_updated,omitempty"`
}

type RelayFilterModel 

type RelayFilterModel struct {
	// The field to filter
	Field string `json:"field"`
	// The values to filter
	Values []string `json:"values"`
	// The type of filter
	FilterType string `json:"filter_type"`
}

type RelayResponse 

type RelayResponse struct {
	// The IP Address of the relay
	Ip string `json:"ip,omitempty"`
	// The host of the relay
	Host  string              `json:"host,omitempty"`
	Ports *MappedPortResponse `json:"ports,omitempty"`
}

type RelaySessionBaseResponse 

type RelaySessionBaseResponse struct {
	// The session ID
	SessionId string `json:"session_id"`
	// The authorization token for the session
	AuthorizationToken int32 `json:"authorization_token,omitempty"`
	// The status of the session
	Status string `json:"status"`
	// If the session is ready to be used
	Ready bool `json:"ready"`
	// If the session is linked to a relay
	Linked bool `json:"linked"`
	// The error message if the session failed
	Error_ string `json:"error,omitempty"`
	// List Session Users
	SessionUsers []RelaySessionUserResponse     `json:"session_users,omitempty"`
	Relay        *RelaySessionBaseResponseRelay `json:"relay,omitempty"`
	// The webhook URL that we will call once the session is ready
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type RelaySessionBaseResponseRelay 

type RelaySessionBaseResponseRelay struct {
}

The relay details the session is linked to

type RelaySessionCreatePayload 

type RelaySessionCreatePayload struct {
	// List of IP Addresses of session users
	Users []RelaySessionUser `json:"users"`
	// List of location filters to apply to the session
	Filters []RelayFilterModel `json:"filters,omitempty"`
	// URL to send the session data to
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type RelaySessionListResponse 

type RelaySessionListResponse struct {
	// List of relay sessions
	Sessions []RelaySessionBaseResponse `json:"sessions,omitempty"`
	// Pagination Object
	Pagination *Pagination `json:"pagination,omitempty"`
}

type RelaySessionUser 

type RelaySessionUser struct {
	// IP Address of session user
	Ip string `json:"ip"`
}

type RelaySessionUserBaseResponse 

type RelaySessionUserBaseResponse struct {
	// The session ID
	SessionId string `json:"session_id"`
	// The authorization token for the session
	AuthorizationToken int32 `json:"authorization_token,omitempty"`
	// The status of the session
	Status string `json:"status"`
	// If the session is ready to be used
	Ready bool `json:"ready"`
	// If the session is linked to a relay
	Linked bool `json:"linked"`
	// The error message if the session failed
	Error_      string                                   `json:"error,omitempty"`
	SessionUser *RelaySessionUserBaseResponseSessionUser `json:"session_user,omitempty"`
	Relay       *RelaySessionBaseResponseRelay           `json:"relay,omitempty"`
	// The webhook URL that we will call once the session is ready
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type RelaySessionUserBaseResponseSessionUser 

type RelaySessionUserBaseResponseSessionUser struct {
}

List Session Users

type RelaySessionUserResponse 

type RelaySessionUserResponse struct {
	// The IP Address of the user
	IpAddress string `json:"ip_address,omitempty"`
	// The latitude of the user
	Latitude float32 `json:"latitude,omitempty"`
	// The longitude of the user
	Longitude float32 `json:"longitude,omitempty"`
	// The authorization token of the user
	AuthorizationToken int32 `json:"authorization_token,omitempty"`
}

type RelayUserAuthorizePayload 

type RelayUserAuthorizePayload struct {
	// Session Request ID (ex: 0724828881e2-S)
	SessionId string `json:"session_id"`
	// User Ip to Authorize
	UserIp string `json:"user_ip"`
}

type RelayUserRevokePayload 

type RelayUserRevokePayload struct {
	// Session Request ID (ex: 0724828881e2-S)
	SessionId string `json:"session_id"`
	// Relay Authorization Token
	AuthorizationToken int32 `json:"authorization_token"`
}

type RelaysApiService 

type RelaysApiService service

func (*RelaysApiService) RelaySessionCreate 

func (a *RelaysApiService) RelaySessionCreate(ctx context.Context, payload RelaySessionCreatePayload) (RelaySessionBaseResponse, *http.Response, error)

RelaysApiService Create a Relay Session Create a relay session with users.

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

@return RelaySessionBaseResponse

func (*RelaysApiService) RelaySessionDelete 

func (a *RelaysApiService) RelaySessionDelete(ctx context.Context, sessionId string) (*http.Response, error)

RelaysApiService Delete a Relay Session Delete a relay session.

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

func (*RelaysApiService) RelaySessionGet 

func (a *RelaysApiService) RelaySessionGet(ctx context.Context, sessionId string) (RelaySessionBaseResponse, *http.Response, error)

RelaysApiService Get a Relay Session Retrieve the information for a relay session.

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

@return RelaySessionBaseResponse

func (*RelaysApiService) RelaySessionList 

func (a *RelaysApiService) RelaySessionList(ctx context.Context) (RelaySessionListResponse, *http.Response, error)

RelaysApiService List all Relay Sessions List all the active relay sessions.

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

@return RelaySessionListResponse

func (*RelaysApiService) RelayUserAuthorize 

func (a *RelaysApiService) RelayUserAuthorize(ctx context.Context, payload RelayUserAuthorizePayload) (RelaySessionUserBaseResponse, *http.Response, error)

RelaysApiService Authorize a user on a Relay Session Authorize a user on a Relay Session

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

@return RelaySessionUserBaseResponse

func (*RelaysApiService) RelayUserRevoke 

func (a *RelaysApiService) RelayUserRevoke(ctx context.Context, payload RelayUserRevokePayload) (RelaySessionBaseResponse, *http.Response, error)

RelaysApiService Remove a user on a Relay Session Authorize a user on a Relay Session

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

@return RelaySessionBaseResponse

type Request 

type Request struct {
	// The Unique Identifier of the request
	RequestId string `json:"request_id"`
	// The URL to connect to the instance
	RequestDns string `json:"request_dns"`
	// The Name of the App you requested
	RequestApp string `json:"request_app"`
	// The name of the App Version you requested
	RequestVersion string `json:"request_version"`
	// How Many Users your request contain
	RequestUserCount int32 `json:"request_user_count"`
	// The city where the deployment is located
	City string `json:"city,omitempty"`
	// The country where the deployment is located
	Country string `json:"country,omitempty"`
	// The continent where the deployment is located
	Continent string `json:"continent,omitempty"`
	// The administrative division where the deployment is located
	AdministrativeDivision string `json:"administrative_division,omitempty"`
	// List of tags associated with the deployment
	Tags []string `json:"tags,omitempty"`
	// The container log storage options for the deployment
	ContainerLogStorage *ContainerLogStorageModel `json:"container_log_storage"`
}

type SelectorEnvModel 

type SelectorEnvModel struct {
	// The Key to inject in the Deployment Environment Variable for this Selector
	Key string `json:"key"`
	// The Value to inject in the Deployment Environment Variable for this Selector
	Value string `json:"value"`
}

type SelectorModel 

type SelectorModel struct {
	// The Tag to filter potential Deployment with this Selector
	Tag string `json:"tag"`
	// If True, will not try to filter Deployment and only tag the Session
	TagOnly bool              `json:"tag_only,omitempty"`
	Env     *SelectorModelEnv `json:"env,omitempty"`
}

type SelectorModelEnv 

type SelectorModelEnv struct {
}

Environment Variable to inject in new Deployment created by App Version with auto-deploy

type ServerRelayPort 

type ServerRelayPort struct {
	// The port number
	Port int32 `json:"port,omitempty"`
	// The protocol of the port
	Protocol string `json:"protocol,omitempty"`
	// The link to the port
	Link string `json:"link,omitempty"`
}

type SessionBulkStopFiltersPayload 

type SessionBulkStopFiltersPayload struct {
	// The field on which to apply the filter
	Field string `json:"field"`
	// Values that will be used for the filter
	Values []string `json:"values"`
	// Types of filter used. Possible values are: ['any', 'all', 'not']
	FilterType string `json:"filter_type"`
}

type SessionBulkStopPayload 

type SessionBulkStopPayload struct {
	// Filters used to match with sessions
	Filters []SessionBulkStopFiltersPayload `json:"filters"`
}

type SessionBulkStopResponse 

type SessionBulkStopResponse struct {
	// A list sessions that can be processed to be stopped
	Processable []SessionStopResponse `json:"processable"`
}

type SessionContext 

type SessionContext struct {
	// Unique UUID
	SessionId string `json:"session_id"`
	// Custom ID if Available
	CustomId string `json:"custom_id,omitempty"`
	// Current status of the session
	Status string `json:"status"`
	// If the session is linked to a Ready deployment
	Ready bool `json:"ready"`
	// If the session is linked to a deployment
	Linked bool `json:"linked"`
	// Type of session created
	Kind string `json:"kind"`
	// Count of user this session currently have
	UserCount int32 `json:"user_count"`
	// Unique UUID
	DeploymentRequestId string `json:"deployment_request_id,omitempty"`
	// When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type SessionDelete 

type SessionDelete struct {
	// A message depending of the request termination
	Message string `json:"message"`
	// The Unique Identifier of the Session
	SessionId string `json:"session_id"`
	// Custom ID if Available
	CustomId string `json:"custom_id,omitempty"`
}

type SessionFilterModel 

type SessionFilterModel struct {
	// The field to filter
	Field string `json:"field"`
	// The values to filter
	Values []string `json:"values"`
	// The type of filter
	FilterType string `json:"filter_type"`
}

type SessionGet 

type SessionGet struct {
	// Unique UUID
	SessionId string `json:"session_id"`
	// Custom ID if Available
	CustomId string `json:"custom_id,omitempty"`
	// Current status of the session
	Status string `json:"status"`
	// If the session is linked to a ready deployment
	Ready bool `json:"ready"`
	// If the session is linked to a deployment
	Linked bool `json:"linked"`
	// Type of session created
	Kind string `json:"kind"`
	// Count of user this session currently have
	UserCount int32 `json:"user_count"`
	// App version linked to the session
	AppVersion int32 `json:"app_version"`
	// Session created at
	CreateTime string `json:"create_time"`
	// Elapsed time
	Elapsed int32 `json:"elapsed"`
	// Error Detail
	Error_ string `json:"error,omitempty"`
	// Users in the session
	SessionUsers []SessionUser `json:"session_users,omitempty"`
	// IPS in the session
	SessionIps []SessionUser `json:"session_ips,omitempty"`
	Deployment *Deployment   `json:"deployment,omitempty"`
	// When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type SessionModel 

type SessionModel struct {
	// The Name of the App you want to deploy, example:    supermario
	AppName string `json:"app_name"`
	// The Name of the App Version you want to deploy, example:    v1.0
	VersionName string `json:"version_name,omitempty"`
	// The List of IP of your user, Array of String, example:     [\"162.254.103.13\",\"198.12.116.39\", \"162.254.135.39\", \"162.254.129.34\"]
	IpList []string `json:"ip_list,omitempty"`
	// The list of IP of your user with their location (latitude, longitude)
	GeoIpList []GeoIpListModel `json:"geo_ip_list,omitempty"`
	// The request id of your deployment. If specified, the session will link to the deployment
	DeploymentRequestId string `json:"deployment_request_id,omitempty"`
	// If you want to specify a centroid for your session.
	Location *LocationModel `json:"location,omitempty"`
	// If you want your session in a specific city
	City string `json:"city,omitempty"`
	// If you want your session in a specific country
	Country string `json:"country,omitempty"`
	// If you want your session in a specific continent
	Continent string `json:"continent,omitempty"`
	// If you want your session in a specific administrative division
	AdministrativeDivision string `json:"administrative_division,omitempty"`
	// If you want your session in a specific region
	Region string `json:"region,omitempty"`
	// List of Selectors to filter potential Deployment to link and tag the Session
	Selectors []SelectorModel `json:"selectors,omitempty"`
	// When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url
	WebhookUrl string `json:"webhook_url,omitempty"`
	// List of location filters to apply to the session
	Filters []SessionFilterModel `json:"filters,omitempty"`
	// If system should skip the telemetry and use GeoBase decision only
	SkipTelemetry bool `json:"skip_telemetry,omitempty"`
}

type SessionRequest 

type SessionRequest struct {
	// The Unique Identifier of the Session
	SessionId string `json:"session_id"`
	// Custom ID if Available
	CustomId string `json:"custom_id,omitempty"`
	// The Name of the App you requested
	App string `json:"app"`
	// The name of the App Version you requested
	Version string `json:"version"`
	// Unique UUID
	DeploymentRequestId string `json:"deployment_request_id,omitempty"`
	// List of Selectors to filter potential Deployment to link and tag the Session
	Selectors []SelectorModel `json:"selectors,omitempty"`
	// When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url
	WebhookUrl string `json:"webhook_url,omitempty"`
}

type SessionStopResponse 

type SessionStopResponse struct {
	// The id of the request for a deployment
	SessionId string `json:"session_id"`
}

type SessionUser 

type SessionUser struct {
	// Ip of the user connected to the Session
	Ip string `json:"ip"`
	// Latitude
	Latitude float32 `json:"latitude,omitempty"`
	// Longitude
	Longitude float32 `json:"longitude,omitempty"`
}

type SessionUserContext 

type SessionUserContext struct {
	// Users in the session
	SessionUsers []SessionUser `json:"session_users"`
}

type Sessions 

type Sessions struct {
	// List of Active Sessions
	Data []SessionContext `json:"data,omitempty"`
	// Total Session in the Database
	TotalCount int32 `json:"total_count,omitempty"`
	// Pagination Object
	Pagination *Pagination `json:"pagination,omitempty"`
}

type SessionsApiService 

type SessionsApiService service

func (*SessionsApiService) DeleteUsersSession 

func (a *SessionsApiService) DeleteUsersSession(ctx context.Context, sessionId string, payload PatchSessionModel) (SessionUserContext, *http.Response, error)

SessionsApiService Delete Users From a Session Remove specified users from a session.

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

@return SessionUserContext

func (*SessionsApiService) GetSession 

func (a *SessionsApiService) GetSession(ctx context.Context, sessionId string) (SessionGet, *http.Response, error)

SessionsApiService Get a Session Retrieve the information for a session.

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

@return SessionGet

func (*SessionsApiService) GetUsersSession 

func (a *SessionsApiService) GetUsersSession(ctx context.Context, sessionId string) (SessionUserContext, *http.Response, error)

SessionsApiService List Users of a Session List all the users of session.

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

@return SessionUserContext

func (*SessionsApiService) ListSessions 

func (a *SessionsApiService) ListSessions(ctx context.Context) (Sessions, *http.Response, error)

SessionsApiService List All Sessions List all the active sessions.

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

@return Sessions

func (*SessionsApiService) PutUsersSession 

func (a *SessionsApiService) PutUsersSession(ctx context.Context, sessionId string, payload PatchSessionModel) (SessionUserContext, *http.Response, error)

SessionsApiService Put Users in a Session Add specified users to a session.

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

@return SessionUserContext

func (*SessionsApiService) SessionDelete 

func (a *SessionsApiService) SessionDelete(ctx context.Context, sessionId string) (SessionDelete, *http.Response, error)

SessionsApiService Delete a Session Delete a session. Once deleted, a session is no more accessible and does not have a history. The deployment associated will not be deleted.

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

@return SessionDelete

func (*SessionsApiService) SessionPost 

func (a *SessionsApiService) SessionPost(ctx context.Context, payload SessionModel) (SessionRequest, *http.Response, error)

SessionsApiService Create a Session Create a session with users. Sessions are linked to a deployment.

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

@return SessionRequest

func (*SessionsApiService) SessionsBulkStop 

func (a *SessionsApiService) SessionsBulkStop(ctx context.Context, payload SessionBulkStopPayload) (SessionBulkStopResponse, *http.Response, error)

SessionsApiService Delete Sessions in Bulk Make a bulk delete of sessions using filters. All the sessions matching the given filters will be permanently deleted.

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

@return SessionBulkStopResponse

type Status 

type Status struct {
	// The Unique ID of the Deployment's request
	RequestId string `json:"request_id"`
	// The FQDN that allow to connect to your Deployment
	Fqdn string `json:"fqdn"`
	// The name of the deployed App
	AppName string `json:"app_name"`
	// The version of the deployed App
	AppVersion string `json:"app_version"`
	// The current status of the Deployment
	CurrentStatus string `json:"current_status"`
	// True if the current Deployment is ready to be connected and running
	Running bool `json:"running"`
	// True if the current Deployment is ACL protected
	WhitelistingActive bool `json:"whitelisting_active"`
	// Timestamp of the Deployment when it is up and running
	StartTime string `json:"start_time"`
	// Timestamp of the end of the Deployment
	RemovalTime string `json:"removal_time,omitempty"`
	// Time since the Deployment is up and running in seconds
	ElapsedTime int32 `json:"elapsed_time"`
	// The last status of the Deployment
	LastStatus string `json:"last_status,omitempty"`
	// True if there is an error with the Deployment
	Error_ bool `json:"error"`
	// The error details of the Deployment
	ErrorDetail string                 `json:"error_detail,omitempty"`
	Ports       map[string]PortMapping `json:"ports,omitempty"`
	// The public IP
	PublicIp string `json:"public_ip"`
	// List of Active Sessions if Deployment App is Session Based
	Sessions []DeploymentSessionContext `json:"sessions,omitempty"`
	// Location related information
	Location *DeploymentLocation `json:"location,omitempty"`
	// List of tags associated with the deployment
	Tags []string `json:"tags,omitempty"`
	// The Capacity of the Deployment
	Sockets int32 `json:"sockets,omitempty"`
	// The Capacity Usage of the Deployment
	SocketsUsage int32 `json:"sockets_usage,omitempty"`
	// The command to use in the container, null mean it will take the default of the container
	Command string `json:"command,omitempty"`
	// The arguments to use in the container, null mean it will take the default of the container
	Arguments string `json:"arguments,omitempty"`
}

type Tag 

type Tag struct {
	// Tag's Key
	Key string `json:"key"`
	// Tag's Value
	Value string `json:"value"`
}

type TelemetryApiService 

type TelemetryApiService service

func (*TelemetryApiService) ActiveDeploymentTelemetryGet 

func (a *TelemetryApiService) ActiveDeploymentTelemetryGet(ctx context.Context, retrievalKey string) (ActiveDeploymentTelemetryGetResult, *http.Response, error)

TelemetryApiService Get the Result of an Active Deployment Telemetry Request Retrieve the results of a telemetry request on active deployment(s) for given IP(s). The score array is sorted from the best to the worse deployment. You can use this to add players on a running deployment.

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

@return ActiveDeploymentTelemetryGetResult

func (*TelemetryApiService) ActiveDeploymentTelemetryPost 

func (a *TelemetryApiService) ActiveDeploymentTelemetryPost(ctx context.Context, payload ActiveDeploymentTelemetryRequest) (ActiveDeploymentTelemetryResponse, *http.Response, error)

TelemetryApiService Create a New Active Deployment Telemetry Request Create a telemetry request to get the best deployment(s) for given IP(s). You can use this to add players on a running deployment. If you set a webhook URL, the result will be sent to it.

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

@return ActiveDeploymentTelemetryResponse

type TotalMetricsModel 

type TotalMetricsModel struct {
	ReceiveTotal   *MetricsModel `json:"receive_total,omitempty"`
	TransmitTotal  *MetricsModel `json:"transmit_total,omitempty"`
	DiskReadTotal  *MetricsModel `json:"disk_read_total,omitempty"`
	DiskWriteTotal *MetricsModel `json:"disk_write_total,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.