symbols:
'NewAmsClient@go.ams.fun':
id: 'NewAmsClient@go.ams.fun'
name: 'NewAmsClient'
type: 'function'
arguments:
configRepository:
type: 'repository.ConfigRepository'
return_type: '*amsclient.JusticeAmsService'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-modular-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/justice_ams_service_client.go'
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/factory/amsclientfactory.go'
example: |-
amsClient := factory.NewAmsClient(configRepo)
# region wrappers
'AccountService@go.ams.mod':
id: 'AccountService@go.ams.mod'
name: 'AccountService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/account.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
accountService := AccountService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'AMSInfoService@go.ams.mod':
id: 'AMSInfoService@go.ams.mod'
name: 'AMSInfoService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/amsInfo.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
aMSInfoService := AMSInfoService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'AMSQoSService@go.ams.mod':
id: 'AMSQoSService@go.ams.mod'
name: 'AMSQoSService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/amsQoS.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
aMSQoSService := AMSQoSService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'ArtifactsService@go.ams.mod':
id: 'ArtifactsService@go.ams.mod'
name: 'ArtifactsService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/artifacts.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
artifactsService := ArtifactsService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'AuthService@go.ams.mod':
id: 'AuthService@go.ams.mod'
name: 'AuthService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/auth.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
authService := AuthService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'DevelopmentService@go.ams.mod':
id: 'DevelopmentService@go.ams.mod'
name: 'DevelopmentService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/development.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
developmentService := DevelopmentService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'FleetCommanderService@go.ams.mod':
id: 'FleetCommanderService@go.ams.mod'
name: 'FleetCommanderService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleetCommander.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
fleetCommanderService := FleetCommanderService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'FleetsService@go.ams.mod':
id: 'FleetsService@go.ams.mod'
name: 'FleetsService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
fleetsService := FleetsService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'ImagesService@go.ams.mod':
id: 'ImagesService@go.ams.mod'
name: 'ImagesService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/images.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
imagesService := ImagesService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'ServersService@go.ams.mod':
id: 'ServersService@go.ams.mod'
name: 'ServersService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/servers.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
serversService := ServersService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'WatchdogsService@go.ams.mod':
id: 'WatchdogsService@go.ams.mod'
name: 'WatchdogsService'
type: 'model'
fields:
Client:
type: '*amsclient.JusticeAmsService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/watchdogs.go'
example: |-
amsClient := factory.NewAmsClient(configRepo) // re-use if it exists already
watchdogsService := WatchdogsService{
Client: amsClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
# endregion wrappers
# region params
'AccountGetParams@go.ams.mod':
id: 'AccountGetParams@go.ams.mod'
name: 'AccountGetParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/account/account_get_parameters.go'
'AdminAccountCreateParams@go.ams.mod':
id: 'AdminAccountCreateParams@go.ams.mod'
name: 'AdminAccountCreateParams'
type: 'model'
fields:
'Body':
type: '*APIAccountCreateRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/account/admin_account_create_parameters.go'
'AdminAccountGetParams@go.ams.mod':
id: 'AdminAccountGetParams@go.ams.mod'
name: 'AdminAccountGetParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/account/admin_account_get_parameters.go'
'AdminAccountLinkParams@go.ams.mod':
id: 'AdminAccountLinkParams@go.ams.mod'
name: 'AdminAccountLinkParams'
type: 'model'
fields:
'Body':
type: '*APIAccountLinkRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/account/admin_account_link_parameters.go'
'AdminAccountLinkTokenGetParams@go.ams.mod':
id: 'AdminAccountLinkTokenGetParams@go.ams.mod'
name: 'AdminAccountLinkTokenGetParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/account/admin_account_link_token_get_parameters.go'
'ArtifactBulkDeleteParams@go.ams.mod':
id: 'ArtifactBulkDeleteParams@go.ams.mod'
name: 'ArtifactBulkDeleteParams'
type: 'model'
fields:
'ArtifactType':
type: 'string'
required: false
description: |-
artifact type (can be repeated)
'FleetID':
type: 'string'
required: false
description: |-
fleet ID (can be repeated)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'UploadedBefore':
type: '*string'
required: false
description: |-
uploaded before date
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/artifacts/artifact_bulk_delete_parameters.go'
'ArtifactDeleteParams@go.ams.mod':
id: 'ArtifactDeleteParams@go.ams.mod'
name: 'ArtifactDeleteParams'
type: 'model'
fields:
'ArtifactID':
type: 'string'
required: true
description: |-
the id of the artifact
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/artifacts/artifact_delete_parameters.go'
'ArtifactGetParams@go.ams.mod':
id: 'ArtifactGetParams@go.ams.mod'
name: 'ArtifactGetParams'
type: 'model'
fields:
'ArtifactType':
type: 'string'
required: false
description: |-
one of: log, coredump
'Count':
type: 'int64'
required: false
description: |-
defines the maximum number of records returned in one page.
'EndDate':
type: 'string'
required: false
description: |-
omit artifacts with collection dates newer than
'FleetID':
type: 'string'
required: false
description: |-
id of the fleet where the artifact was collected
'ImageID':
type: 'string'
required: false
description: |-
id of the image being used on the server when artifact was collected
'MaxSize':
type: 'int64'
required: false
description: |-
maximum artifact size in bytes
'MinSize':
type: 'int64'
required: false
description: |-
minimum artifact size in bytes
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
specifies the start index for the records returned. Useful for implementing pagination.
'Region':
type: 'string'
required: false
description: |-
region of the server where the artifact was collected
'ServerID':
type: 'string'
required: false
description: |-
id of the server (ds) where the artifact was collected
'SortBy':
type: 'string'
required: false
description: |-
field name to sort the artifact
'SortDirection':
type: 'string'
required: false
description: |-
the sort direction
'StartDate':
type: 'string'
required: false
description: |-
omit artifacts with collection dates older than
'Status':
type: 'string'
required: false
description: |-
one of: success, skipped_sample, skipped_usage, failed
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/artifacts/artifact_get_parameters.go'
'ArtifactGetURLParams@go.ams.mod':
id: 'ArtifactGetURLParams@go.ams.mod'
name: 'ArtifactGetURLParams'
type: 'model'
fields:
'ArtifactID':
type: 'string'
required: true
description: |-
the id of the artifact
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/artifacts/artifact_get_url_parameters.go'
'ArtifactUsageGetParams@go.ams.mod':
id: 'ArtifactUsageGetParams@go.ams.mod'
name: 'ArtifactUsageGetParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/artifacts/artifact_usage_get_parameters.go'
'AuthCheckParams@go.ams.mod':
id: 'AuthCheckParams@go.ams.mod'
name: 'AuthCheckParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/auth'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/auth/auth_check_parameters.go'
'BasicHealthCheckParams@go.ams.mod':
id: 'BasicHealthCheckParams@go.ams.mod'
name: 'BasicHealthCheckParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleet_commander'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleet_commander/basic_health_check_parameters.go'
'BulkFleetDeleteParams@go.ams.mod':
id: 'BulkFleetDeleteParams@go.ams.mod'
name: 'BulkFleetDeleteParams'
type: 'model'
fields:
'Body':
type: '*APIFleetBulkDeleteRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/bulk_fleet_delete_parameters.go'
'DevelopmentServerConfigurationCreateParams@go.ams.mod':
id: 'DevelopmentServerConfigurationCreateParams@go.ams.mod'
name: 'DevelopmentServerConfigurationCreateParams'
type: 'model'
fields:
'Body':
type: '*APIDevelopmentServerConfigurationCreateRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/development/development_server_configuration_create_parameters.go'
'DevelopmentServerConfigurationDeleteParams@go.ams.mod':
id: 'DevelopmentServerConfigurationDeleteParams@go.ams.mod'
name: 'DevelopmentServerConfigurationDeleteParams'
type: 'model'
fields:
'DevelopmentServerConfigID':
type: 'string'
required: true
description: |-
the name of the development server configuration
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/development/development_server_configuration_delete_parameters.go'
'DevelopmentServerConfigurationGetParams@go.ams.mod':
id: 'DevelopmentServerConfigurationGetParams@go.ams.mod'
name: 'DevelopmentServerConfigurationGetParams'
type: 'model'
fields:
'DevelopmentServerConfigID':
type: 'string'
required: true
description: |-
the name of the development server configuration
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/development/development_server_configuration_get_parameters.go'
'DevelopmentServerConfigurationListParams@go.ams.mod':
id: 'DevelopmentServerConfigurationListParams@go.ams.mod'
name: 'DevelopmentServerConfigurationListParams'
type: 'model'
fields:
'Count':
type: 'int64'
required: false
description: |-
defines the maximum number of records returned in one page.
'ImageID':
type: 'string'
required: false
description: |-
filter by image ID
'Name':
type: 'string'
required: false
description: |-
filter by config name
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
specifies the start index for the records returned.
'SortBy':
type: 'string'
required: false
description: |-
sort records by the given field
'SortDirection':
type: 'string'
required: false
description: |-
sort direction (ascending or descending)
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/development/development_server_configuration_list_parameters.go'
'DevelopmentServerConfigurationPatchParams@go.ams.mod':
id: 'DevelopmentServerConfigurationPatchParams@go.ams.mod'
name: 'DevelopmentServerConfigurationPatchParams'
type: 'model'
fields:
'Body':
type: '*APIDevelopmentServerConfigurationUpdateRequest'
required: true
'DevelopmentServerConfigID':
type: 'string'
required: true
description: |-
the name of the development server configuration
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/development/development_server_configuration_patch_parameters.go'
'FleetArtifactSamplingRulesGetParams@go.ams.mod':
id: 'FleetArtifactSamplingRulesGetParams@go.ams.mod'
name: 'FleetArtifactSamplingRulesGetParams'
type: 'model'
fields:
'FleetID':
type: 'string'
required: true
description: |-
the id of the fleet
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/artifacts/fleet_artifact_sampling_rules_get_parameters.go'
'FleetArtifactSamplingRulesSetParams@go.ams.mod':
id: 'FleetArtifactSamplingRulesSetParams@go.ams.mod'
name: 'FleetArtifactSamplingRulesSetParams'
type: 'model'
fields:
'Body':
type: '*APIFleetArtifactsSampleRules'
required: true
'FleetID':
type: 'string'
required: true
description: |-
the id of the fleet
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/artifacts/fleet_artifact_sampling_rules_set_parameters.go'
'FleetClaimByIDParams@go.ams.mod':
id: 'FleetClaimByIDParams@go.ams.mod'
name: 'FleetClaimByIDParams'
type: 'model'
fields:
'Body':
type: '*APIFleetClaimReq'
required: true
'FleetID':
type: 'string'
required: true
description: |-
the id of the fleet
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/fleet_claim_by_id_parameters.go'
'FleetClaimByKeysParams@go.ams.mod':
id: 'FleetClaimByKeysParams@go.ams.mod'
name: 'FleetClaimByKeysParams'
type: 'model'
fields:
'Body':
type: '*APIFleetClaimByKeysReq'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/fleet_claim_by_keys_parameters.go'
'FleetCreateParams@go.ams.mod':
id: 'FleetCreateParams@go.ams.mod'
name: 'FleetCreateParams'
type: 'model'
fields:
'Body':
type: '*APIFleetParameters'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/fleet_create_parameters.go'
'FleetDeleteParams@go.ams.mod':
id: 'FleetDeleteParams@go.ams.mod'
name: 'FleetDeleteParams'
type: 'model'
fields:
'FleetID':
type: 'string'
required: true
description: |-
the id of the fleet
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/fleet_delete_parameters.go'
'FleetGetParams@go.ams.mod':
id: 'FleetGetParams@go.ams.mod'
name: 'FleetGetParams'
type: 'model'
fields:
'FleetID':
type: 'string'
required: true
description: |-
the id of the fleet
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/fleet_get_parameters.go'
'FleetListParams@go.ams.mod':
id: 'FleetListParams@go.ams.mod'
name: 'FleetListParams'
type: 'model'
fields:
'Active':
type: 'bool'
required: false
description: |-
filter fleets by active status
'Count':
type: 'int64'
required: false
description: |-
the number of fleets to return
'Name':
type: 'string'
required: false
description: |-
filter fleets by name
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
the pagination offset
'Region':
type: 'string'
required: false
description: |-
filter fleets by region
'SortBy':
type: 'string'
required: false
description: |-
sort fleets by column name
'SortDirection':
type: 'string'
required: false
description: |-
sort direction (ascending or descending)
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/fleet_list_parameters.go'
'FleetServerConnectionInfoParams@go.ams.mod':
id: 'FleetServerConnectionInfoParams@go.ams.mod'
name: 'FleetServerConnectionInfoParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'ServerID':
type: 'string'
required: true
description: |-
the ID of the dedicated server
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/servers'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/servers/fleet_server_connection_info_parameters.go'
'FleetServerHistoryParams@go.ams.mod':
id: 'FleetServerHistoryParams@go.ams.mod'
name: 'FleetServerHistoryParams'
type: 'model'
fields:
'Count':
type: 'int64'
required: false
description: |-
Defines the maximum number of records returned in one page. Default is 1000 when not provided.
'FleetID':
type: 'string'
required: true
description: |-
ID of the fleet
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
Specifies the start index for the records returned. Useful for implementing pagination. Default is 0 when not provided.
'Reason':
type: 'string'
required: false
description: |-
Exit reason
'Region':
type: 'string'
required: false
description: |-
Region
'ServerID':
type: 'string'
required: false
description: |-
Dedicated server ID
'SortDirection':
type: 'string'
required: false
description: |-
The direction of the sort on the 'createdAt' column, 'asc' for ascending and 'desc' for descending. Defaults to 'asc' when not provided.
'Status':
type: 'string'
required: false
description: |-
Status of the dedicated server
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/servers'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/servers/fleet_server_history_parameters.go'
'FleetServerInfoParams@go.ams.mod':
id: 'FleetServerInfoParams@go.ams.mod'
name: 'FleetServerInfoParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'ServerID':
type: 'string'
required: true
description: |-
the id of the dedicated server
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/servers'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/servers/fleet_server_info_parameters.go'
'FleetServersParams@go.ams.mod':
id: 'FleetServersParams@go.ams.mod'
name: 'FleetServersParams'
type: 'model'
fields:
'Count':
type: 'int64'
required: false
description: |-
the data limit
'FleetID':
type: 'string'
required: true
description: |-
the id of the fleet
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
the data offset
'Region':
type: 'string'
required: false
description: |-
the servers region
'ServerID':
type: 'string'
required: false
description: |-
the id of the server
'SortBy':
type: 'string'
required: false
description: |-
the field by which to order the data
'SortDirection':
type: 'string'
required: false
description: |-
the data ordering direction
'Status':
type: 'string'
required: false
description: |-
the servers status
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/fleet_servers_parameters.go'
'FleetUpdateParams@go.ams.mod':
id: 'FleetUpdateParams@go.ams.mod'
name: 'FleetUpdateParams'
type: 'model'
fields:
'Body':
type: '*APIFleetParameters'
required: true
'FleetID':
type: 'string'
required: true
description: |-
the id of the fleet
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleets/fleet_update_parameters.go'
'Func1Params@go.ams.mod':
id: 'Func1Params@go.ams.mod'
name: 'Func1Params'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleet_commander'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleet_commander/func1_parameters.go'
'ImageGetParams@go.ams.mod':
id: 'ImageGetParams@go.ams.mod'
name: 'ImageGetParams'
type: 'model'
fields:
'ImageID':
type: 'string'
required: true
description: |-
the id of the image
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/images/image_get_parameters.go'
'ImageListParams@go.ams.mod':
id: 'ImageListParams@go.ams.mod'
name: 'ImageListParams'
type: 'model'
fields:
'Count':
type: 'int64'
required: false
description: |-
the count of image list
'InUse':
type: 'string'
required: false
description: |-
the inUse filter
'IsProtected':
type: 'bool'
required: false
description: |-
the image protected
'Name':
type: 'string'
required: false
description: |-
the image name
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
the offset of image list
'SortBy':
type: 'string'
required: false
description: |-
the sortBy parameter specifies the attribute by which to sort the results
'SortDirection':
type: 'string'
required: false
description: |-
the sort direction parameter
'Status':
type: 'string'
required: false
description: |-
the image status
'Tag':
type: 'string'
required: false
description: |-
the image tag
'TargetArchitecture':
type: 'string'
required: false
description: |-
the target architecture (currently only 'linux-x86_64' and 'linux-arm_64' are supported)
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/images/image_list_parameters.go'
'ImageMarkForDeletionParams@go.ams.mod':
id: 'ImageMarkForDeletionParams@go.ams.mod'
name: 'ImageMarkForDeletionParams'
type: 'model'
fields:
'ImageID':
type: 'string'
required: true
description: |-
the id of the image
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/images/image_mark_for_deletion_parameters.go'
'ImagePatchParams@go.ams.mod':
id: 'ImagePatchParams@go.ams.mod'
name: 'ImagePatchParams'
type: 'model'
fields:
'Body':
type: '*APIImageUpdate'
required: true
'ImageID':
type: 'string'
required: true
description: |-
the id of the image
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/images/image_patch_parameters.go'
'ImagesStorageParams@go.ams.mod':
id: 'ImagesStorageParams@go.ams.mod'
name: 'ImagesStorageParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/images/images_storage_parameters.go'
'ImageUnmarkForDeletionParams@go.ams.mod':
id: 'ImageUnmarkForDeletionParams@go.ams.mod'
name: 'ImageUnmarkForDeletionParams'
type: 'model'
fields:
'ImageID':
type: 'string'
required: true
description: |-
the id of the image
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/images/image_unmark_for_deletion_parameters.go'
'InfoRegionsParams@go.ams.mod':
id: 'InfoRegionsParams@go.ams.mod'
name: 'InfoRegionsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_info'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/a_m_s_info/info_regions_parameters.go'
'InfoSupportedInstancesParams@go.ams.mod':
id: 'InfoSupportedInstancesParams@go.ams.mod'
name: 'InfoSupportedInstancesParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_info'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/a_m_s_info/info_supported_instances_parameters.go'
'LocalWatchdogConnectParams@go.ams.mod':
id: 'LocalWatchdogConnectParams@go.ams.mod'
name: 'LocalWatchdogConnectParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'WatchdogID':
type: 'string'
required: true
description: |-
the id of the watchdog
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/watchdogs'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/watchdogs/local_watchdog_connect_parameters.go'
'PortalHealthCheckParams@go.ams.mod':
id: 'PortalHealthCheckParams@go.ams.mod'
name: 'PortalHealthCheckParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleet_commander'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/fleet_commander/portal_health_check_parameters.go'
'QoSRegionsGetParams@go.ams.mod':
id: 'QoSRegionsGetParams@go.ams.mod'
name: 'QoSRegionsGetParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Status':
type: 'string'
required: false
description: |-
QoS status, available value: ACTIVE, INACTIVE
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_qo_s'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/a_m_s_qo_s/qo_s_regions_get_parameters.go'
'QoSRegionsUpdateParams@go.ams.mod':
id: 'QoSRegionsUpdateParams@go.ams.mod'
name: 'QoSRegionsUpdateParams'
type: 'model'
fields:
'Body':
type: '*APIUpdateServerRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Region':
type: 'string'
required: true
description: |-
region of the QoS
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_qo_s'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/a_m_s_qo_s/qo_s_regions_update_parameters.go'
'ServerHistoryParams@go.ams.mod':
id: 'ServerHistoryParams@go.ams.mod'
name: 'ServerHistoryParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'ServerID':
type: 'string'
required: true
description: |-
the id of the dedicated server
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/servers'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/servers/server_history_parameters.go'
'UploadURLGetParams@go.ams.mod':
id: 'UploadURLGetParams@go.ams.mod'
name: 'UploadURLGetParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_info'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/a_m_s_info/upload_url_get_parameters.go'
'WatchdogConnectParams@go.ams.mod':
id: 'WatchdogConnectParams@go.ams.mod'
name: 'WatchdogConnectParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'WatchdogID':
type: 'string'
required: true
description: |-
the id of the watchdog
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/watchdogs'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclient/watchdogs/watchdog_connect_parameters.go'
# endregion params
# region models
'APIAccountCreateRequest@go.ams.mod':
id: 'APIAccountCreateRequest@go.ams.mod'
name: 'APIAccountCreateRequest'
type: 'model'
fields:
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_account_create_request.go'
'APIAccountCreateResponse@go.ams.mod':
id: 'APIAccountCreateResponse@go.ams.mod'
name: 'APIAccountCreateResponse'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'Limits':
type: '*APIAccountLimits'
required: true
'Name':
type: 'string'
required: true
'Namespaces':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_account_create_response.go'
'APIAccountLimits@go.ams.mod':
id: 'APIAccountLimits@go.ams.mod'
name: 'APIAccountLimits'
type: 'model'
fields:
'AllowedNodeClasses':
type: '[]string'
required: false
'AllowedRegions':
type: '[]string'
required: false
'FleetCount':
type: 'int32'
required: false
'FleetVMCount':
type: 'int32'
required: false
'ImageStorageQuotaBytes':
type: 'int64'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_account_limits.go'
'APIAccountLinkRequest@go.ams.mod':
id: 'APIAccountLinkRequest@go.ams.mod'
name: 'APIAccountLinkRequest'
type: 'model'
fields:
'Token':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_account_link_request.go'
'APIAccountLinkResponse@go.ams.mod':
id: 'APIAccountLinkResponse@go.ams.mod'
name: 'APIAccountLinkResponse'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'Limits':
type: '*APIAccountLimits'
required: true
'Name':
type: 'string'
required: true
'Namespaces':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_account_link_response.go'
'APIAccountLinkTokenResponse@go.ams.mod':
id: 'APIAccountLinkTokenResponse@go.ams.mod'
name: 'APIAccountLinkTokenResponse'
type: 'model'
fields:
'Token':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_account_link_token_response.go'
'APIAccountResponse@go.ams.mod':
id: 'APIAccountResponse@go.ams.mod'
name: 'APIAccountResponse'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'Limits':
type: '*APIAccountLimits'
required: true
'Name':
type: 'string'
required: true
'Namespaces':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_account_response.go'
'APIAMSRegionsResponse@go.ams.mod':
id: 'APIAMSRegionsResponse@go.ams.mod'
name: 'APIAMSRegionsResponse'
type: 'model'
fields:
'Regions':
type: '[]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_a_m_s_regions_response.go'
'APIArtifactListResponse@go.ams.mod':
id: 'APIArtifactListResponse@go.ams.mod'
name: 'APIArtifactListResponse'
type: 'model'
fields:
'Data':
type: '[]*APIArtifactResponse'
required: true
'TotalData':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_artifact_list_response.go'
'APIArtifactResponse@go.ams.mod':
id: 'APIArtifactResponse@go.ams.mod'
name: 'APIArtifactResponse'
type: 'model'
fields:
'ArtifactType':
type: 'string'
required: true
'CreatedOn':
type: 'string'
required: true
'DsID':
type: 'string'
required: true
'ExpiresOn':
type: 'string'
required: true
'Filename':
type: 'string'
required: true
'FleetID':
type: 'string'
required: true
'ID':
type: 'string'
required: true
'ImageID':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'Reason':
type: 'string'
required: false
'Region':
type: 'string'
required: true
'SizeBytes':
type: 'int64'
required: true
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_artifact_response.go'
'APIArtifactSamplingRule@go.ams.mod':
id: 'APIArtifactSamplingRule@go.ams.mod'
name: 'APIArtifactSamplingRule'
type: 'model'
fields:
'Collect':
type: 'bool'
required: true
'Percentage':
type: 'int64'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_artifact_sampling_rule.go'
'APIArtifactTypeSamplingRules@go.ams.mod':
id: 'APIArtifactTypeSamplingRules@go.ams.mod'
name: 'APIArtifactTypeSamplingRules'
type: 'model'
fields:
'Crashed':
type: '*APIArtifactSamplingRule'
required: true
'Success':
type: '*APIArtifactSamplingRule'
required: true
'Unclaimed':
type: '*APIArtifactSamplingRule'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_artifact_type_sampling_rules.go'
'APIArtifactURLResponse@go.ams.mod':
id: 'APIArtifactURLResponse@go.ams.mod'
name: 'APIArtifactURLResponse'
type: 'model'
fields:
'URL':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_artifact_url_response.go'
'APIArtifactUsageResponse@go.ams.mod':
id: 'APIArtifactUsageResponse@go.ams.mod'
name: 'APIArtifactUsageResponse'
type: 'model'
fields:
'QuotaBytes':
type: 'int64'
required: true
'RemainingBytes':
type: 'int64'
required: true
'UsedBytes':
type: 'int64'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_artifact_usage_response.go'
'APICapacity@go.ams.mod':
id: 'APICapacity@go.ams.mod'
name: 'APICapacity'
type: 'model'
fields:
'Region':
type: 'string'
required: true
'VMCount':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_capacity.go'
'APICoredumpSamplingRules@go.ams.mod':
id: 'APICoredumpSamplingRules@go.ams.mod'
name: 'APICoredumpSamplingRules'
type: 'model'
fields:
'Crashed':
type: '*APIArtifactSamplingRule'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_coredump_sampling_rules.go'
'APIDevelopmentServerConfigurationCreateRequest@go.ams.mod':
id: 'APIDevelopmentServerConfigurationCreateRequest@go.ams.mod'
name: 'APIDevelopmentServerConfigurationCreateRequest'
type: 'model'
fields:
'CommandLineArguments':
type: 'string'
required: true
'ExpiresAt':
type: 'string'
required: false
'ImageID':
type: 'string'
required: true
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_development_server_configuration_create_request.go'
'APIDevelopmentServerConfigurationCreateResponse@go.ams.mod':
id: 'APIDevelopmentServerConfigurationCreateResponse@go.ams.mod'
name: 'APIDevelopmentServerConfigurationCreateResponse'
type: 'model'
fields:
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_development_server_configuration_create_response.go'
'APIDevelopmentServerConfigurationGetResponse@go.ams.mod':
id: 'APIDevelopmentServerConfigurationGetResponse@go.ams.mod'
name: 'APIDevelopmentServerConfigurationGetResponse'
type: 'model'
fields:
'CommandLineArguments':
type: 'string'
required: true
'CreatedAt':
type: 'string'
required: false
'ExpiresAt':
type: 'string'
required: false
'ImageID':
type: 'string'
required: true
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_development_server_configuration_get_response.go'
'APIDevelopmentServerConfigurationListResponse@go.ams.mod':
id: 'APIDevelopmentServerConfigurationListResponse@go.ams.mod'
name: 'APIDevelopmentServerConfigurationListResponse'
type: 'model'
fields:
'Data':
type: '[]*APIDevelopmentServerConfigurationGetResponse'
required: true
'Paging':
type: '*PaginationPaginationInfo'
required: true
'TotalData':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_development_server_configuration_list_response.go'
'APIDevelopmentServerConfigurationUpdateRequest@go.ams.mod':
id: 'APIDevelopmentServerConfigurationUpdateRequest@go.ams.mod'
name: 'APIDevelopmentServerConfigurationUpdateRequest'
type: 'model'
fields:
'CommandLineArguments':
type: 'string'
required: false
'ExpiresAt':
type: 'string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_development_server_configuration_update_request.go'
'APIDSHistoryEvent@go.ams.mod':
id: 'APIDSHistoryEvent@go.ams.mod'
name: 'APIDSHistoryEvent'
type: 'model'
fields:
'CreatedAt':
type: 'string'
required: true
'ExitCode':
type: 'int32'
required: true
'IPAddress':
type: 'string'
required: true
'Reason':
type: 'string'
required: true
'Region':
type: 'string'
required: true
'ServerID':
type: 'string'
required: true
'SessionID':
type: 'string'
required: true
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_d_s_history_event.go'
'APIDSHistoryList@go.ams.mod':
id: 'APIDSHistoryList@go.ams.mod'
name: 'APIDSHistoryList'
type: 'model'
fields:
'Events':
type: '[]*APIDSHistoryEvent'
required: true
'Paging':
type: '*APIPagingInfo'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_d_s_history_list.go'
'APIDSHostConfiguration@go.ams.mod':
id: 'APIDSHostConfiguration@go.ams.mod'
name: 'APIDSHostConfiguration'
type: 'model'
fields:
'InstanceID':
type: 'string'
required: true
'InstanceProvider':
type: 'string'
required: true
'InstanceType':
type: 'string'
required: true
'ServersPerVM':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_d_s_host_configuration.go'
'APIDSHostConfigurationParameters@go.ams.mod':
id: 'APIDSHostConfigurationParameters@go.ams.mod'
name: 'APIDSHostConfigurationParameters'
type: 'model'
fields:
'InstanceID':
type: 'string'
required: true
'ServersPerVM':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_d_s_host_configuration_parameters.go'
'APIFleetArtifactsSampleRules@go.ams.mod':
id: 'APIFleetArtifactsSampleRules@go.ams.mod'
name: 'APIFleetArtifactsSampleRules'
type: 'model'
fields:
'Coredumps':
type: '*APICoredumpSamplingRules'
required: true
'Logs':
type: '*APIArtifactTypeSamplingRules'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_artifacts_sample_rules.go'
'APIFleetBulkActionErrorItemResponse@go.ams.mod':
id: 'APIFleetBulkActionErrorItemResponse@go.ams.mod'
name: 'APIFleetBulkActionErrorItemResponse'
type: 'model'
fields:
'ErrorMessage':
type: 'string'
required: false
'ErrorType':
type: 'string'
required: false
'FleetID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_bulk_action_error_item_response.go'
'APIFleetBulkDeleteRequest@go.ams.mod':
id: 'APIFleetBulkDeleteRequest@go.ams.mod'
name: 'APIFleetBulkDeleteRequest'
type: 'model'
fields:
'FleetIds':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_bulk_delete_request.go'
'APIFleetBulkDeleteResponse@go.ams.mod':
id: 'APIFleetBulkDeleteResponse@go.ams.mod'
name: 'APIFleetBulkDeleteResponse'
type: 'model'
fields:
'Errors':
type: '[]*APIFleetBulkActionErrorItemResponse'
required: true
'SuccessCount':
type: 'int32'
required: true
'TotalCount':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_bulk_delete_response.go'
'APIFleetClaimByKeysReq@go.ams.mod':
id: 'APIFleetClaimByKeysReq@go.ams.mod'
name: 'APIFleetClaimByKeysReq'
type: 'model'
fields:
'ClaimKeys':
type: '[]string'
required: true
'Regions':
type: '[]string'
required: true
'SessionID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_claim_by_keys_req.go'
'APIFleetClaimReq@go.ams.mod':
id: 'APIFleetClaimReq@go.ams.mod'
name: 'APIFleetClaimReq'
type: 'model'
fields:
'Region':
type: 'string'
required: true
'SessionID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_claim_req.go'
'APIFleetClaimResponse@go.ams.mod':
id: 'APIFleetClaimResponse@go.ams.mod'
name: 'APIFleetClaimResponse'
type: 'model'
fields:
'FleetID':
type: 'string'
required: true
'IP':
type: 'string'
required: true
'Ports':
type: 'map[string]int64'
required: true
'Region':
type: 'string'
required: true
'ServerID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_claim_response.go'
'APIFleetCreateResponse@go.ams.mod':
id: 'APIFleetCreateResponse@go.ams.mod'
name: 'APIFleetCreateResponse'
type: 'model'
fields:
'ID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_create_response.go'
'APIFleetGetResponse@go.ams.mod':
id: 'APIFleetGetResponse@go.ams.mod'
name: 'APIFleetGetResponse'
type: 'model'
fields:
'Active':
type: 'bool'
required: true
'ClaimKeys':
type: '[]string'
required: true
'DsHostConfiguration':
type: '*APIDSHostConfiguration'
required: true
'FallbackFleet':
type: 'string'
required: true
'HibernateAfterPeriod':
type: 'string'
required: false
description: |-
Maximum amount of time before an unused on-demand fleet is hibernated, e.g. '1h'
'ID':
type: 'string'
required: true
'ImageDeploymentProfile':
type: '*APIImageDeploymentProfile'
required: true
'IsLocal':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
'OnDemand':
type: 'bool'
required: true
'PrimaryFleet':
type: 'string'
required: true
'Regions':
type: '[]*APIRegionConfig'
required: true
'SamplingRules':
type: '*APIFleetArtifactsSampleRules'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_get_response.go'
'APIFleetListItemResponse@go.ams.mod':
id: 'APIFleetListItemResponse@go.ams.mod'
name: 'APIFleetListItemResponse'
type: 'model'
fields:
'Active':
type: 'bool'
required: true
'Counts':
type: '[]*APIFleetRegionalServerCounts'
required: true
'FallbackFleet':
type: 'string'
required: true
'ID':
type: 'string'
required: true
'Image':
type: 'string'
required: true
'InstanceProvider':
type: 'string'
required: true
'IsLocal':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
'OnDemand':
type: 'bool'
required: true
'PrimaryFleet':
type: 'string'
required: true
'Regions':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_list_item_response.go'
'APIFleetListResponse@go.ams.mod':
id: 'APIFleetListResponse@go.ams.mod'
name: 'APIFleetListResponse'
type: 'model'
fields:
'Fleets':
type: '[]*APIFleetListItemResponse'
required: true
'Paging':
type: '*PaginationPaginationInfo'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_list_response.go'
'APIFleetParameters@go.ams.mod':
id: 'APIFleetParameters@go.ams.mod'
name: 'APIFleetParameters'
type: 'model'
fields:
'Active':
type: 'bool'
required: true
'ClaimKeys':
type: '[]string'
required: false
'DsHostConfiguration':
type: '*APIDSHostConfigurationParameters'
required: true
'FallbackFleet':
type: 'string'
required: false
'HibernateAfterPeriod':
type: 'string'
required: false
description: |-
Amount of time before an unused on-demand fleet is hibernated, e.g. '1h'
'ImageDeploymentProfile':
type: '*APIImageDeploymentProfile'
required: true
'Name':
type: 'string'
required: true
'OnDemand':
type: 'bool'
required: true
'Regions':
type: '[]*APIRegionConfig'
required: true
'SamplingRules':
type: '*APIFleetArtifactsSampleRules'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_parameters.go'
'APIFleetRegionalServerCounts@go.ams.mod':
id: 'APIFleetRegionalServerCounts@go.ams.mod'
name: 'APIFleetRegionalServerCounts'
type: 'model'
fields:
'ClaimedServerCount':
type: 'int32'
required: true
'ReadyServerCount':
type: 'int32'
required: true
'Region':
type: 'string'
required: true
'RunningVMCount':
type: 'int32'
required: true
'TargetDsCount':
type: 'int32'
required: true
'TargetVMCount':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_regional_server_counts.go'
'APIFleetServerConnectionInfoResponse@go.ams.mod':
id: 'APIFleetServerConnectionInfoResponse@go.ams.mod'
name: 'APIFleetServerConnectionInfoResponse'
type: 'model'
fields:
'ExpiresAt':
type: 'string'
required: true
'Host':
type: 'string'
required: true
'LogstreamPort':
type: 'int32'
required: true
'Secret':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_server_connection_info_response.go'
'APIFleetServerHistoryEventResponse@go.ams.mod':
id: 'APIFleetServerHistoryEventResponse@go.ams.mod'
name: 'APIFleetServerHistoryEventResponse'
type: 'model'
fields:
'CreatedAt':
type: 'string'
required: true
'ExitCode':
type: 'int32'
required: true
'FleetID':
type: 'string'
required: true
'NewState':
type: 'string'
required: true
'OldState':
type: 'string'
required: true
'Reason':
type: 'string'
required: true
'ServerID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_server_history_event_response.go'
'APIFleetServerHistoryResponse@go.ams.mod':
id: 'APIFleetServerHistoryResponse@go.ams.mod'
name: 'APIFleetServerHistoryResponse'
type: 'model'
fields:
'Events':
type: '[]*APIFleetServerHistoryEventResponse'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_server_history_response.go'
'APIFleetServerInfoResponse@go.ams.mod':
id: 'APIFleetServerInfoResponse@go.ams.mod'
name: 'APIFleetServerInfoResponse'
type: 'model'
fields:
'CreatedAt':
type: 'string'
required: true
'FleetID':
type: 'string'
required: true
'FleetName':
type: 'string'
required: true
'ImageCmd':
type: 'string'
required: true
'ImageID':
type: 'string'
required: true
'InstanceType':
type: 'string'
required: true
'IPAddress':
type: 'string'
required: true
'PortConfiguration':
type: '[]*APIPortConfiguration'
required: true
'Ports':
type: 'map[string]int64'
required: true
'Region':
type: 'string'
required: true
'ServerConfiguration':
type: 'string'
required: true
'ServerID':
type: 'string'
required: true
'SessionID':
type: 'string'
required: true
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_server_info_response.go'
'APIFleetServersResponse@go.ams.mod':
id: 'APIFleetServersResponse@go.ams.mod'
name: 'APIFleetServersResponse'
type: 'model'
fields:
'Paging':
type: '*APIPagingInfo'
required: true
'Regions':
type: '[]*APIFleetRegionalServerCounts'
required: true
'Servers':
type: '[]*APIFleetServerInfoResponse'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_fleet_servers_response.go'
'APIImageDeploymentProfile@go.ams.mod':
id: 'APIImageDeploymentProfile@go.ams.mod'
name: 'APIImageDeploymentProfile'
type: 'model'
fields:
'CommandLine':
type: 'string'
required: true
'ImageID':
type: 'string'
required: true
'PortConfigurations':
type: '[]*APIPortConfiguration'
required: true
'Timeout':
type: '*APITimeout'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_image_deployment_profile.go'
'APIImageDetails@go.ams.mod':
id: 'APIImageDetails@go.ams.mod'
name: 'APIImageDetails'
type: 'model'
fields:
'CreatedAt':
type: 'string'
required: true
'DeleteAt':
type: 'string'
required: false
'Executable':
type: 'string'
required: true
'ID':
type: 'string'
required: true
'IsProtected':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
'ReferencingFleets':
type: '[]*APIReferencingFleet'
required: true
'SizeInByte':
type: 'int64'
required: true
'Status':
type: 'string'
required: true
'Tags':
type: '[]string'
required: true
'TargetArchitecture':
type: 'string'
required: true
'UploadedAt':
type: 'string'
required: true
'UploadedBy':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_image_details.go'
'APIImageList@go.ams.mod':
id: 'APIImageList@go.ams.mod'
name: 'APIImageList'
type: 'model'
fields:
'Images':
type: '[]*APIImageListItem'
required: true
'Paging':
type: '*APIPagingInfo'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_image_list.go'
'APIImageListItem@go.ams.mod':
id: 'APIImageListItem@go.ams.mod'
name: 'APIImageListItem'
type: 'model'
fields:
'CreatedAt':
type: 'string'
required: true
'DeleteAt':
type: 'string'
required: false
'Executable':
type: 'string'
required: true
'ID':
type: 'string'
required: true
'IsProtected':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
'ReferencingConfigs':
type: 'int32'
required: true
'ReferencingFleets':
type: 'int32'
required: true
'SizeInByte':
type: 'int64'
required: true
'Status':
type: 'string'
required: true
'Tags':
type: '[]string'
required: true
'TargetArchitecture':
type: 'string'
required: true
'UploadedAt':
type: 'string'
required: true
'UploadedBy':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_image_list_item.go'
'APIImageStorage@go.ams.mod':
id: 'APIImageStorage@go.ams.mod'
name: 'APIImageStorage'
type: 'model'
fields:
'CurrentMarkedForDeletionBytes':
type: 'int64'
required: true
'CurrentUsageBytes':
type: 'int64'
required: true
'QuotaBytes':
type: 'int64'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_image_storage.go'
'APIImageUpdate@go.ams.mod':
id: 'APIImageUpdate@go.ams.mod'
name: 'APIImageUpdate'
type: 'model'
fields:
'AddedTags':
type: '[]string'
required: true
'IsProtected':
type: 'bool'
required: false
'Name':
type: 'string'
required: false
'RemovedTags':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_image_update.go'
'APIInstanceType@go.ams.mod':
id: 'APIInstanceType@go.ams.mod'
name: 'APIInstanceType'
type: 'model'
fields:
'Capacity':
type: '[]*APICapacity'
required: true
'Description':
type: 'string'
required: true
'ID':
type: 'string'
required: true
'IsBaremetal':
type: 'bool'
required: true
'MemoryGiB':
type: 'float64'
required: true
'MinSpeed':
type: 'string'
required: true
'Name':
type: 'string'
required: true
'OwnerAccountID':
type: 'string'
required: true
'ProcessorArchitecture':
type: 'string'
required: true
'Provider':
type: 'string'
required: true
'VirtualCPU':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_instance_type.go'
'APIInstanceTypesResponse@go.ams.mod':
id: 'APIInstanceTypesResponse@go.ams.mod'
name: 'APIInstanceTypesResponse'
type: 'model'
fields:
'AvailableInstanceTypes':
type: '[]*APIInstanceType'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_instance_types_response.go'
'APIPagingInfo@go.ams.mod':
id: 'APIPagingInfo@go.ams.mod'
name: 'APIPagingInfo'
type: 'model'
fields:
'CurrentPage':
type: 'int32'
required: true
'HasNext':
type: 'bool'
required: true
'HasPages':
type: 'bool'
required: true
'HasPrev':
type: 'bool'
required: true
'Next':
type: 'string'
required: true
'PageNums':
type: '[]int32'
required: true
'Previous':
type: 'string'
required: true
'Total':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_paging_info.go'
'APIPortConfiguration@go.ams.mod':
id: 'APIPortConfiguration@go.ams.mod'
name: 'APIPortConfiguration'
type: 'model'
fields:
'Name':
type: 'string'
required: true
'Protocol':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_port_configuration.go'
'APIQoSEndpointResponse@go.ams.mod':
id: 'APIQoSEndpointResponse@go.ams.mod'
name: 'APIQoSEndpointResponse'
type: 'model'
fields:
'Servers':
type: '[]*APIQoSServer'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_qo_s_endpoint_response.go'
'APIQoSServer@go.ams.mod':
id: 'APIQoSServer@go.ams.mod'
name: 'APIQoSServer'
type: 'model'
fields:
'Alias':
type: 'string'
required: true
'IP':
type: 'string'
required: true
'LastUpdate':
type: 'string'
required: true
'Port':
type: 'int32'
required: true
'Region':
type: 'string'
required: true
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_qo_s_server.go'
'APIReferencingFleet@go.ams.mod':
id: 'APIReferencingFleet@go.ams.mod'
name: 'APIReferencingFleet'
type: 'model'
fields:
'Environment':
type: 'string'
required: true
'FleetID':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_referencing_fleet.go'
'APIRegionConfig@go.ams.mod':
id: 'APIRegionConfig@go.ams.mod'
name: 'APIRegionConfig'
type: 'model'
fields:
'BufferSize':
type: 'int32'
required: true
'DynamicBuffer':
type: 'bool'
required: true
'MaxServerCount':
type: 'int32'
required: true
'MinServerCount':
type: 'int32'
required: true
'Region':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_region_config.go'
'APITimeout@go.ams.mod':
id: 'APITimeout@go.ams.mod'
name: 'APITimeout'
type: 'model'
description: |-
Contains fleet timeout configuration. Fields accept duration strings (e.g. '30s', '1h30m'), an integer number of seconds.
fields:
'Claim':
type: 'int64'
required: false
description: |-
Maximum time allowed for the DS to be claimed after it is created. (e.g. '4h')
'Creation':
type: 'int64'
required: false
description: |-
Maximum time allowed for the DS to become ready. (e.g. '30s')
'Drain':
type: 'int64'
required: false
description: |-
Maximum time allowed for the DS to drain gracefully after a drain signal before being terminated. (e.g. '30s')
'Session':
type: 'int64'
required: false
description: |-
Maximum time the game session will be allowed to run, (e.g. '1h30m')
'Unresponsive':
type: 'int64'
required: false
description: |-
Maximum time allowed for the DS to be unresponsive before being terminated. (e.g. '1m')
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_timeout.go'
'APIUpdateServerRequest@go.ams.mod':
id: 'APIUpdateServerRequest@go.ams.mod'
name: 'APIUpdateServerRequest'
type: 'model'
fields:
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/api_update_server_request.go'
'PaginationPaginationInfo@go.ams.mod':
id: 'PaginationPaginationInfo@go.ams.mod'
name: 'PaginationPaginationInfo'
type: 'model'
fields:
'First':
type: 'string'
required: true
'Last':
type: 'string'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
'Total':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/pagination_pagination_info.go'
'ResponseErrorResponse@go.ams.mod':
id: 'ResponseErrorResponse@go.ams.mod'
name: 'ResponseErrorResponse'
type: 'model'
fields:
'ErrorMessage':
type: 'string'
required: true
'ErrorType':
type: 'string'
required: true
'TraceID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/ams-sdk/pkg/amsclientmodels/response_error_response.go'
# endregion models
# region functions
'AccountGetShort@go.ams.fun':
id: 'AccountGetShort@go.ams.fun'
name: 'AccountGetShort'
type: 'function'
description: |-
Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
struct: 'AccountService'
arguments:
params:
type: '*account.AccountGetParams'
required: true
return_type: '(*account.AccountGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/account.go'
example: |-
accountService := ams.AccountService{ ... }
params := account.AccountGetParams{ ... }
res, err := accountService.AccountGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'get'
'AdminAccountCreateShort@go.ams.fun':
id: 'AdminAccountCreateShort@go.ams.fun'
name: 'AdminAccountCreateShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
struct: 'AccountService'
arguments:
params:
type: '*account.AdminAccountCreateParams'
required: true
return_type: '(*account.AdminAccountCreateResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/account.go'
example: |-
accountService := ams.AccountService{ ... }
params := account.AdminAccountCreateParams{ ... }
res, err := accountService.AdminAccountCreateShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'create'
'AdminAccountGetShort@go.ams.fun':
id: 'AdminAccountGetShort@go.ams.fun'
name: 'AdminAccountGetShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
struct: 'AccountService'
arguments:
params:
type: '*account.AdminAccountGetParams'
required: true
return_type: '(*account.AdminAccountGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/account.go'
example: |-
accountService := ams.AccountService{ ... }
params := account.AdminAccountGetParams{ ... }
res, err := accountService.AdminAccountGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'get'
'AdminAccountLinkShort@go.ams.fun':
id: 'AdminAccountLinkShort@go.ams.fun'
name: 'AdminAccountLinkShort'
type: 'function'
description: |-
This route will attempt to register the account to namespace linkage in AMS and requires a valid account link token. This route fails if an account is already linked
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
struct: 'AccountService'
arguments:
params:
type: '*account.AdminAccountLinkParams'
required: true
return_type: '(*account.AdminAccountLinkResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/account.go'
example: |-
accountService := ams.AccountService{ ... }
params := account.AdminAccountLinkParams{ ... }
res, err := accountService.AdminAccountLinkShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'link'
'AdminAccountLinkTokenGetShort@go.ams.fun':
id: 'AdminAccountLinkTokenGetShort@go.ams.fun'
name: 'AdminAccountLinkTokenGetShort'
type: 'function'
description: |-
The link token returned can be used to connect another namespace to the account in which the provided namespace is linked. This route fails if there is no account linked to the specified namespace.
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
struct: 'AccountService'
arguments:
params:
type: '*account.AdminAccountLinkTokenGetParams'
required: true
return_type: '(*account.AdminAccountLinkTokenGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/account'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/account.go'
example: |-
accountService := ams.AccountService{ ... }
params := account.AdminAccountLinkTokenGetParams{ ... }
res, err := accountService.AdminAccountLinkTokenGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'get'
- 'link'
- 'token'
'ArtifactBulkDeleteShort@go.ams.fun':
id: 'ArtifactBulkDeleteShort@go.ams.fun'
name: 'ArtifactBulkDeleteShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
struct: 'ArtifactsService'
arguments:
params:
type: '*artifacts.ArtifactBulkDeleteParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/artifacts.go'
example: |-
artifactsService := ams.ArtifactsService{ ... }
params := artifacts.ArtifactBulkDeleteParams{ ... }
res, err := artifactsService.ArtifactBulkDeleteShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'artifact'
- 'artifacts'
- 'bulk'
- 'delete'
'ArtifactDeleteShort@go.ams.fun':
id: 'ArtifactDeleteShort@go.ams.fun'
name: 'ArtifactDeleteShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
struct: 'ArtifactsService'
arguments:
params:
type: '*artifacts.ArtifactDeleteParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/artifacts.go'
example: |-
artifactsService := ams.ArtifactsService{ ... }
params := artifacts.ArtifactDeleteParams{ ... }
res, err := artifactsService.ArtifactDeleteShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'artifact'
- 'artifacts'
- 'delete'
'ArtifactGetShort@go.ams.fun':
id: 'ArtifactGetShort@go.ams.fun'
name: 'ArtifactGetShort'
type: 'function'
description: |-
Get all artifacts matching the provided search criteria. When criteria is not specified the data returned won't have been filtered on those parameters
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
struct: 'ArtifactsService'
arguments:
params:
type: '*artifacts.ArtifactGetParams'
required: true
return_type: '(*artifacts.ArtifactGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/artifacts.go'
example: |-
artifactsService := ams.ArtifactsService{ ... }
params := artifacts.ArtifactGetParams{ ... }
res, err := artifactsService.ArtifactGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'artifact'
- 'artifacts'
- 'get'
'ArtifactGetURLShort@go.ams.fun':
id: 'ArtifactGetURLShort@go.ams.fun'
name: 'ArtifactGetURLShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
struct: 'ArtifactsService'
arguments:
params:
type: '*artifacts.ArtifactGetURLParams'
required: true
return_type: '(*artifacts.ArtifactGetURLResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/artifacts.go'
example: |-
artifactsService := ams.ArtifactsService{ ... }
params := artifacts.ArtifactGetURLParams{ ... }
res, err := artifactsService.ArtifactGetURLShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'artifact'
- 'artifacts'
- 'get'
- 'url'
'ArtifactUsageGetShort@go.ams.fun':
id: 'ArtifactUsageGetShort@go.ams.fun'
name: 'ArtifactUsageGetShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
struct: 'ArtifactsService'
arguments:
params:
type: '*artifacts.ArtifactUsageGetParams'
required: true
return_type: '(*artifacts.ArtifactUsageGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/artifacts.go'
example: |-
artifactsService := ams.ArtifactsService{ ... }
params := artifacts.ArtifactUsageGetParams{ ... }
res, err := artifactsService.ArtifactUsageGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'artifact'
- 'artifacts'
- 'get'
- 'usage'
'AuthCheckShort@go.ams.fun':
id: 'AuthCheckShort@go.ams.fun'
name: 'AuthCheckShort'
type: 'function'
description: |-
Check if fleet commander is authorized to talk to AMS with this IAM
struct: 'AuthService'
arguments:
params:
type: '*auth.AuthCheckParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/auth'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/auth.go'
example: |-
authService := ams.AuthService{ ... }
params := auth.AuthCheckParams{ ... }
res, err := authService.AuthCheckShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'auth'
- 'check'
'BasicHealthCheckShort@go.ams.fun':
id: 'BasicHealthCheckShort@go.ams.fun'
name: 'BasicHealthCheckShort'
type: 'function'
struct: 'FleetCommanderService'
arguments:
params:
type: '*fleet_commander.BasicHealthCheckParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleet_commander'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleetCommander.go'
example: |-
fleetCommanderService := ams.FleetCommanderService{ ... }
params := fleet_commander.BasicHealthCheckParams{ ... }
res, err := fleetCommanderService.BasicHealthCheckShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'basic'
- 'check'
- 'commander'
- 'fleet'
- 'health'
'BulkFleetDeleteShort@go.ams.fun':
id: 'BulkFleetDeleteShort@go.ams.fun'
name: 'BulkFleetDeleteShort'
type: 'function'
description: |-
Maximum of 1000 fleets allowed
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.BulkFleetDeleteParams'
required: true
return_type: '(*fleets.BulkFleetDeleteResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.BulkFleetDeleteParams{ ... }
res, err := fleetsService.BulkFleetDeleteShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'bulk'
- 'delete'
- 'fleet'
- 'fleets'
'DevelopmentServerConfigurationCreateShort@go.ams.fun':
id: 'DevelopmentServerConfigurationCreateShort@go.ams.fun'
name: 'DevelopmentServerConfigurationCreateShort'
type: 'function'
description: |-
Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
struct: 'DevelopmentService'
arguments:
params:
type: '*development.DevelopmentServerConfigurationCreateParams'
required: true
return_type: '(*development.DevelopmentServerConfigurationCreateResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/development.go'
example: |-
developmentService := ams.DevelopmentService{ ... }
params := development.DevelopmentServerConfigurationCreateParams{ ... }
res, err := developmentService.DevelopmentServerConfigurationCreateShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'configuration'
- 'create'
- 'development'
- 'server'
'DevelopmentServerConfigurationDeleteShort@go.ams.fun':
id: 'DevelopmentServerConfigurationDeleteShort@go.ams.fun'
name: 'DevelopmentServerConfigurationDeleteShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
struct: 'DevelopmentService'
arguments:
params:
type: '*development.DevelopmentServerConfigurationDeleteParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/development.go'
example: |-
developmentService := ams.DevelopmentService{ ... }
params := development.DevelopmentServerConfigurationDeleteParams{ ... }
res, err := developmentService.DevelopmentServerConfigurationDeleteShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'configuration'
- 'delete'
- 'development'
- 'server'
'DevelopmentServerConfigurationGetShort@go.ams.fun':
id: 'DevelopmentServerConfigurationGetShort@go.ams.fun'
name: 'DevelopmentServerConfigurationGetShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
struct: 'DevelopmentService'
arguments:
params:
type: '*development.DevelopmentServerConfigurationGetParams'
required: true
return_type: '(*development.DevelopmentServerConfigurationGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/development.go'
example: |-
developmentService := ams.DevelopmentService{ ... }
params := development.DevelopmentServerConfigurationGetParams{ ... }
res, err := developmentService.DevelopmentServerConfigurationGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'configuration'
- 'development'
- 'get'
- 'server'
'DevelopmentServerConfigurationListShort@go.ams.fun':
id: 'DevelopmentServerConfigurationListShort@go.ams.fun'
name: 'DevelopmentServerConfigurationListShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
struct: 'DevelopmentService'
arguments:
params:
type: '*development.DevelopmentServerConfigurationListParams'
required: true
return_type: '(*development.DevelopmentServerConfigurationListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/development.go'
example: |-
developmentService := ams.DevelopmentService{ ... }
params := development.DevelopmentServerConfigurationListParams{ ... }
res, err := developmentService.DevelopmentServerConfigurationListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'configuration'
- 'development'
- 'list'
- 'server'
'DevelopmentServerConfigurationPatchShort@go.ams.fun':
id: 'DevelopmentServerConfigurationPatchShort@go.ams.fun'
name: 'DevelopmentServerConfigurationPatchShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
struct: 'DevelopmentService'
arguments:
params:
type: '*development.DevelopmentServerConfigurationPatchParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/development'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/development.go'
example: |-
developmentService := ams.DevelopmentService{ ... }
params := development.DevelopmentServerConfigurationPatchParams{ ... }
res, err := developmentService.DevelopmentServerConfigurationPatchShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'configuration'
- 'development'
- 'patch'
- 'server'
'FleetArtifactSamplingRulesGetShort@go.ams.fun':
id: 'FleetArtifactSamplingRulesGetShort@go.ams.fun'
name: 'FleetArtifactSamplingRulesGetShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
struct: 'ArtifactsService'
arguments:
params:
type: '*artifacts.FleetArtifactSamplingRulesGetParams'
required: true
return_type: '(*artifacts.FleetArtifactSamplingRulesGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/artifacts.go'
example: |-
artifactsService := ams.ArtifactsService{ ... }
params := artifacts.FleetArtifactSamplingRulesGetParams{ ... }
res, err := artifactsService.FleetArtifactSamplingRulesGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'artifact'
- 'artifacts'
- 'fleet'
- 'get'
- 'rules'
- 'sampling'
'FleetArtifactSamplingRulesSetShort@go.ams.fun':
id: 'FleetArtifactSamplingRulesSetShort@go.ams.fun'
name: 'FleetArtifactSamplingRulesSetShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
struct: 'ArtifactsService'
arguments:
params:
type: '*artifacts.FleetArtifactSamplingRulesSetParams'
required: true
return_type: '(*artifacts.FleetArtifactSamplingRulesSetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/artifacts'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/artifacts.go'
example: |-
artifactsService := ams.ArtifactsService{ ... }
params := artifacts.FleetArtifactSamplingRulesSetParams{ ... }
res, err := artifactsService.FleetArtifactSamplingRulesSetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'artifact'
- 'artifacts'
- 'fleet'
- 'rules'
- 'sampling'
- 'set'
'FleetClaimByIDShort@go.ams.fun':
id: 'FleetClaimByIDShort@go.ams.fun'
name: 'FleetClaimByIDShort'
type: 'function'
description: |-
Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.FleetClaimByIDParams'
required: true
return_type: '(*fleets.FleetClaimByIDResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.FleetClaimByIDParams{ ... }
res, err := fleetsService.FleetClaimByIDShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'by'
- 'claim'
- 'fleet'
- 'fleets'
- 'id'
'FleetClaimByKeysShort@go.ams.fun':
id: 'FleetClaimByKeysShort@go.ams.fun'
name: 'FleetClaimByKeysShort'
type: 'function'
description: |-
Claim a dedicated server from fleets with matching claim keys.
If the claim key is for a regular fleet (non development), the request will instantly fail if there are no DS available (HTTP 404).
If the claim key is for a development fleet and there are no DS available, a new DS will be launched and the request might take up to 8 seconds to return (depending on the environment configuration). If it's not ready after that duration the request will still return HTTP 404. In either case, the call to this endpoint may be retried at any time to check if a DS has become available.
Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.FleetClaimByKeysParams'
required: true
return_type: '(*fleets.FleetClaimByKeysResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.FleetClaimByKeysParams{ ... }
res, err := fleetsService.FleetClaimByKeysShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'by'
- 'claim'
- 'fleet'
- 'fleets'
- 'keys'
'FleetCreateShort@go.ams.fun':
id: 'FleetCreateShort@go.ams.fun'
name: 'FleetCreateShort'
type: 'function'
description: |-
Optionally, sampling rules for the fleet can also be specified
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.FleetCreateParams'
required: true
return_type: '(*fleets.FleetCreateResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.FleetCreateParams{ ... }
res, err := fleetsService.FleetCreateShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'create'
- 'fleet'
- 'fleets'
'FleetDeleteShort@go.ams.fun':
id: 'FleetDeleteShort@go.ams.fun'
name: 'FleetDeleteShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.FleetDeleteParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.FleetDeleteParams{ ... }
res, err := fleetsService.FleetDeleteShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'delete'
- 'fleet'
- 'fleets'
'FleetGetShort@go.ams.fun':
id: 'FleetGetShort@go.ams.fun'
name: 'FleetGetShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.FleetGetParams'
required: true
return_type: '(*fleets.FleetGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.FleetGetParams{ ... }
res, err := fleetsService.FleetGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'fleet'
- 'fleets'
- 'get'
'FleetListShort@go.ams.fun':
id: 'FleetListShort@go.ams.fun'
name: 'FleetListShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.FleetListParams'
required: true
return_type: '(*fleets.FleetListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.FleetListParams{ ... }
res, err := fleetsService.FleetListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'fleet'
- 'fleets'
- 'list'
'FleetServerConnectionInfoShort@go.ams.fun':
id: 'FleetServerConnectionInfoShort@go.ams.fun'
name: 'FleetServerConnectionInfoShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
struct: 'ServersService'
arguments:
params:
type: '*servers.FleetServerConnectionInfoParams'
required: true
return_type: '(*servers.FleetServerConnectionInfoResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/servers'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/servers.go'
example: |-
serversService := ams.ServersService{ ... }
params := servers.FleetServerConnectionInfoParams{ ... }
res, err := serversService.FleetServerConnectionInfoShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'connection'
- 'fleet'
- 'info'
- 'server'
- 'servers'
'FleetServerHistoryShort@go.ams.fun':
id: 'FleetServerHistoryShort@go.ams.fun'
name: 'FleetServerHistoryShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
struct: 'ServersService'
arguments:
params:
type: '*servers.FleetServerHistoryParams'
required: true
return_type: '(*servers.FleetServerHistoryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/servers'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/servers.go'
example: |-
serversService := ams.ServersService{ ... }
params := servers.FleetServerHistoryParams{ ... }
res, err := serversService.FleetServerHistoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'fleet'
- 'history'
- 'server'
- 'servers'
'FleetServerInfoShort@go.ams.fun':
id: 'FleetServerInfoShort@go.ams.fun'
name: 'FleetServerInfoShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
struct: 'ServersService'
arguments:
params:
type: '*servers.FleetServerInfoParams'
required: true
return_type: '(*servers.FleetServerInfoResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/servers'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/servers.go'
example: |-
serversService := ams.ServersService{ ... }
params := servers.FleetServerInfoParams{ ... }
res, err := serversService.FleetServerInfoShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'fleet'
- 'info'
- 'server'
- 'servers'
'FleetServersShort@go.ams.fun':
id: 'FleetServersShort@go.ams.fun'
name: 'FleetServersShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.FleetServersParams'
required: true
return_type: '(*fleets.FleetServersResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.FleetServersParams{ ... }
res, err := fleetsService.FleetServersShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'fleet'
- 'fleets'
- 'servers'
'FleetUpdateShort@go.ams.fun':
id: 'FleetUpdateShort@go.ams.fun'
name: 'FleetUpdateShort'
type: 'function'
description: |-
Optionally, sampling rules for the fleet can also be updated
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
struct: 'FleetsService'
arguments:
params:
type: '*fleets.FleetUpdateParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleets.go'
example: |-
fleetsService := ams.FleetsService{ ... }
params := fleets.FleetUpdateParams{ ... }
res, err := fleetsService.FleetUpdateShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'fleet'
- 'fleets'
- 'update'
'Func1Short@go.ams.fun':
id: 'Func1Short@go.ams.fun'
name: 'Func1Short'
type: 'function'
struct: 'FleetCommanderService'
arguments:
params:
type: '*fleet_commander.Func1Params'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleet_commander'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleetCommander.go'
example: |-
fleetCommanderService := ams.FleetCommanderService{ ... }
params := fleet_commander.Func1Params{ ... }
res, err := fleetCommanderService.Func1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'commander'
- 'fleet'
- 'func1'
'ImageGetShort@go.ams.fun':
id: 'ImageGetShort@go.ams.fun'
name: 'ImageGetShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
struct: 'ImagesService'
arguments:
params:
type: '*images.ImageGetParams'
required: true
return_type: '(*images.ImageGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/images.go'
example: |-
imagesService := ams.ImagesService{ ... }
params := images.ImageGetParams{ ... }
res, err := imagesService.ImageGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'get'
- 'image'
- 'images'
'ImageListShort@go.ams.fun':
id: 'ImageListShort@go.ams.fun'
name: 'ImageListShort'
type: 'function'
description: |-
Returns images which exist (uploaded, uploading, or building) in the linked account. This route fails if no account is linked
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
struct: 'ImagesService'
arguments:
params:
type: '*images.ImageListParams'
required: true
return_type: '(*images.ImageListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/images.go'
example: |-
imagesService := ams.ImagesService{ ... }
params := images.ImageListParams{ ... }
res, err := imagesService.ImageListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'image'
- 'images'
- 'list'
'ImageMarkForDeletionShort@go.ams.fun':
id: 'ImageMarkForDeletionShort@go.ams.fun'
name: 'ImageMarkForDeletionShort'
type: 'function'
description: |-
Marks an image for deletion. The image will stop being available for fleets and will eventually be deleted.
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
struct: 'ImagesService'
arguments:
params:
type: '*images.ImageMarkForDeletionParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/images.go'
example: |-
imagesService := ams.ImagesService{ ... }
params := images.ImageMarkForDeletionParams{ ... }
res, err := imagesService.ImageMarkForDeletionShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'deletion'
- 'for'
- 'image'
- 'images'
- 'mark'
'ImagePatchShort@go.ams.fun':
id: 'ImagePatchShort@go.ams.fun'
name: 'ImagePatchShort'
type: 'function'
description: |-
This allows editing of the image name, toggling `IsProtected`, or adding & removal of tags
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
struct: 'ImagesService'
arguments:
params:
type: '*images.ImagePatchParams'
required: true
return_type: '(*images.ImagePatchResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/images.go'
example: |-
imagesService := ams.ImagesService{ ... }
params := images.ImagePatchParams{ ... }
res, err := imagesService.ImagePatchShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'image'
- 'images'
- 'patch'
'ImagesStorageShort@go.ams.fun':
id: 'ImagesStorageShort@go.ams.fun'
name: 'ImagesStorageShort'
type: 'function'
description: |-
Returns information regarding the account's usage for images storage including the free tier quota
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
struct: 'ImagesService'
arguments:
params:
type: '*images.ImagesStorageParams'
required: true
return_type: '(*images.ImagesStorageResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/images.go'
example: |-
imagesService := ams.ImagesService{ ... }
params := images.ImagesStorageParams{ ... }
res, err := imagesService.ImagesStorageShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'images'
- 'storage'
'ImageUnmarkForDeletionShort@go.ams.fun':
id: 'ImageUnmarkForDeletionShort@go.ams.fun'
name: 'ImageUnmarkForDeletionShort'
type: 'function'
description: |-
Unmarks an image for deletion. The image will be available for fleets.
Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
struct: 'ImagesService'
arguments:
params:
type: '*images.ImageUnmarkForDeletionParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/images'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/images.go'
example: |-
imagesService := ams.ImagesService{ ... }
params := images.ImageUnmarkForDeletionParams{ ... }
res, err := imagesService.ImageUnmarkForDeletionShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'deletion'
- 'for'
- 'image'
- 'images'
- 'unmark'
'InfoRegionsShort@go.ams.fun':
id: 'InfoRegionsShort@go.ams.fun'
name: 'InfoRegionsShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
struct: 'AMSInfoService'
arguments:
params:
type: '*a_m_s_info.InfoRegionsParams'
required: true
return_type: '(*a_m_s_info.InfoRegionsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_info'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/aMSInfo.go'
example: |-
amsInfoService := ams.AMSInfoService{ ... }
params := a_m_s_info.InfoRegionsParams{ ... }
res, err := amsInfoService.InfoRegionsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'ams'
- 'info'
- 'regions'
'InfoSupportedInstancesShort@go.ams.fun':
id: 'InfoSupportedInstancesShort@go.ams.fun'
name: 'InfoSupportedInstancesShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
struct: 'AMSInfoService'
arguments:
params:
type: '*a_m_s_info.InfoSupportedInstancesParams'
required: true
return_type: '(*a_m_s_info.InfoSupportedInstancesResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_info'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/aMSInfo.go'
example: |-
amsInfoService := ams.AMSInfoService{ ... }
params := a_m_s_info.InfoSupportedInstancesParams{ ... }
res, err := amsInfoService.InfoSupportedInstancesShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'ams'
- 'info'
- 'instances'
- 'supported'
'LocalWatchdogConnectShort@go.ams.fun':
id: 'LocalWatchdogConnectShort@go.ams.fun'
name: 'LocalWatchdogConnectShort'
type: 'function'
description: |-
This is to support local ds development scenarios
Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
struct: 'WatchdogsService'
arguments:
params:
type: '*watchdogs.LocalWatchdogConnectParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/watchdogs'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/watchdogs.go'
example: |-
watchdogsService := ams.WatchdogsService{ ... }
params := watchdogs.LocalWatchdogConnectParams{ ... }
res, err := watchdogsService.LocalWatchdogConnectShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'connect'
- 'local'
- 'watchdog'
- 'watchdogs'
'PortalHealthCheckShort@go.ams.fun':
id: 'PortalHealthCheckShort@go.ams.fun'
name: 'PortalHealthCheckShort'
type: 'function'
struct: 'FleetCommanderService'
arguments:
params:
type: '*fleet_commander.PortalHealthCheckParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/fleet_commander'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/fleetCommander.go'
example: |-
fleetCommanderService := ams.FleetCommanderService{ ... }
params := fleet_commander.PortalHealthCheckParams{ ... }
res, err := fleetCommanderService.PortalHealthCheckShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'check'
- 'commander'
- 'fleet'
- 'health'
- 'portal'
'QoSRegionsGetShort@go.ams.fun':
id: 'QoSRegionsGetShort@go.ams.fun'
name: 'QoSRegionsGetShort'
type: 'function'
description: |-
```
Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [READ]
This endpoint lists all QoS services available in all regions.
This endpoint is intended to be called by game client to find out all available regions.
After getting a list of QoS on each region, game client is expected to ping each one with UDP
connection as described below:
1. Make UDP connection to each QoS's IP:Port
2. Send string "PING" after connection established
3. Wait for string "PONG" response
4. Note the request-response latency for each QoS in each region
The game then can use ping latency information to either:
1. Inform the player on these latencies and let player choose preferred region
2. Send the latency list to Matchmaking Service so that player can be matched with other players
in nearby regions
struct: 'AMSQoSService'
arguments:
params:
type: '*a_m_s_qo_s.QoSRegionsGetParams'
required: true
return_type: '(*a_m_s_qo_s.QoSRegionsGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_qo_s'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/aMSQoS.go'
example: |-
amsQoSService := ams.AMSQoSService{ ... }
params := a_m_s_qo_s.QoSRegionsGetParams{ ... }
res, err := amsQoSService.QoSRegionsGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'ams'
- 'get'
- 'qo'
- 'regions'
- 's'
'QoSRegionsUpdateShort@go.ams.fun':
id: 'QoSRegionsUpdateShort@go.ams.fun'
name: 'QoSRegionsUpdateShort'
type: 'function'
description: |-
```
Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE]
This endpoint updates the registered QoS service's configurable configuration.
struct: 'AMSQoSService'
arguments:
params:
type: '*a_m_s_qo_s.QoSRegionsUpdateParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_qo_s'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/aMSQoS.go'
example: |-
amsQoSService := ams.AMSQoSService{ ... }
params := a_m_s_qo_s.QoSRegionsUpdateParams{ ... }
res, err := amsQoSService.QoSRegionsUpdateShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'ams'
- 'qo'
- 'regions'
- 's'
- 'update'
'ServerHistoryShort@go.ams.fun':
id: 'ServerHistoryShort@go.ams.fun'
name: 'ServerHistoryShort'
type: 'function'
description: |-
Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
struct: 'ServersService'
arguments:
params:
type: '*servers.ServerHistoryParams'
required: true
return_type: '(*servers.ServerHistoryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/servers'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/servers.go'
example: |-
serversService := ams.ServersService{ ... }
params := servers.ServerHistoryParams{ ... }
res, err := serversService.ServerHistoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'history'
- 'server'
- 'servers'
'UploadURLGetShort@go.ams.fun':
id: 'UploadURLGetShort@go.ams.fun'
name: 'UploadURLGetShort'
type: 'function'
struct: 'AMSInfoService'
arguments:
params:
type: '*a_m_s_info.UploadURLGetParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/a_m_s_info'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/aMSInfo.go'
example: |-
amsInfoService := ams.AMSInfoService{ ... }
params := a_m_s_info.UploadURLGetParams{ ... }
res, err := amsInfoService.UploadURLGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'ams'
- 'get'
- 'info'
- 'upload'
- 'url'
'WatchdogConnectShort@go.ams.fun':
id: 'WatchdogConnectShort@go.ams.fun'
name: 'WatchdogConnectShort'
type: 'function'
description: |-
Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
struct: 'WatchdogsService'
arguments:
params:
type: '*watchdogs.WatchdogConnectParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/ams-sdk/pkg/amsclient/watchdogs'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/ams'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/ams/watchdogs.go'
example: |-
watchdogsService := ams.WatchdogsService{ ... }
params := watchdogs.WatchdogConnectParams{ ... }
res, err := watchdogsService.WatchdogConnectShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'connect'
- 'watchdog'
- 'watchdogs'
# endregion functions