symbols:
'NewMatch2Client@go.match2.fun':
id: 'NewMatch2Client@go.match2.fun'
name: 'NewMatch2Client'
type: 'function'
arguments:
configRepository:
type: 'repository.ConfigRepository'
return_type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/justice_match2_service_client.go'
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/factory/match2clientfactory.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo)
# region wrappers
'EmptyService@go.match2.mod':
id: 'EmptyService@go.match2.mod'
name: 'EmptyService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
Service := EmptyService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'BackfillService@go.match2.mod':
id: 'BackfillService@go.match2.mod'
name: 'BackfillService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/backfill.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
backfillService := BackfillService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'ConfigService@go.match2.mod':
id: 'ConfigService@go.match2.mod'
name: 'ConfigService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/config.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
configService := ConfigService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'EnvironmentVariablesService@go.match2.mod':
id: 'EnvironmentVariablesService@go.match2.mod'
name: 'EnvironmentVariablesService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/environmentVariables.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
environmentVariablesService := EnvironmentVariablesService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'MatchFunctionsService@go.match2.mod':
id: 'MatchFunctionsService@go.match2.mod'
name: 'MatchFunctionsService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchFunctions.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
matchFunctionsService := MatchFunctionsService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'MatchPoolsService@go.match2.mod':
id: 'MatchPoolsService@go.match2.mod'
name: 'MatchPoolsService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
matchPoolsService := MatchPoolsService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'MatchTicketsService@go.match2.mod':
id: 'MatchTicketsService@go.match2.mod'
name: 'MatchTicketsService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchTickets.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
matchTicketsService := MatchTicketsService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'PlayFeatureFlagService@go.match2.mod':
id: 'PlayFeatureFlagService@go.match2.mod'
name: 'PlayFeatureFlagService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/playFeatureFlag.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
playFeatureFlagService := PlayFeatureFlagService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'RuleSetsService@go.match2.mod':
id: 'RuleSetsService@go.match2.mod'
name: 'RuleSetsService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/ruleSets.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
ruleSetsService := RuleSetsService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'XRayConfigService@go.match2.mod':
id: 'XRayConfigService@go.match2.mod'
name: 'XRayConfigService'
type: 'model'
fields:
Client:
type: '*match2client.JusticeMatch2Service'
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/match2-sdk/pkg/match2client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/xRayConfig.go'
example: |-
match2Client := factory.NewMatch2Client(configRepo) // re-use if it exists already
xRayConfigService := XRayConfigService{
Client: match2Client,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
# endregion wrappers
# region params
'AcceptBackfillParams@go.match2.mod':
id: 'AcceptBackfillParams@go.match2.mod'
name: 'AcceptBackfillParams'
type: 'model'
fields:
'BackfillID':
type: 'string'
required: true
description: |-
backfill Ticket ID
'Body':
type: '*APIBackFillAcceptRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/backfill/accept_backfill_parameters.go'
'AdminDeletePlayFeatureFlagParams@go.match2.mod':
id: 'AdminDeletePlayFeatureFlagParams@go.match2.mod'
name: 'AdminDeletePlayFeatureFlagParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/play_feature_flag'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/play_feature_flag/admin_delete_play_feature_flag_parameters.go'
'AdminGetAllConfigV1Params@go.match2.mod':
id: 'AdminGetAllConfigV1Params@go.match2.mod'
name: 'AdminGetAllConfigV1Params'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/config/admin_get_all_config_v1_parameters.go'
'AdminGetConfigV1Params@go.match2.mod':
id: 'AdminGetConfigV1Params@go.match2.mod'
name: 'AdminGetConfigV1Params'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/config/admin_get_config_v1_parameters.go'
'AdminGetLogConfigParams@go.match2.mod':
id: 'AdminGetLogConfigParams@go.match2.mod'
name: 'AdminGetLogConfigParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/config/admin_get_log_config_parameters.go'
'AdminGetMatchPoolTicketsParams@go.match2.mod':
id: 'AdminGetMatchPoolTicketsParams@go.match2.mod'
name: 'AdminGetMatchPoolTicketsParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
Pagination limit
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
Pagination offset
'Pool':
type: 'string'
required: true
description: |-
Name of the match pool
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/admin_get_match_pool_tickets_parameters.go'
'AdminGetPlayFeatureFlagParams@go.match2.mod':
id: 'AdminGetPlayFeatureFlagParams@go.match2.mod'
name: 'AdminGetPlayFeatureFlagParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/play_feature_flag'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/play_feature_flag/admin_get_play_feature_flag_parameters.go'
'AdminGetXRayConfigParams@go.match2.mod':
id: 'AdminGetXRayConfigParams@go.match2.mod'
name: 'AdminGetXRayConfigParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/x_ray_config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/x_ray_config/admin_get_x_ray_config_parameters.go'
'AdminPatchConfigV1Params@go.match2.mod':
id: 'AdminPatchConfigV1Params@go.match2.mod'
name: 'AdminPatchConfigV1Params'
type: 'model'
fields:
'Body':
type: '*APIPatchNamespaceConfigRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/config/admin_patch_config_v1_parameters.go'
'AdminPatchUpdateLogConfigParams@go.match2.mod':
id: 'AdminPatchUpdateLogConfigParams@go.match2.mod'
name: 'AdminPatchUpdateLogConfigParams'
type: 'model'
fields:
'Body':
type: '*LogconfigConfiguration'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/config/admin_patch_update_log_config_parameters.go'
'AdminQueryBackfillParams@go.match2.mod':
id: 'AdminQueryBackfillParams@go.match2.mod'
name: 'AdminQueryBackfillParams'
type: 'model'
fields:
'FromTime':
type: '*strfmt.DateTime'
required: false
description: |-
beginning of backfill ticket creation time range in RFC 3339 format e.g. 2022-10-21T07:20:50Z
'IsActive':
type: 'bool'
required: false
description: |-
backfill isActive flag
'Limit':
type: 'int64'
required: false
description: |-
limit of the returned data
'MatchPool':
type: 'string'
required: false
description: |-
ticket match pool
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
offset of the data
'PlayerID':
type: 'string'
required: false
description: |-
player ID of the backfilled session (WARNING: slow)
'Region':
type: 'string'
required: false
description: |-
preferred region of the backfilled session (WARNING: slow)
'SessionID':
type: 'string'
required: false
description: |-
backfill Session ID
'ToTime':
type: '*strfmt.DateTime'
required: false
description: |-
end of backfill ticket creation time range in RFC 3339 format e.g. 2022-10-21T07:20:50Z
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/backfill/admin_query_backfill_parameters.go'
'AdminUpdateXRayConfigParams@go.match2.mod':
id: 'AdminUpdateXRayConfigParams@go.match2.mod'
name: 'AdminUpdateXRayConfigParams'
type: 'model'
fields:
'Body':
type: '*ModelsXRayConfigHTTPUpdateRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/x_ray_config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/x_ray_config/admin_update_x_ray_config_parameters.go'
'AdminUpsertPlayFeatureFlagParams@go.match2.mod':
id: 'AdminUpsertPlayFeatureFlagParams@go.match2.mod'
name: 'AdminUpsertPlayFeatureFlagParams'
type: 'model'
fields:
'Body':
type: '*ModelsPlayFeatureFlag'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/play_feature_flag'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/play_feature_flag/admin_upsert_play_feature_flag_parameters.go'
'CreateBackfillParams@go.match2.mod':
id: 'CreateBackfillParams@go.match2.mod'
name: 'CreateBackfillParams'
type: 'model'
fields:
'Body':
type: '*APIBackFillCreateRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/backfill/create_backfill_parameters.go'
'CreateMatchFunctionParams@go.match2.mod':
id: 'CreateMatchFunctionParams@go.match2.mod'
name: 'CreateMatchFunctionParams'
type: 'model'
fields:
'Body':
type: '*APIMatchFunctionRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_functions/create_match_function_parameters.go'
'CreateMatchPoolParams@go.match2.mod':
id: 'CreateMatchPoolParams@go.match2.mod'
name: 'CreateMatchPoolParams'
type: 'model'
fields:
'Body':
type: '*APIMatchPool'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/create_match_pool_parameters.go'
'CreateMatchTicketParams@go.match2.mod':
id: 'CreateMatchTicketParams@go.match2.mod'
name: 'CreateMatchTicketParams'
type: 'model'
fields:
'Body':
type: '*APIMatchTicketRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_tickets/create_match_ticket_parameters.go'
'CreateRuleSetParams@go.match2.mod':
id: 'CreateRuleSetParams@go.match2.mod'
name: 'CreateRuleSetParams'
type: 'model'
fields:
'Body':
type: '*APIRuleSetPayload'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/rule_sets/create_rule_set_parameters.go'
'DeleteBackfillParams@go.match2.mod':
id: 'DeleteBackfillParams@go.match2.mod'
name: 'DeleteBackfillParams'
type: 'model'
fields:
'BackfillID':
type: 'string'
required: true
description: |-
backfill Ticket ID
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/backfill/delete_backfill_parameters.go'
'DeleteMatchFunctionParams@go.match2.mod':
id: 'DeleteMatchFunctionParams@go.match2.mod'
name: 'DeleteMatchFunctionParams'
type: 'model'
fields:
'Name':
type: 'string'
required: true
description: |-
name of the match function
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_functions/delete_match_function_parameters.go'
'DeleteMatchPoolParams@go.match2.mod':
id: 'DeleteMatchPoolParams@go.match2.mod'
name: 'DeleteMatchPoolParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Pool':
type: 'string'
required: true
description: |-
Name of the match pool
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/delete_match_pool_parameters.go'
'DeleteMatchTicketParams@go.match2.mod':
id: 'DeleteMatchTicketParams@go.match2.mod'
name: 'DeleteMatchTicketParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Ticketid':
type: 'string'
required: true
description: |-
ID of the match ticket
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_tickets/delete_match_ticket_parameters.go'
'DeleteRuleSetParams@go.match2.mod':
id: 'DeleteRuleSetParams@go.match2.mod'
name: 'DeleteRuleSetParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Ruleset':
type: 'string'
required: true
description: |-
Name of the rule set
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/rule_sets/delete_rule_set_parameters.go'
'EnvironmentVariableListParams@go.match2.mod':
id: 'EnvironmentVariableListParams@go.match2.mod'
name: 'EnvironmentVariableListParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/environment_variables'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/environment_variables/environment_variable_list_parameters.go'
'GetBackfillParams@go.match2.mod':
id: 'GetBackfillParams@go.match2.mod'
name: 'GetBackfillParams'
type: 'model'
fields:
'BackfillID':
type: 'string'
required: true
description: |-
backfill Ticket ID
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/backfill/get_backfill_parameters.go'
'GetBackfillProposalParams@go.match2.mod':
id: 'GetBackfillProposalParams@go.match2.mod'
name: 'GetBackfillProposalParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'SessionID':
type: 'string'
required: true
description: |-
Session ID information
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/backfill/get_backfill_proposal_parameters.go'
'GetHealthcheckInfoParams@go.match2.mod':
id: 'GetHealthcheckInfoParams@go.match2.mod'
name: 'GetHealthcheckInfoParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client//get_healthcheck_info_parameters.go'
'GetHealthcheckInfoV1Params@go.match2.mod':
id: 'GetHealthcheckInfoV1Params@go.match2.mod'
name: 'GetHealthcheckInfoV1Params'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client//get_healthcheck_info_v1_parameters.go'
'GetMyMatchTicketsParams@go.match2.mod':
id: 'GetMyMatchTicketsParams@go.match2.mod'
name: 'GetMyMatchTicketsParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
limit of the returned data
'MatchPool':
type: 'string'
required: false
description: |-
ticket match pool
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
offset of the data
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_tickets/get_my_match_tickets_parameters.go'
'GetPlayerMetricParams@go.match2.mod':
id: 'GetPlayerMetricParams@go.match2.mod'
name: 'GetPlayerMetricParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Pool':
type: 'string'
required: true
description: |-
Name of the match pool
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/get_player_metric_parameters.go'
'MatchFunctionGetParams@go.match2.mod':
id: 'MatchFunctionGetParams@go.match2.mod'
name: 'MatchFunctionGetParams'
type: 'model'
fields:
'Name':
type: 'string'
required: true
description: |-
name of the custom match function
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_functions/match_function_get_parameters.go'
'MatchFunctionListParams@go.match2.mod':
id: 'MatchFunctionListParams@go.match2.mod'
name: 'MatchFunctionListParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
Pagination limit
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
Pagination offset
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_functions/match_function_list_parameters.go'
'MatchPoolDetailsParams@go.match2.mod':
id: 'MatchPoolDetailsParams@go.match2.mod'
name: 'MatchPoolDetailsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Pool':
type: 'string'
required: true
description: |-
Name of the match pool
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/match_pool_details_parameters.go'
'MatchPoolListParams@go.match2.mod':
id: 'MatchPoolListParams@go.match2.mod'
name: 'MatchPoolListParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
Pagination limit
'Name':
type: 'string'
required: false
description: |-
Match Pool name
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
Pagination offset
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/match_pool_list_parameters.go'
'MatchPoolMetricParams@go.match2.mod':
id: 'MatchPoolMetricParams@go.match2.mod'
name: 'MatchPoolMetricParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Pool':
type: 'string'
required: true
description: |-
Name of the match pool
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/match_pool_metric_parameters.go'
'MatchTicketDetailsParams@go.match2.mod':
id: 'MatchTicketDetailsParams@go.match2.mod'
name: 'MatchTicketDetailsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Ticketid':
type: 'string'
required: true
description: |-
id of the ticket to get the status of
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_tickets/match_ticket_details_parameters.go'
'PostMatchErrorMetricParams@go.match2.mod':
id: 'PostMatchErrorMetricParams@go.match2.mod'
name: 'PostMatchErrorMetricParams'
type: 'model'
fields:
'Body':
type: '*APIExternalFailureMetricRecord'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Pool':
type: 'string'
required: true
description: |-
Name of the match pool
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/post_match_error_metric_parameters.go'
'PublicGetPlayerMetricParams@go.match2.mod':
id: 'PublicGetPlayerMetricParams@go.match2.mod'
name: 'PublicGetPlayerMetricParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Pool':
type: 'string'
required: true
description: |-
Name of the match pool
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/public_get_player_metric_parameters.go'
'RejectBackfillParams@go.match2.mod':
id: 'RejectBackfillParams@go.match2.mod'
name: 'RejectBackfillParams'
type: 'model'
fields:
'BackfillID':
type: 'string'
required: true
description: |-
backfill Ticket ID
'Body':
type: '*APIBackFillRejectRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/backfill/reject_backfill_parameters.go'
'RuleSetDetailsParams@go.match2.mod':
id: 'RuleSetDetailsParams@go.match2.mod'
name: 'RuleSetDetailsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Ruleset':
type: 'string'
required: true
description: |-
Name of the rule set
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/rule_sets/rule_set_details_parameters.go'
'RuleSetListParams@go.match2.mod':
id: 'RuleSetListParams@go.match2.mod'
name: 'RuleSetListParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
Pagination limit
'Name':
type: 'string'
required: false
description: |-
Rule Set name
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'int64'
required: false
description: |-
Pagination offset
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/rule_sets/rule_set_list_parameters.go'
'UpdateMatchFunctionParams@go.match2.mod':
id: 'UpdateMatchFunctionParams@go.match2.mod'
name: 'UpdateMatchFunctionParams'
type: 'model'
fields:
'Body':
type: '*APIMatchFunctionRequest'
required: true
'Name':
type: 'string'
required: true
description: |-
name of the match function
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_functions/update_match_function_parameters.go'
'UpdateMatchPoolParams@go.match2.mod':
id: 'UpdateMatchPoolParams@go.match2.mod'
name: 'UpdateMatchPoolParams'
type: 'model'
fields:
'Body':
type: '*APIMatchPoolConfig'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Pool':
type: 'string'
required: true
description: |-
Name of the match pool
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/match_pools/update_match_pool_parameters.go'
'UpdateRuleSetParams@go.match2.mod':
id: 'UpdateRuleSetParams@go.match2.mod'
name: 'UpdateRuleSetParams'
type: 'model'
fields:
'Body':
type: '*APIRuleSetPayload'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Ruleset':
type: 'string'
required: true
description: |-
Name of the match rule set
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client/rule_sets/update_rule_set_parameters.go'
'VersionCheckHandlerParams@go.match2.mod':
id: 'VersionCheckHandlerParams@go.match2.mod'
name: 'VersionCheckHandlerParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2client//version_check_handler_parameters.go'
# endregion params
# region models
'APIBackFillAcceptRequest@go.match2.mod':
id: 'APIBackFillAcceptRequest@go.match2.mod'
name: 'APIBackFillAcceptRequest'
type: 'model'
fields:
'AcceptedTicketIds':
type: '[]string'
required: false
'ProposalID':
type: 'string'
required: true
'Stop':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_back_fill_accept_request.go'
'APIBackFillCreateRequest@go.match2.mod':
id: 'APIBackFillCreateRequest@go.match2.mod'
name: 'APIBackFillCreateRequest'
type: 'model'
fields:
'MatchPool':
type: 'string'
required: true
'SessionID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_back_fill_create_request.go'
'APIBackfillCreateResponse@go.match2.mod':
id: 'APIBackfillCreateResponse@go.match2.mod'
name: 'APIBackfillCreateResponse'
type: 'model'
fields:
'ID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_backfill_create_response.go'
'APIBackfillGetResponse@go.match2.mod':
id: 'APIBackfillGetResponse@go.match2.mod'
name: 'APIBackfillGetResponse'
type: 'model'
fields:
'CreatedAt':
type: '*strfmt.DateTime'
required: false
'MatchPool':
type: 'string'
required: false
'MatchSessionID':
type: 'string'
required: false
'PartialMatch':
type: '*APIMatch'
required: false
'TicketID':
type: 'string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_backfill_get_response.go'
'APIBackfillProposalResponse@go.match2.mod':
id: 'APIBackfillProposalResponse@go.match2.mod'
name: 'APIBackfillProposalResponse'
type: 'model'
fields:
'BackfillTicketID':
type: 'string'
required: false
'CreatedAt':
type: '*strfmt.DateTime'
required: false
'MatchPool':
type: 'string'
required: false
'MatchSessionID':
type: 'string'
required: false
'ProposalID':
type: 'string'
required: false
'ProposedTeams':
type: '[]*APITeam'
required: false
'Tickets':
type: '[]*APITicket'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_backfill_proposal_response.go'
'APIBackFillRejectRequest@go.match2.mod':
id: 'APIBackFillRejectRequest@go.match2.mod'
name: 'APIBackFillRejectRequest'
type: 'model'
fields:
'ProposalID':
type: 'string'
required: true
'Stop':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_back_fill_reject_request.go'
'APIExternalFailureMetricRecord@go.match2.mod':
id: 'APIExternalFailureMetricRecord@go.match2.mod'
name: 'APIExternalFailureMetricRecord'
type: 'model'
fields:
'Type':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_external_failure_metric_record.go'
'APIListBackfillQueryResponse@go.match2.mod':
id: 'APIListBackfillQueryResponse@go.match2.mod'
name: 'APIListBackfillQueryResponse'
type: 'model'
fields:
'Data':
type: '[]*APIBackfillGetResponse'
required: true
'Pagination':
type: '*ModelsPagination'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_list_backfill_query_response.go'
'APIListEnvironmentVariablesResponse@go.match2.mod':
id: 'APIListEnvironmentVariablesResponse@go.match2.mod'
name: 'APIListEnvironmentVariablesResponse'
type: 'model'
fields:
'Data':
type: '[]*ConfigEnvironmentVariable'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_list_environment_variables_response.go'
'APIListMatchFunctionsResponse@go.match2.mod':
id: 'APIListMatchFunctionsResponse@go.match2.mod'
name: 'APIListMatchFunctionsResponse'
type: 'model'
fields:
'Configs':
type: '[]*APIMatchFunctionConfig'
required: false
'Functions':
type: '[]string'
required: true
'Pagination':
type: '*ModelsPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_list_match_functions_response.go'
'APIListMatchPoolsResponse@go.match2.mod':
id: 'APIListMatchPoolsResponse@go.match2.mod'
name: 'APIListMatchPoolsResponse'
type: 'model'
fields:
'Data':
type: '[]*APIMatchPool'
required: false
'Pagination':
type: '*ModelsPagination'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_list_match_pools_response.go'
'APIListMatchPoolTicketsResponse@go.match2.mod':
id: 'APIListMatchPoolTicketsResponse@go.match2.mod'
name: 'APIListMatchPoolTicketsResponse'
type: 'model'
fields:
'Data':
type: '[]*MatchmakerMatchTicketRecord'
required: true
'Pagination':
type: '*ModelsPagination'
required: false
'TotalData':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_list_match_pool_tickets_response.go'
'APIListRuleSetsResponse@go.match2.mod':
id: 'APIListRuleSetsResponse@go.match2.mod'
name: 'APIListRuleSetsResponse'
type: 'model'
fields:
'Data':
type: '[]*APIMatchRuleSetNameData'
required: false
'Pagination':
type: '*ModelsPagination'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_list_rule_sets_response.go'
'APIMatch@go.match2.mod':
id: 'APIMatch@go.match2.mod'
name: 'APIMatch'
type: 'model'
fields:
'Backfill':
type: 'bool'
required: false
'ClientVersion':
type: 'string'
required: false
'MatchAttributes':
type: 'interface{}'
required: false
'RegionPreference':
type: '[]string'
required: false
'ServerName':
type: 'string'
required: false
'Teams':
type: '[]*APITeam'
required: false
'Tickets':
type: '[]*APITicket'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match.go'
'APIMatchFunctionConfig@go.match2.mod':
id: 'APIMatchFunctionConfig@go.match2.mod'
name: 'APIMatchFunctionConfig'
type: 'model'
fields:
'MatchFunction':
type: 'string'
required: true
'ServiceAppName':
type: 'string'
required: false
'URL':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_function_config.go'
'APIMatchFunctionOverride@go.match2.mod':
id: 'APIMatchFunctionOverride@go.match2.mod'
name: 'APIMatchFunctionOverride'
type: 'model'
fields:
'BackfillMatches':
type: 'string'
required: false
'Enrichment':
type: '[]string'
required: false
'MakeMatches':
type: 'string'
required: false
'StatCodes':
type: '[]string'
required: false
'Validation':
type: '[]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_function_override.go'
'APIMatchFunctionRequest@go.match2.mod':
id: 'APIMatchFunctionRequest@go.match2.mod'
name: 'APIMatchFunctionRequest'
type: 'model'
fields:
'MatchFunction':
type: 'string'
required: true
'ServiceAppName':
type: 'string'
required: false
'URL':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_function_request.go'
'APIMatchPool@go.match2.mod':
id: 'APIMatchPool@go.match2.mod'
name: 'APIMatchPool'
type: 'model'
fields:
'AutoAcceptBackfillProposal':
type: 'bool'
required: true
'BackfillProposalExpirationSeconds':
type: 'int32'
required: true
'BackfillTicketExpirationSeconds':
type: 'int32'
required: true
'BestLatencyCalculationMethod':
type: 'string'
required: false
'CrossplayDisabled':
type: 'bool'
required: false
'MatchFunction':
type: 'string'
required: true
'MatchFunctionOverride':
type: '*APIMatchFunctionOverride'
required: true
'Name':
type: 'string'
required: true
'PlatformGroupEnabled':
type: 'bool'
required: false
'RuleSet':
type: 'string'
required: true
'SessionTemplate':
type: 'string'
required: true
'TicketExpirationSeconds':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_pool.go'
'APIMatchPoolConfig@go.match2.mod':
id: 'APIMatchPoolConfig@go.match2.mod'
name: 'APIMatchPoolConfig'
type: 'model'
fields:
'AutoAcceptBackfillProposal':
type: 'bool'
required: true
'BackfillProposalExpirationSeconds':
type: 'int32'
required: true
'BackfillTicketExpirationSeconds':
type: 'int32'
required: true
'BestLatencyCalculationMethod':
type: 'string'
required: false
'CrossplayDisabled':
type: 'bool'
required: false
'MatchFunction':
type: 'string'
required: true
'MatchFunctionOverride':
type: '*APIMatchFunctionOverride'
required: true
'PlatformGroupEnabled':
type: 'bool'
required: false
'RuleSet':
type: 'string'
required: true
'SessionTemplate':
type: 'string'
required: true
'TicketExpirationSeconds':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_pool_config.go'
'APIMatchRuleSetNameData@go.match2.mod':
id: 'APIMatchRuleSetNameData@go.match2.mod'
name: 'APIMatchRuleSetNameData'
type: 'model'
fields:
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_rule_set_name_data.go'
'APIMatchTicketRequest@go.match2.mod':
id: 'APIMatchTicketRequest@go.match2.mod'
name: 'APIMatchTicketRequest'
type: 'model'
fields:
'Attributes':
type: 'interface{}'
required: true
'ExcludedSessions':
type: '[]string'
required: false
'Latencies':
type: 'map[string]int64'
required: true
'MatchPool':
type: 'string'
required: true
'SessionID':
type: 'string'
required: false
'Storage':
type: 'interface{}'
required: false
description: |-
leader session storage
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_ticket_request.go'
'APIMatchTicketResponse@go.match2.mod':
id: 'APIMatchTicketResponse@go.match2.mod'
name: 'APIMatchTicketResponse'
type: 'model'
fields:
'MatchTicketID':
type: 'string'
required: true
'QueueTime':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_ticket_response.go'
'APIMatchTicketStatus@go.match2.mod':
id: 'APIMatchTicketStatus@go.match2.mod'
name: 'APIMatchTicketStatus'
type: 'model'
fields:
'IsActive':
type: 'bool'
required: false
'MatchFound':
type: 'bool'
required: true
'MatchPool':
type: 'string'
required: false
'MatchTicketID':
type: 'string'
required: false
'ProposedProposal':
type: '*APIProposedProposal'
required: false
'SessionID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_ticket_status.go'
'APIMatchTicketStatuses@go.match2.mod':
id: 'APIMatchTicketStatuses@go.match2.mod'
name: 'APIMatchTicketStatuses'
type: 'model'
fields:
'Data':
type: '[]*APIMatchTicketStatus'
required: true
'Pagination':
type: '*ModelsPagination'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_match_ticket_statuses.go'
'APINamespaceConfigList@go.match2.mod':
id: 'APINamespaceConfigList@go.match2.mod'
name: 'APINamespaceConfigList'
type: 'model'
fields:
'Configs':
type: '[]*ConfigmodelsNamespaceConfig'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_namespace_config_list.go'
'APIParty@go.match2.mod':
id: 'APIParty@go.match2.mod'
name: 'APIParty'
type: 'model'
fields:
'PartyID':
type: 'string'
required: false
'UserIDs':
type: '[]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_party.go'
'APIPatchNamespaceConfigRequest@go.match2.mod':
id: 'APIPatchNamespaceConfigRequest@go.match2.mod'
name: 'APIPatchNamespaceConfigRequest'
type: 'model'
fields:
'CrossPlatformNoCurrentPlatform':
type: 'bool'
required: false
'ExtraPlatforms':
type: '[]string'
required: false
description: |-
additional platforms that will be included in the cross_platform attribute alongside the login method
'MatchAnyCommon':
type: 'bool'
required: false
'PlatformGroup':
type: 'map[string][]string'
required: false
'XrayMaxWhitelistedUserCount':
type: 'int32'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_patch_namespace_config_request.go'
'APIPlayerData@go.match2.mod':
id: 'APIPlayerData@go.match2.mod'
name: 'APIPlayerData'
type: 'model'
fields:
'Attributes':
type: 'interface{}'
required: false
'PartyID':
type: 'string'
required: false
'PlayerID':
type: 'string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_player_data.go'
'APIPlayerMetricRecord@go.match2.mod':
id: 'APIPlayerMetricRecord@go.match2.mod'
name: 'APIPlayerMetricRecord'
type: 'model'
fields:
'PlayerInQueue':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_player_metric_record.go'
'APIProposedProposal@go.match2.mod':
id: 'APIProposedProposal@go.match2.mod'
name: 'APIProposedProposal'
type: 'model'
fields:
'BackfillID':
type: 'string'
required: false
'ProposalID':
type: 'string'
required: false
'Status':
type: 'string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_proposed_proposal.go'
'APIRuleSetPayload@go.match2.mod':
id: 'APIRuleSetPayload@go.match2.mod'
name: 'APIRuleSetPayload'
type: 'model'
fields:
'Data':
type: 'interface{}'
required: true
'EnableCustomMatchFunction':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_rule_set_payload.go'
'APITeam@go.match2.mod':
id: 'APITeam@go.match2.mod'
name: 'APITeam'
type: 'model'
fields:
'Parties':
type: '[]*APIParty'
required: false
'TeamID':
type: 'string'
required: false
'UserIDs':
type: '[]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_team.go'
'APITicket@go.match2.mod':
id: 'APITicket@go.match2.mod'
name: 'APITicket'
type: 'model'
fields:
'CreatedAt':
type: '*strfmt.DateTime'
required: false
'Latencies':
type: 'map[string]int64'
required: false
'MatchPool':
type: 'string'
required: false
'Namespace':
type: 'string'
required: false
'PartySessionID':
type: 'string'
required: false
'Players':
type: '[]*APIPlayerData'
required: false
'TicketAttributes':
type: 'interface{}'
required: false
'TicketID':
type: 'string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_ticket.go'
'APITicketMetricResultRecord@go.match2.mod':
id: 'APITicketMetricResultRecord@go.match2.mod'
name: 'APITicketMetricResultRecord'
type: 'model'
fields:
'QueueTime':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/api_ticket_metric_result_record.go'
'ConfigEnvironmentVariable@go.match2.mod':
id: 'ConfigEnvironmentVariable@go.match2.mod'
name: 'ConfigEnvironmentVariable'
type: 'model'
fields:
'ActualValue':
type: 'string'
required: false
'DefaultValue':
type: 'string'
required: false
'Description':
type: 'string'
required: false
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/config_environment_variable.go'
'ConfigmodelsNamespaceConfig@go.match2.mod':
id: 'ConfigmodelsNamespaceConfig@go.match2.mod'
name: 'ConfigmodelsNamespaceConfig'
type: 'model'
fields:
'CrossPlatformNoCurrentPlatform':
type: 'bool'
required: false
'ExtraPlatforms':
type: '[]string'
required: false
'MatchAnyCommon':
type: 'bool'
required: false
'Namespace':
type: 'string'
required: true
'PlatformGroup':
type: 'map[string][]string'
required: false
'XrayMaxWhitelistedUserCount':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/configmodels_namespace_config.go'
'LogconfigConfiguration@go.match2.mod':
id: 'LogconfigConfiguration@go.match2.mod'
name: 'LogconfigConfiguration'
type: 'model'
fields:
'LogLevel':
type: 'string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/logconfig_configuration.go'
'MatchmakerMatchTicketRecord@go.match2.mod':
id: 'MatchmakerMatchTicketRecord@go.match2.mod'
name: 'MatchmakerMatchTicketRecord'
type: 'model'
fields:
'CreatedAt':
type: 'strfmt.DateTime'
required: true
'ExpiredAt':
type: 'strfmt.DateTime'
required: true
'IsActive':
type: 'bool'
required: true
'PartySessionID':
type: 'string'
required: true
'ProposedProposal':
type: '*MatchmakerProposedProposal'
required: true
'SessionID':
type: 'string'
required: true
'Ticket':
type: '*MatchmakerTicket'
required: true
'TicketID':
type: 'string'
required: true
'UniqueTicketID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/matchmaker_match_ticket_record.go'
'MatchmakerParty@go.match2.mod':
id: 'MatchmakerParty@go.match2.mod'
name: 'MatchmakerParty'
type: 'model'
fields:
'PartyID':
type: 'string'
required: false
'UserIDs':
type: '[]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/matchmaker_party.go'
'MatchmakerProposedProposal@go.match2.mod':
id: 'MatchmakerProposedProposal@go.match2.mod'
name: 'MatchmakerProposedProposal'
type: 'model'
fields:
'BackfillID':
type: 'string'
required: true
'ProposalID':
type: 'string'
required: true
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/matchmaker_proposed_proposal.go'
'MatchmakerTeam@go.match2.mod':
id: 'MatchmakerTeam@go.match2.mod'
name: 'MatchmakerTeam'
type: 'model'
fields:
'Parties':
type: '[]*MatchmakerParty'
required: false
'TeamID':
type: 'string'
required: false
'UserIDs':
type: '[]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/matchmaker_team.go'
'MatchmakerTicket@go.match2.mod':
id: 'MatchmakerTicket@go.match2.mod'
name: 'MatchmakerTicket'
type: 'model'
fields:
'CreatedAt':
type: 'strfmt.DateTime'
required: true
'ExcludedSessions':
type: '[]string'
required: true
'IsActive':
type: 'bool'
required: true
'IsPivot':
type: 'bool'
required: true
'IsSinglePlay':
type: 'bool'
required: true
'Latencies':
type: 'map[string]int64'
required: true
'MatchedAt':
type: 'strfmt.DateTime'
required: true
'MatchPool':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'PartySessionID':
type: 'string'
required: true
'Players':
type: '[]*PlayerPlayerData'
required: true
'ProposedProposal':
type: '*MatchmakerProposedProposal'
required: true
'TicketAttributes':
type: 'interface{}'
required: true
'TicketID':
type: 'string'
required: true
'TicketInformation':
type: 'interface{}'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/matchmaker_ticket.go'
'ModelsConfiguration@go.match2.mod':
id: 'ModelsConfiguration@go.match2.mod'
name: 'ModelsConfiguration'
type: 'model'
fields:
'ClientVersion':
type: 'string'
required: true
'Deployment':
type: 'string'
required: true
'InactiveTimeout':
type: 'int32'
required: true
'InviteTimeout':
type: 'int32'
required: true
'Joinability':
type: 'string'
required: true
'MaxPlayers':
type: 'int32'
required: true
'MinPlayers':
type: 'int32'
required: true
'Name':
type: 'string'
required: true
'RequestedRegions':
type: '[]string'
required: true
'Type':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_configuration.go'
'ModelsDSInformation@go.match2.mod':
id: 'ModelsDSInformation@go.match2.mod'
name: 'ModelsDSInformation'
type: 'model'
fields:
'MinPlayers':
type: 'int32'
required: true
'RequestedAt':
type: 'string'
required: true
'RequestedRegions':
type: '[]string'
required: true
'Server':
type: '*ModelsServer'
required: true
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_d_s_information.go'
'ModelsGameSession@go.match2.mod':
id: 'ModelsGameSession@go.match2.mod'
name: 'ModelsGameSession'
type: 'model'
fields:
'Attributes':
type: 'interface{}'
required: true
'BackfillTicketID':
type: 'string'
required: true
'Configuration':
type: '*ModelsConfiguration'
required: true
'CreatedAt':
type: 'strfmt.DateTime'
required: true
'DSInformation':
type: '*ModelsDSInformation'
required: true
'GameMode':
type: 'string'
required: true
'ID':
type: 'string'
required: true
'IsFull':
type: 'bool'
required: true
'JoinType':
type: 'string'
required: true
'LeaderID':
type: 'string'
required: true
'MatchPool':
type: 'string'
required: true
'Members':
type: '[]*ModelsUser'
required: true
'Namespace':
type: 'string'
required: true
'Teams':
type: '[]*MatchmakerTeam'
required: true
'UpdatedAt':
type: 'strfmt.DateTime'
required: true
'Version':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_game_session.go'
'ModelsPagination@go.match2.mod':
id: 'ModelsPagination@go.match2.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'First':
type: 'string'
required: true
'Last':
type: 'string'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_pagination.go'
'ModelsPlayFeatureFlag@go.match2.mod':
id: 'ModelsPlayFeatureFlag@go.match2.mod'
name: 'ModelsPlayFeatureFlag'
type: 'model'
fields:
'ENABLEAUTOCANCELMATCHUSERDISCONNECT':
type: 'bool'
required: true
'ENABLEAUTOCANCELMATCHUSERLEAVE':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_play_feature_flag.go'
'ModelsServer@go.match2.mod':
id: 'ModelsServer@go.match2.mod'
name: 'ModelsServer'
type: 'model'
fields:
'AlternateIps':
type: '[]string'
required: true
'CustomAttribute':
type: 'string'
required: true
'Deployment':
type: 'string'
required: true
'GameVersion':
type: 'string'
required: true
'ImageVersion':
type: 'string'
required: true
'IP':
type: 'string'
required: true
'IsOverrideGameVersion':
type: 'bool'
required: true
'LastUpdate':
type: 'strfmt.DateTime'
required: true
'Namespace':
type: 'string'
required: true
'PodName':
type: 'string'
required: true
'Port':
type: 'int32'
required: true
'Ports':
type: 'map[string]int64'
required: true
'Protocol':
type: 'string'
required: true
'Provider':
type: 'string'
required: true
'Region':
type: 'string'
required: true
'SessionID':
type: 'string'
required: true
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_server.go'
'ModelsUser@go.match2.mod':
id: 'ModelsUser@go.match2.mod'
name: 'ModelsUser'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'PlatformID':
type: 'string'
required: true
'PlatformUserID':
type: 'string'
required: true
'PreviousStatus':
type: 'string'
required: false
'Status':
type: 'string'
required: true
'StatusV2':
type: 'string'
required: true
'UpdatedAt':
type: 'strfmt.DateTime'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_user.go'
'ModelsXRayConfigHTTPResponse@go.match2.mod':
id: 'ModelsXRayConfigHTTPResponse@go.match2.mod'
name: 'ModelsXRayConfigHTTPResponse'
type: 'model'
fields:
'WhitelistedUsers':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_x_ray_config_http_response.go'
'ModelsXRayConfigHTTPUpdateRequest@go.match2.mod':
id: 'ModelsXRayConfigHTTPUpdateRequest@go.match2.mod'
name: 'ModelsXRayConfigHTTPUpdateRequest'
type: 'model'
fields:
'WhitelistedUsers':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/models_x_ray_config_http_update_request.go'
'PlayerPlayerData@go.match2.mod':
id: 'PlayerPlayerData@go.match2.mod'
name: 'PlayerPlayerData'
type: 'model'
fields:
'Attributes':
type: 'interface{}'
required: true
'PartyID':
type: 'string'
required: true
'PlatformID':
type: 'string'
required: true
'PlayerID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/player_player_data.go'
'ResponseError@go.match2.mod':
id: 'ResponseError@go.match2.mod'
name: 'ResponseError'
type: 'model'
fields:
'ErrorCode':
type: 'int32'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/match2-sdk/pkg/match2clientmodels/response_error.go'
# endregion models
# region functions
'AcceptBackfillShort@go.match2.fun':
id: 'AcceptBackfillShort@go.match2.fun'
name: 'AcceptBackfillShort'
type: 'function'
description: |-
Accept backfill proposal.
Field **acceptedTicketIds** can be used to accept specific tickets within a backfill proposal. If the ticketIDs are not mentioned in this field, those tickets will be rejected and reactivated for future proposals.
If **acceptedTicketIds** is nil or not specified, then all tickets in the proposal will be accepted.
struct: 'BackfillService'
arguments:
params:
type: '*backfill.AcceptBackfillParams'
required: true
return_type: '(*backfill.AcceptBackfillResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/backfill.go'
example: |-
backfillService := match2.BackfillService{ ... }
params := backfill.AcceptBackfillParams{ ... }
res, err := backfillService.AcceptBackfillShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'accept'
- 'backfill'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [UPDATE]'
'AdminDeletePlayFeatureFlagShort@go.match2.fun':
id: 'AdminDeletePlayFeatureFlagShort@go.match2.fun'
name: 'AdminDeletePlayFeatureFlagShort'
type: 'function'
description: |-
Delete matchmaking Play Feature Flag.
Deleting the current namespace's custom config only removes it from the database, the system will then use the environment variable defined in the ConfigMap instead.
struct: 'PlayFeatureFlagService'
arguments:
params:
type: '*play_feature_flag.AdminDeletePlayFeatureFlagParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/play_feature_flag'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/playFeatureFlag.go'
example: |-
playFeatureFlagService := match2.PlayFeatureFlagService{ ... }
params := play_feature_flag.AdminDeletePlayFeatureFlagParams{ ... }
res, err := playFeatureFlagService.AdminDeletePlayFeatureFlagShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'feature'
- 'flag'
- 'play'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:PLAYFEATUREFLAG [DELETE]'
'AdminGetAllConfigV1Short@go.match2.fun':
id: 'AdminGetAllConfigV1Short@go.match2.fun'
name: 'AdminGetAllConfigV1Short'
type: 'function'
description: |-
Get matchmaking config of all namespaces. Will only return namespace configs than have been updated.
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminGetAllConfigV1Params'
required: true
return_type: '(*config.AdminGetAllConfigV1Response, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/config.go'
example: |-
configService := match2.ConfigService{ ... }
params := config.AdminGetAllConfigV1Params{ ... }
res, err := configService.AdminGetAllConfigV1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'all'
- 'config'
- 'get'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:*:MATCHMAKING:CONFIG [READ]'
'AdminGetConfigV1Short@go.match2.fun':
id: 'AdminGetConfigV1Short@go.match2.fun'
name: 'AdminGetConfigV1Short'
type: 'function'
description: |-
Get matchmaking config of a namespaces.
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminGetConfigV1Params'
required: true
return_type: '(*config.AdminGetConfigV1Response, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/config.go'
example: |-
configService := match2.ConfigService{ ... }
params := config.AdminGetConfigV1Params{ ... }
res, err := configService.AdminGetConfigV1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'get'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:CONFIG [READ]'
'AdminGetLogConfigShort@go.match2.fun':
id: 'AdminGetLogConfigShort@go.match2.fun'
name: 'AdminGetLogConfigShort'
type: 'function'
description: |-
Get Log Configuration.
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminGetLogConfigParams'
required: true
return_type: '(*config.AdminGetLogConfigResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/config.go'
example: |-
configService := match2.ConfigService{ ... }
params := config.AdminGetLogConfigParams{ ... }
res, err := configService.AdminGetLogConfigShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'get'
- 'log'
permissions:
- 'ADMIN:CONFIG:LOG [READ]'
'AdminGetMatchPoolTicketsShort@go.match2.fun':
id: 'AdminGetMatchPoolTicketsShort@go.match2.fun'
name: 'AdminGetMatchPoolTicketsShort'
type: 'function'
description: |-
Get tickets in queue for a specific match pool
Result: number of tickets and list of ticket detail in a match pool.
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.AdminGetMatchPoolTicketsParams'
required: true
return_type: '(*match_pools.AdminGetMatchPoolTicketsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.AdminGetMatchPoolTicketsParams{ ... }
res, err := matchPoolsService.AdminGetMatchPoolTicketsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'match'
- 'pool'
- 'pools'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:POOL:TICKETS [READ]'
'AdminGetPlayFeatureFlagShort@go.match2.fun':
id: 'AdminGetPlayFeatureFlagShort@go.match2.fun'
name: 'AdminGetPlayFeatureFlagShort'
type: 'function'
description: |-
Get matchmaking Play Feature Flag.
struct: 'PlayFeatureFlagService'
arguments:
params:
type: '*play_feature_flag.AdminGetPlayFeatureFlagParams'
required: true
return_type: '(*play_feature_flag.AdminGetPlayFeatureFlagResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/play_feature_flag'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/playFeatureFlag.go'
example: |-
playFeatureFlagService := match2.PlayFeatureFlagService{ ... }
params := play_feature_flag.AdminGetPlayFeatureFlagParams{ ... }
res, err := playFeatureFlagService.AdminGetPlayFeatureFlagShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'feature'
- 'flag'
- 'get'
- 'play'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:PLAYFEATUREFLAG [READ]'
'AdminGetXRayConfigShort@go.match2.fun':
id: 'AdminGetXRayConfigShort@go.match2.fun'
name: 'AdminGetXRayConfigShort'
type: 'function'
description: |-
Get XRay config
struct: 'XRayConfigService'
arguments:
params:
type: '*x_ray_config.AdminGetXRayConfigParams'
required: true
return_type: '(*x_ray_config.AdminGetXRayConfigResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/x_ray_config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/xRayConfig.go'
example: |-
xRayConfigService := match2.XRayConfigService{ ... }
params := x_ray_config.AdminGetXRayConfigParams{ ... }
res, err := xRayConfigService.AdminGetXRayConfigShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'get'
- 'ray'
- 'x'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:XRAY [READ]'
'AdminPatchConfigV1Short@go.match2.fun':
id: 'AdminPatchConfigV1Short@go.match2.fun'
name: 'AdminPatchConfigV1Short'
type: 'function'
description: |-
Patch update matchmaking config of a namespaces. Partially update matchmaking config, will only update value that defined on the request.
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminPatchConfigV1Params'
required: true
return_type: '(*config.AdminPatchConfigV1Response, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/config.go'
example: |-
configService := match2.ConfigService{ ... }
params := config.AdminPatchConfigV1Params{ ... }
res, err := configService.AdminPatchConfigV1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'patch'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:CONFIG [UPDATE]'
'AdminPatchUpdateLogConfigShort@go.match2.fun':
id: 'AdminPatchUpdateLogConfigShort@go.match2.fun'
name: 'AdminPatchUpdateLogConfigShort'
type: 'function'
description: |-
Update Log Configuration.
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminPatchUpdateLogConfigParams'
required: true
return_type: '(*config.AdminPatchUpdateLogConfigResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/config.go'
example: |-
configService := match2.ConfigService{ ... }
params := config.AdminPatchUpdateLogConfigParams{ ... }
res, err := configService.AdminPatchUpdateLogConfigShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'log'
- 'patch'
- 'update'
permissions:
- 'ADMIN:CONFIG:LOG [UPDATE]'
'AdminQueryBackfillShort@go.match2.fun':
id: 'AdminQueryBackfillShort@go.match2.fun'
name: 'AdminQueryBackfillShort'
type: 'function'
description: |-
Admin Query backfill ticket
struct: 'BackfillService'
arguments:
params:
type: '*backfill.AdminQueryBackfillParams'
required: true
return_type: '(*backfill.AdminQueryBackfillResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/backfill.go'
example: |-
backfillService := match2.BackfillService{ ... }
params := backfill.AdminQueryBackfillParams{ ... }
res, err := backfillService.AdminQueryBackfillShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'backfill'
- 'query'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [READ]'
'AdminUpdateXRayConfigShort@go.match2.fun':
id: 'AdminUpdateXRayConfigShort@go.match2.fun'
name: 'AdminUpdateXRayConfigShort'
type: 'function'
description: |-
Admin update XRay config
struct: 'XRayConfigService'
arguments:
params:
type: '*x_ray_config.AdminUpdateXRayConfigParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/x_ray_config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/xRayConfig.go'
example: |-
xRayConfigService := match2.XRayConfigService{ ... }
params := x_ray_config.AdminUpdateXRayConfigParams{ ... }
res, err := xRayConfigService.AdminUpdateXRayConfigShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'ray'
- 'update'
- 'x'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:XRAY [UPDATE]'
'AdminUpsertPlayFeatureFlagShort@go.match2.fun':
id: 'AdminUpsertPlayFeatureFlagShort@go.match2.fun'
name: 'AdminUpsertPlayFeatureFlagShort'
type: 'function'
description: |-
Upsert matchmaking Play Feature Flag.
struct: 'PlayFeatureFlagService'
arguments:
params:
type: '*play_feature_flag.AdminUpsertPlayFeatureFlagParams'
required: true
return_type: '(*play_feature_flag.AdminUpsertPlayFeatureFlagResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/play_feature_flag'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/playFeatureFlag.go'
example: |-
playFeatureFlagService := match2.PlayFeatureFlagService{ ... }
params := play_feature_flag.AdminUpsertPlayFeatureFlagParams{ ... }
res, err := playFeatureFlagService.AdminUpsertPlayFeatureFlagShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'feature'
- 'flag'
- 'play'
- 'upsert'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:PLAYFEATUREFLAG [UPDATE]'
'CreateBackfillShort@go.match2.fun':
id: 'CreateBackfillShort@go.match2.fun'
name: 'CreateBackfillShort'
type: 'function'
description: |-
Create backfill ticket.
struct: 'BackfillService'
arguments:
params:
type: '*backfill.CreateBackfillParams'
required: true
return_type: '(*backfill.CreateBackfillResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/backfill.go'
example: |-
backfillService := match2.BackfillService{ ... }
params := backfill.CreateBackfillParams{ ... }
res, err := backfillService.CreateBackfillShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'backfill'
- 'create'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [CREATE]'
'CreateMatchFunctionShort@go.match2.fun':
id: 'CreateMatchFunctionShort@go.match2.fun'
name: 'CreateMatchFunctionShort'
type: 'function'
description: |-
Creates a new matchmaking function.
struct: 'MatchFunctionsService'
arguments:
params:
type: '*match_functions.CreateMatchFunctionParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchFunctions.go'
example: |-
matchFunctionsService := match2.MatchFunctionsService{ ... }
params := match_functions.CreateMatchFunctionParams{ ... }
res, err := matchFunctionsService.CreateMatchFunctionShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'function'
- 'functions'
- 'match'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [CREATE]'
'CreateMatchPoolShort@go.match2.fun':
id: 'CreateMatchPoolShort@go.match2.fun'
name: 'CreateMatchPoolShort'
type: 'function'
description: |-
Creates a new matchmaking pool.
A pool is isolated from other pools (i.e. tickets may be matched with other tickets in the same pool, but not with tickets in other pools).
Each pool has its own matchmaking rules and/or logic.
ticket_expiration_seconds and backfill_ticket_expiration_seconds will be set to 300 seconds (5 minutes) by default if not filled.
Match Function holds information about the name of the match logic server that matchmaking can refers to. By default we provide ("default" and "basic").
Match Function will be used as reference value for Match Function Overrides if not set.
In case Customer would like to use matchmaking service default match logic, then specify it in "match_function_overrides".
This sample configuration will let matchmaking service will use "default" match logic for make matches, while validation will hit both "default" and "custom" match logics.
e.g.
{
"match_function": "custom",
"match_function_overrides": {
"validation": []{"default","custom"},
"make_matches": "default",
}
}
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.CreateMatchPoolParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.CreateMatchPoolParams{ ... }
res, err := matchPoolsService.CreateMatchPoolShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'match'
- 'pool'
- 'pools'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [CREATE]'
'CreateMatchTicketShort@go.match2.fun':
id: 'CreateMatchTicketShort@go.match2.fun'
name: 'CreateMatchTicketShort'
type: 'function'
description: |-
Creates a new request for matchmaking.
Cross Platform: Allow player to play game with "all" registered platforms.
1. Cross Platform can be enabled through session service or create match ticket.
a. via ticket: specify several cross_platform on create match ticket attributes. **[DEPRECATED]** client should not send from attribute `cross_platform` will be populated from backend
This value will override player attributes in session service. e.g. cross_platform:[xbox,psn,steam]
b. via session service: set player/party cross_platform attributes.
c. Enable match options ruleset with name cross_platform and type "all".
```
{
"name": "co-op",
"data": {
"alliance": {
"min_number": 1,
"max_number": 1,
"player_min_number": 1,
"player_max_number": 4
},
"match_options": {
"options": [
{"name": "cross_platform", "type": "all"}
]
}
}
}
```
2. Cross Platform can be disabled from the matchpool configuration `crossplay_disabled=true`
3. When matchpool `crossplay_disabled=false`
* request attribute cross_platform is empty **[Recommended]**:
* Matchmaking will consider Party leader `crossplayEnabled` preference or Session attribute `crossplayEnabled` preference.
* When `crossplayEnabled=true` `cross_platforms` attributes will be populated from [active login methods](/iam/apidocs/#/Third%20Party%20Credential/RetrieveAllActiveThirdPartyLoginPlatformCredentialPublicV3) otherwise it will set to leader current platform
* When `crossplayEnabled=false` `cross_platforms` attributes will be set to user's currentPlatform
* request attribute cross_platform is not empty **[Not Recommended]**:
* Cross Platform can be disabled with specify only ONE cross_platform. Current matchmaking use this behavior. e.g. cross_platform:[xbox]
* Multiple cross_platform values is considered to be crossplay enabled
4. This behavior only works for Default Matchmaker. Custom matchmaker (custom gRPC matchmaker) need to consider this on its own implementation.
ExcludedSessions: allow player to list out game sessions that they want to avoid matching, for example a match that they've recently left or get kicked out from.
struct: 'MatchTicketsService'
arguments:
params:
type: '*match_tickets.CreateMatchTicketParams'
required: true
return_type: '(*match_tickets.CreateMatchTicketResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchTickets.go'
example: |-
matchTicketsService := match2.MatchTicketsService{ ... }
params := match_tickets.CreateMatchTicketParams{ ... }
res, err := matchTicketsService.CreateMatchTicketShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'create'
- 'match'
- 'public'
- 'ticket'
- 'tickets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:TICKET [CREATE]'
'CreateRuleSetShort@go.match2.fun':
id: 'CreateRuleSetShort@go.match2.fun'
name: 'CreateRuleSetShort'
type: 'function'
description: |-
Creates a new rules set.
A rule set has a name and contains arbitrary data which is meaningful to some particular match function(s)
The name is used for a match pool to select the ruleset data that should be sent to the match function when matchmaking in that pool.
To use custom rules set please set enable_custom_match_function=true. Default (false).
When custom enable_custom_match_function=true, the ruleset will only validate if the rule is valid json.
struct: 'RuleSetsService'
arguments:
params:
type: '*rule_sets.CreateRuleSetParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/ruleSets.go'
example: |-
ruleSetsService := match2.RuleSetsService{ ... }
params := rule_sets.CreateRuleSetParams{ ... }
res, err := ruleSetsService.CreateRuleSetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'rule'
- 'set'
- 'sets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [CREATE]'
'DeleteBackfillShort@go.match2.fun':
id: 'DeleteBackfillShort@go.match2.fun'
name: 'DeleteBackfillShort'
type: 'function'
description: |-
Delete backfill ticket.
struct: 'BackfillService'
arguments:
params:
type: '*backfill.DeleteBackfillParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/backfill.go'
example: |-
backfillService := match2.BackfillService{ ... }
params := backfill.DeleteBackfillParams{ ... }
res, err := backfillService.DeleteBackfillShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'backfill'
- 'delete'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [DELETE]'
'DeleteMatchFunctionShort@go.match2.fun':
id: 'DeleteMatchFunctionShort@go.match2.fun'
name: 'DeleteMatchFunctionShort'
type: 'function'
description: |-
Deletes an existing match function.
struct: 'MatchFunctionsService'
arguments:
params:
type: '*match_functions.DeleteMatchFunctionParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchFunctions.go'
example: |-
matchFunctionsService := match2.MatchFunctionsService{ ... }
params := match_functions.DeleteMatchFunctionParams{ ... }
res, err := matchFunctionsService.DeleteMatchFunctionShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'function'
- 'functions'
- 'match'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [DELETE]'
'DeleteMatchPoolShort@go.match2.fun':
id: 'DeleteMatchPoolShort@go.match2.fun'
name: 'DeleteMatchPoolShort'
type: 'function'
description: |-
Deletes an existing matchmaking pool.
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.DeleteMatchPoolParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.DeleteMatchPoolParams{ ... }
res, err := matchPoolsService.DeleteMatchPoolShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'match'
- 'pool'
- 'pools'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [DELETE]'
'DeleteMatchTicketShort@go.match2.fun':
id: 'DeleteMatchTicketShort@go.match2.fun'
name: 'DeleteMatchTicketShort'
type: 'function'
description: |-
Deletes an existing matchmaking ticket.
struct: 'MatchTicketsService'
arguments:
params:
type: '*match_tickets.DeleteMatchTicketParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchTickets.go'
example: |-
matchTicketsService := match2.MatchTicketsService{ ... }
params := match_tickets.DeleteMatchTicketParams{ ... }
res, err := matchTicketsService.DeleteMatchTicketShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'delete'
- 'match'
- 'public'
- 'ticket'
- 'tickets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:TICKET [DELETE]'
'DeleteRuleSetShort@go.match2.fun':
id: 'DeleteRuleSetShort@go.match2.fun'
name: 'DeleteRuleSetShort'
type: 'function'
description: |-
Deletes an existing rule set.
struct: 'RuleSetsService'
arguments:
params:
type: '*rule_sets.DeleteRuleSetParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/ruleSets.go'
example: |-
ruleSetsService := match2.RuleSetsService{ ... }
params := rule_sets.DeleteRuleSetParams{ ... }
res, err := ruleSetsService.DeleteRuleSetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'rule'
- 'set'
- 'sets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [DELETE]'
'EnvironmentVariableListShort@go.match2.fun':
id: 'EnvironmentVariableListShort@go.match2.fun'
name: 'EnvironmentVariableListShort'
type: 'function'
description: |-
List environment variables.
struct: 'EnvironmentVariablesService'
arguments:
params:
type: '*environment_variables.EnvironmentVariableListParams'
required: true
return_type: '(*environment_variables.EnvironmentVariableListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/environment_variables'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/environmentVariables.go'
example: |-
environmentVariablesService := match2.EnvironmentVariablesService{ ... }
params := environment_variables.EnvironmentVariableListParams{ ... }
res, err := environmentVariablesService.EnvironmentVariableListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'environment'
- 'list'
- 'variable'
- 'variables'
permissions:
- 'ADMIN:MATCHMAKING:CONFIGURATION:ENVIRONMENTVARIABLE [READ]'
'GetBackfillShort@go.match2.fun':
id: 'GetBackfillShort@go.match2.fun'
name: 'GetBackfillShort'
type: 'function'
description: |-
Get backfill ticket by ID
struct: 'BackfillService'
arguments:
params:
type: '*backfill.GetBackfillParams'
required: true
return_type: '(*backfill.GetBackfillResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/backfill.go'
example: |-
backfillService := match2.BackfillService{ ... }
params := backfill.GetBackfillParams{ ... }
res, err := backfillService.GetBackfillShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'backfill'
- 'get'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [READ]'
'GetBackfillProposalShort@go.match2.fun':
id: 'GetBackfillProposalShort@go.match2.fun'
name: 'GetBackfillProposalShort'
type: 'function'
description: |-
Get backfill proposal
struct: 'BackfillService'
arguments:
params:
type: '*backfill.GetBackfillProposalParams'
required: true
return_type: '(*backfill.GetBackfillProposalResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/backfill.go'
example: |-
backfillService := match2.BackfillService{ ... }
params := backfill.GetBackfillProposalParams{ ... }
res, err := backfillService.GetBackfillProposalShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'backfill'
- 'get'
- 'proposal'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [READ]'
'GetHealthcheckInfoShort@go.match2.fun':
id: 'GetHealthcheckInfoShort@go.match2.fun'
name: 'GetHealthcheckInfoShort'
type: 'function'
struct: 'EmptyService'
arguments:
params:
type: '*.GetHealthcheckInfoParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/.go'
example: |-
emptyService := match2.EmptyService{ ... }
params := .GetHealthcheckInfoParams{ ... }
res, err := emptyService.GetHealthcheckInfoShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'get'
- 'healthcheck'
- 'info'
'GetHealthcheckInfoV1Short@go.match2.fun':
id: 'GetHealthcheckInfoV1Short@go.match2.fun'
name: 'GetHealthcheckInfoV1Short'
type: 'function'
struct: 'EmptyService'
arguments:
params:
type: '*.GetHealthcheckInfoV1Params'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/.go'
example: |-
emptyService := match2.EmptyService{ ... }
params := .GetHealthcheckInfoV1Params{ ... }
res, err := emptyService.GetHealthcheckInfoV1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'get'
- 'healthcheck'
- 'info'
- 'v1'
'GetMyMatchTicketsShort@go.match2.fun':
id: 'GetMyMatchTicketsShort@go.match2.fun'
name: 'GetMyMatchTicketsShort'
type: 'function'
description: |-
Get my match tickets.
struct: 'MatchTicketsService'
arguments:
params:
type: '*match_tickets.GetMyMatchTicketsParams'
required: true
return_type: '(*match_tickets.GetMyMatchTicketsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchTickets.go'
example: |-
matchTicketsService := match2.MatchTicketsService{ ... }
params := match_tickets.GetMyMatchTicketsParams{ ... }
res, err := matchTicketsService.GetMyMatchTicketsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'get'
- 'match'
- 'my'
- 'public'
- 'tickets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:TICKET [READ]'
'GetPlayerMetricShort@go.match2.fun':
id: 'GetPlayerMetricShort@go.match2.fun'
name: 'GetPlayerMetricShort'
type: 'function'
description: |-
Get player metric for a specific match pool
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.GetPlayerMetricParams'
required: true
return_type: '(*match_pools.GetPlayerMetricResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.GetPlayerMetricParams{ ... }
res, err := matchPoolsService.GetPlayerMetricShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'match'
- 'metric'
- 'player'
- 'pools'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:POOL:METRICS [READ]'
'MatchFunctionGetShort@go.match2.fun':
id: 'MatchFunctionGetShort@go.match2.fun'
name: 'MatchFunctionGetShort'
type: 'function'
description: |-
Get custom match function by name.
struct: 'MatchFunctionsService'
arguments:
params:
type: '*match_functions.MatchFunctionGetParams'
required: true
return_type: '(*match_functions.MatchFunctionGetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchFunctions.go'
example: |-
matchFunctionsService := match2.MatchFunctionsService{ ... }
params := match_functions.MatchFunctionGetParams{ ... }
res, err := matchFunctionsService.MatchFunctionGetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'function'
- 'functions'
- 'get'
- 'match'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [READ]'
'MatchFunctionListShort@go.match2.fun':
id: 'MatchFunctionListShort@go.match2.fun'
name: 'MatchFunctionListShort'
type: 'function'
description: |-
List existing match functions.
struct: 'MatchFunctionsService'
arguments:
params:
type: '*match_functions.MatchFunctionListParams'
required: true
return_type: '(*match_functions.MatchFunctionListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchFunctions.go'
example: |-
matchFunctionsService := match2.MatchFunctionsService{ ... }
params := match_functions.MatchFunctionListParams{ ... }
res, err := matchFunctionsService.MatchFunctionListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'function'
- 'functions'
- 'list'
- 'match'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [READ]'
'MatchPoolDetailsShort@go.match2.fun':
id: 'MatchPoolDetailsShort@go.match2.fun'
name: 'MatchPoolDetailsShort'
type: 'function'
description: |-
Get details for a specific match pool
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.MatchPoolDetailsParams'
required: true
return_type: '(*match_pools.MatchPoolDetailsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.MatchPoolDetailsParams{ ... }
res, err := matchPoolsService.MatchPoolDetailsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'details'
- 'match'
- 'pool'
- 'pools'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [READ]'
'MatchPoolListShort@go.match2.fun':
id: 'MatchPoolListShort@go.match2.fun'
name: 'MatchPoolListShort'
type: 'function'
description: |-
List matchmaking pools.
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.MatchPoolListParams'
required: true
return_type: '(*match_pools.MatchPoolListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.MatchPoolListParams{ ... }
res, err := matchPoolsService.MatchPoolListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'list'
- 'match'
- 'pool'
- 'pools'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [READ]'
'MatchPoolMetricShort@go.match2.fun':
id: 'MatchPoolMetricShort@go.match2.fun'
name: 'MatchPoolMetricShort'
type: 'function'
description: |-
Get metric for a specific match pool
Result: queueTime in seconds
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.MatchPoolMetricParams'
required: true
return_type: '(*match_pools.MatchPoolMetricResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.MatchPoolMetricParams{ ... }
res, err := matchPoolsService.MatchPoolMetricShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'match'
- 'metric'
- 'pool'
- 'pools'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL:METRICS [READ]'
'MatchTicketDetailsShort@go.match2.fun':
id: 'MatchTicketDetailsShort@go.match2.fun'
name: 'MatchTicketDetailsShort'
type: 'function'
description: |-
Get details for a specific match ticket
struct: 'MatchTicketsService'
arguments:
params:
type: '*match_tickets.MatchTicketDetailsParams'
required: true
return_type: '(*match_tickets.MatchTicketDetailsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchTickets.go'
example: |-
matchTicketsService := match2.MatchTicketsService{ ... }
params := match_tickets.MatchTicketDetailsParams{ ... }
res, err := matchTicketsService.MatchTicketDetailsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'details'
- 'match'
- 'public'
- 'ticket'
- 'tickets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:TICKET [READ]'
'PostMatchErrorMetricShort@go.match2.fun':
id: 'PostMatchErrorMetricShort@go.match2.fun'
name: 'PostMatchErrorMetricShort'
type: 'function'
description: |-
Post metrics for external flow failure in a specific match pool
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.PostMatchErrorMetricParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.PostMatchErrorMetricParams{ ... }
res, err := matchPoolsService.PostMatchErrorMetricShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'error'
- 'match'
- 'metric'
- 'pools'
- 'post'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL:METRICS [CREATE]'
'PublicGetPlayerMetricShort@go.match2.fun':
id: 'PublicGetPlayerMetricShort@go.match2.fun'
name: 'PublicGetPlayerMetricShort'
type: 'function'
description: |-
Public get player metric for a specific match pool
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.PublicGetPlayerMetricParams'
required: true
return_type: '(*match_pools.PublicGetPlayerMetricResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.PublicGetPlayerMetricParams{ ... }
res, err := matchPoolsService.PublicGetPlayerMetricShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'get'
- 'match'
- 'metric'
- 'player'
- 'pools'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL:METRICS [READ]'
'RejectBackfillShort@go.match2.fun':
id: 'RejectBackfillShort@go.match2.fun'
name: 'RejectBackfillShort'
type: 'function'
description: |-
Reject backfill proposal
struct: 'BackfillService'
arguments:
params:
type: '*backfill.RejectBackfillParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/backfill'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/backfill.go'
example: |-
backfillService := match2.BackfillService{ ... }
params := backfill.RejectBackfillParams{ ... }
res, err := backfillService.RejectBackfillShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'backfill'
- 'public'
- 'reject'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [UPDATE]'
'RuleSetDetailsShort@go.match2.fun':
id: 'RuleSetDetailsShort@go.match2.fun'
name: 'RuleSetDetailsShort'
type: 'function'
description: |-
Get details for a specific rule set
struct: 'RuleSetsService'
arguments:
params:
type: '*rule_sets.RuleSetDetailsParams'
required: true
return_type: '(*rule_sets.RuleSetDetailsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/ruleSets.go'
example: |-
ruleSetsService := match2.RuleSetsService{ ... }
params := rule_sets.RuleSetDetailsParams{ ... }
res, err := ruleSetsService.RuleSetDetailsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'details'
- 'rule'
- 'set'
- 'sets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [READ]'
'RuleSetListShort@go.match2.fun':
id: 'RuleSetListShort@go.match2.fun'
name: 'RuleSetListShort'
type: 'function'
description: |-
List rule sets.
struct: 'RuleSetsService'
arguments:
params:
type: '*rule_sets.RuleSetListParams'
required: true
return_type: '(*rule_sets.RuleSetListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/ruleSets.go'
example: |-
ruleSetsService := match2.RuleSetsService{ ... }
params := rule_sets.RuleSetListParams{ ... }
res, err := ruleSetsService.RuleSetListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'list'
- 'rule'
- 'set'
- 'sets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [READ]'
'UpdateMatchFunctionShort@go.match2.fun':
id: 'UpdateMatchFunctionShort@go.match2.fun'
name: 'UpdateMatchFunctionShort'
type: 'function'
description: |-
Update existing matchmaking function.
struct: 'MatchFunctionsService'
arguments:
params:
type: '*match_functions.UpdateMatchFunctionParams'
required: true
return_type: '(*match_functions.UpdateMatchFunctionResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_functions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchFunctions.go'
example: |-
matchFunctionsService := match2.MatchFunctionsService{ ... }
params := match_functions.UpdateMatchFunctionParams{ ... }
res, err := matchFunctionsService.UpdateMatchFunctionShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'function'
- 'functions'
- 'match'
- 'update'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [UPDATE]'
'UpdateMatchPoolShort@go.match2.fun':
id: 'UpdateMatchPoolShort@go.match2.fun'
name: 'UpdateMatchPoolShort'
type: 'function'
description: |-
Updates an existing matchmaking pool.
ticket_expiration_seconds and backfill_ticket_expiration_seconds will be set to 300 seconds (5 minutes) by default if not filled.
Match Function holds information about the name of the match logic server that matchmaking can refers to. By default we provide ("default" and "basic").
Match Function will be used as reference value for Match Function Overrides if not set.
In case Customer would like to use matchmaking service default match logic, then specify it in "match_function_overrides".
This sample configuration will let matchmaking service will use "default" match logic for make matches, while validation will hit both "default" and "custom" match logics.
e.g.
{
"match_function": "custom",
"match_function_overrides": {
"validation": []{"default","custom"},
"make_matches": "default",
}
}
struct: 'MatchPoolsService'
arguments:
params:
type: '*match_pools.UpdateMatchPoolParams'
required: true
return_type: '(*match_pools.UpdateMatchPoolResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/match_pools'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/matchPools.go'
example: |-
matchPoolsService := match2.MatchPoolsService{ ... }
params := match_pools.UpdateMatchPoolParams{ ... }
res, err := matchPoolsService.UpdateMatchPoolShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'match'
- 'pool'
- 'pools'
- 'update'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [UPDATE]'
'UpdateRuleSetShort@go.match2.fun':
id: 'UpdateRuleSetShort@go.match2.fun'
name: 'UpdateRuleSetShort'
type: 'function'
description: |-
Updates an existing matchmaking rule set.
To use custom rules set please set enable_custom_match_function=true. Default (false).
When custom enable_custom_match_function=true, the ruleset will only validate if the rule is valid json.
struct: 'RuleSetsService'
arguments:
params:
type: '*rule_sets.UpdateRuleSetParams'
required: true
return_type: '(*rule_sets.UpdateRuleSetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/rule_sets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/ruleSets.go'
example: |-
ruleSetsService := match2.RuleSetsService{ ... }
params := rule_sets.UpdateRuleSetParams{ ... }
res, err := ruleSetsService.UpdateRuleSetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'rule'
- 'set'
- 'sets'
- 'update'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [UPDATE]'
'VersionCheckHandlerShort@go.match2.fun':
id: 'VersionCheckHandlerShort@go.match2.fun'
name: 'VersionCheckHandlerShort'
type: 'function'
struct: 'EmptyService'
arguments:
params:
type: '*.VersionCheckHandlerParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2clientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/match2-sdk/pkg/match2client/'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/match2'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/match2/.go'
example: |-
emptyService := match2.EmptyService{ ... }
params := .VersionCheckHandlerParams{ ... }
res, err := emptyService.VersionCheckHandlerShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'check'
- 'handler'
- 'version'
# endregion functions