pb

package
v0.0.0-...-c39517e Latest Latest
Warning

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

Go to latest
Published: Dec 5, 2022 License: Apache-2.0 Imports: 21 Imported by: 2

Documentation

Overview

Package pb is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var (
	DoubleRangeFilter_Exclude_name = map[int32]string{
		0: "NONE",
		1: "MIN",
		2: "MAX",
		3: "BOTH",
	}
	DoubleRangeFilter_Exclude_value = map[string]int32{
		"NONE": 0,
		"MIN":  1,
		"MAX":  2,
		"BOTH": 3,
	}
)

Enum value maps for DoubleRangeFilter_Exclude.

View Source
var File_api_frontend_proto protoreflect.FileDescriptor
View Source
var File_api_internal_proto protoreflect.FileDescriptor
View Source
var File_api_match_logic_proto protoreflect.FileDescriptor
View Source
var File_api_messages_proto protoreflect.FileDescriptor

Functions

func RegisterAssignmentServiceServer

func RegisterAssignmentServiceServer(s *grpc.Server, srv AssignmentServiceServer)

func RegisterDataServiceServer

func RegisterDataServiceServer(s *grpc.Server, srv DataServiceServer)

func RegisterFrontendServiceHandler

func RegisterFrontendServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterFrontendServiceHandler registers the http handlers for service FrontendService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterFrontendServiceHandlerClient

func RegisterFrontendServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client FrontendServiceClient) error

RegisterFrontendServiceHandlerClient registers the http handlers for service FrontendService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "FrontendServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "FrontendServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "FrontendServiceClient" to call the correct interceptors.

func RegisterFrontendServiceHandlerFromEndpoint

func RegisterFrontendServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterFrontendServiceHandlerFromEndpoint is same as RegisterFrontendServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterFrontendServiceHandlerServer

func RegisterFrontendServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server FrontendServiceServer) error

RegisterFrontendServiceHandlerServer registers the http handlers for service FrontendService to "mux". UnaryRPC :call FrontendServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterFrontendServiceHandlerFromEndpoint instead.

func RegisterFrontendServiceServer

func RegisterFrontendServiceServer(s *grpc.Server, srv FrontendServiceServer)

func RegisterMatchMakerServiceServer

func RegisterMatchMakerServiceServer(s *grpc.Server, srv MatchMakerServiceServer)

func RegisterValidationServiceServer

func RegisterValidationServiceServer(s *grpc.Server, srv ValidationServiceServer)

Types

type AcknowledgeBackfillRequest

type AcknowledgeBackfillRequest struct {

	// An existing ID of Backfill to acknowledge.
	BackfillId string `protobuf:"bytes,1,opt,name=backfill_id,json=backfillId,proto3" json:"backfill_id,omitempty"`
	// An updated Assignment of the requested Backfill.
	Assignment *Assignment `protobuf:"bytes,2,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*AcknowledgeBackfillRequest) Descriptor deprecated

func (*AcknowledgeBackfillRequest) Descriptor() ([]byte, []int)

Deprecated: Use AcknowledgeBackfillRequest.ProtoReflect.Descriptor instead.

func (*AcknowledgeBackfillRequest) GetAssignment

func (x *AcknowledgeBackfillRequest) GetAssignment() *Assignment

func (*AcknowledgeBackfillRequest) GetBackfillId

func (x *AcknowledgeBackfillRequest) GetBackfillId() string

func (*AcknowledgeBackfillRequest) ProtoMessage

func (*AcknowledgeBackfillRequest) ProtoMessage()

func (*AcknowledgeBackfillRequest) ProtoReflect

func (*AcknowledgeBackfillRequest) Reset

func (x *AcknowledgeBackfillRequest) Reset()

func (*AcknowledgeBackfillRequest) String

func (x *AcknowledgeBackfillRequest) String() string

type Assignment

type Assignment struct {

	// Connection information for this Assignment.
	Connection string `protobuf:"bytes,1,opt,name=connection,proto3" json:"connection,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match
	// making function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

An Assignment represents a game server assignment associated with a Ticket. Open Match does not require or inspect any fields on assignment.

func (*Assignment) Descriptor deprecated

func (*Assignment) Descriptor() ([]byte, []int)

Deprecated: Use Assignment.ProtoReflect.Descriptor instead.

func (*Assignment) GetConnection

func (x *Assignment) GetConnection() string

func (*Assignment) GetExtensions

func (x *Assignment) GetExtensions() map[string]*anypb.Any

func (*Assignment) ProtoMessage

func (*Assignment) ProtoMessage()

func (*Assignment) ProtoReflect

func (x *Assignment) ProtoReflect() protoreflect.Message

func (*Assignment) Reset

func (x *Assignment) Reset()

func (*Assignment) String

func (x *Assignment) String() string

type AssignmentServiceClient

type AssignmentServiceClient interface {
	MakeAssignment(ctx context.Context, in *Match, opts ...grpc.CallOption) (*Assignment, error)
}

AssignmentServiceClient is the client API for AssignmentService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type AssignmentServiceServer

type AssignmentServiceServer interface {
	MakeAssignment(context.Context, *Match) (*Assignment, error)
}

AssignmentServiceServer is the server API for AssignmentService service.

type Backfill

type Backfill struct {

	// Id represents an auto-generated Id issued by Open Match.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Search fields are the fields which Open Match is aware of, and can be used
	// when specifying filters.
	SearchFields *SearchFields `protobuf:"bytes,2,opt,name=search_fields,json=searchFields,proto3" json:"search_fields,omitempty"`
	// Customized information not inspected by Open Match, to be used by
	// the Match Function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions *Extensions `protobuf:"bytes,3,opt,name=extensions,proto3" json:"extensions,omitempty"`
	// Create time is the time the Ticket was created. It is populated by Open
	// Match at the time of Ticket creation.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Generation gets incremented on GameServers update operations.
	// Prevents the MMF from overriding a newer version from the game server.
	// Do NOT read or write to this field, it is for internal tracking, and changing the value will cause bugs.
	Generation int64 `protobuf:"varint,5,opt,name=generation,proto3" json:"generation,omitempty"`
	// Tickets belonging to this backfill.
	Tickets []*Ticket `protobuf:"bytes,6,rep,name=tickets,proto3" json:"tickets,omitempty"`
	// contains filtered or unexported fields
}

Represents a backfill entity which is used to fill partially full matches.

BETA FEATURE WARNING: This call and the associated Request and Response messages are not finalized and still subject to possible change or removal.

func (*Backfill) Descriptor deprecated

func (*Backfill) Descriptor() ([]byte, []int)

Deprecated: Use Backfill.ProtoReflect.Descriptor instead.

func (*Backfill) GetCreateTime

func (x *Backfill) GetCreateTime() *timestamppb.Timestamp

func (*Backfill) GetExtensions

func (x *Backfill) GetExtensions() *Extensions

func (*Backfill) GetGeneration

func (x *Backfill) GetGeneration() int64

func (*Backfill) GetId

func (x *Backfill) GetId() string

func (*Backfill) GetSearchFields

func (x *Backfill) GetSearchFields() *SearchFields

func (*Backfill) GetTickets

func (x *Backfill) GetTickets() []*Ticket

func (*Backfill) ProtoMessage

func (*Backfill) ProtoMessage()

func (*Backfill) ProtoReflect

func (x *Backfill) ProtoReflect() protoreflect.Message

func (*Backfill) Reset

func (x *Backfill) Reset()

func (*Backfill) String

func (x *Backfill) String() string

type CreateBackfillRequest

type CreateBackfillRequest struct {

	// An empty Backfill object.
	Backfill *Backfill `protobuf:"bytes,1,opt,name=backfill,proto3" json:"backfill,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*CreateBackfillRequest) Descriptor deprecated

func (*CreateBackfillRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateBackfillRequest.ProtoReflect.Descriptor instead.

func (*CreateBackfillRequest) GetBackfill

func (x *CreateBackfillRequest) GetBackfill() *Backfill

func (*CreateBackfillRequest) ProtoMessage

func (*CreateBackfillRequest) ProtoMessage()

func (*CreateBackfillRequest) ProtoReflect

func (x *CreateBackfillRequest) ProtoReflect() protoreflect.Message

func (*CreateBackfillRequest) Reset

func (x *CreateBackfillRequest) Reset()

func (*CreateBackfillRequest) String

func (x *CreateBackfillRequest) String() string

type CreateTicketRequest

type CreateTicketRequest struct {

	// A Ticket object with SearchFields defined.
	Ticket *Ticket `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTicketRequest) Descriptor deprecated

func (*CreateTicketRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTicketRequest.ProtoReflect.Descriptor instead.

func (*CreateTicketRequest) GetTicket

func (x *CreateTicketRequest) GetTicket() *Ticket

func (*CreateTicketRequest) ProtoMessage

func (*CreateTicketRequest) ProtoMessage()

func (*CreateTicketRequest) ProtoReflect

func (x *CreateTicketRequest) ProtoReflect() protoreflect.Message

func (*CreateTicketRequest) Reset

func (x *CreateTicketRequest) Reset()

func (*CreateTicketRequest) String

func (x *CreateTicketRequest) String() string

type DataServiceClient

type DataServiceClient interface {
	// GatherData is where extra data from backend services can be added to the match request
	GatherData(ctx context.Context, in *Ticket, opts ...grpc.CallOption) (*GatherDataResponse, error)
}

DataServiceClient is the client API for DataService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type DataServiceServer

type DataServiceServer interface {
	// GatherData is where extra data from backend services can be added to the match request
	GatherData(context.Context, *Ticket) (*GatherDataResponse, error)
}

DataServiceServer is the server API for DataService service.

type DeleteBackfillRequest

type DeleteBackfillRequest struct {

	// An existing ID of Backfill to delete.
	BackfillId string `protobuf:"bytes,1,opt,name=backfill_id,json=backfillId,proto3" json:"backfill_id,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*DeleteBackfillRequest) Descriptor deprecated

func (*DeleteBackfillRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteBackfillRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackfillRequest) GetBackfillId

func (x *DeleteBackfillRequest) GetBackfillId() string

func (*DeleteBackfillRequest) ProtoMessage

func (*DeleteBackfillRequest) ProtoMessage()

func (*DeleteBackfillRequest) ProtoReflect

func (x *DeleteBackfillRequest) ProtoReflect() protoreflect.Message

func (*DeleteBackfillRequest) Reset

func (x *DeleteBackfillRequest) Reset()

func (*DeleteBackfillRequest) String

func (x *DeleteBackfillRequest) String() string

type DeleteTicketRequest

type DeleteTicketRequest struct {

	// A TicketId of a generated Ticket to be deleted.
	TicketId string `protobuf:"bytes,1,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteTicketRequest) Descriptor deprecated

func (*DeleteTicketRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTicketRequest.ProtoReflect.Descriptor instead.

func (*DeleteTicketRequest) GetTicketId

func (x *DeleteTicketRequest) GetTicketId() string

func (*DeleteTicketRequest) ProtoMessage

func (*DeleteTicketRequest) ProtoMessage()

func (*DeleteTicketRequest) ProtoReflect

func (x *DeleteTicketRequest) ProtoReflect() protoreflect.Message

func (*DeleteTicketRequest) Reset

func (x *DeleteTicketRequest) Reset()

func (*DeleteTicketRequest) String

func (x *DeleteTicketRequest) String() string

type DoubleRangeFilter

type DoubleRangeFilter struct {

	// Name of the ticket's search_fields.double_args this Filter operates on.
	DoubleArg string `protobuf:"bytes,1,opt,name=double_arg,json=doubleArg,proto3" json:"double_arg,omitempty"`
	// Maximum value.
	Max float64 `protobuf:"fixed64,2,opt,name=max,proto3" json:"max,omitempty"`
	// Minimum value.
	Min float64 `protobuf:"fixed64,3,opt,name=min,proto3" json:"min,omitempty"`
	// Defines the bounds to apply when filtering tickets by their search_fields.double_args value.
	// BETA FEATURE WARNING: This field and the associated values are
	// not finalized and still subject to possible change or removal.
	Exclude DoubleRangeFilter_Exclude `protobuf:"varint,4,opt,name=exclude,proto3,enum=openmatch.DoubleRangeFilter_Exclude" json:"exclude,omitempty"`
	// contains filtered or unexported fields
}

Filters numerical values to only those within a range.

double_arg: "foo"
max: 10
min: 5

matches:

{"foo": 5}
{"foo": 7.5}
{"foo": 10}

does not match:

{"foo": 4}
{"foo": 10.01}
{"foo": "7.5"}
{}

func (*DoubleRangeFilter) Descriptor deprecated

func (*DoubleRangeFilter) Descriptor() ([]byte, []int)

Deprecated: Use DoubleRangeFilter.ProtoReflect.Descriptor instead.

func (*DoubleRangeFilter) GetDoubleArg

func (x *DoubleRangeFilter) GetDoubleArg() string

func (*DoubleRangeFilter) GetExclude

func (*DoubleRangeFilter) GetMax

func (x *DoubleRangeFilter) GetMax() float64

func (*DoubleRangeFilter) GetMin

func (x *DoubleRangeFilter) GetMin() float64

func (*DoubleRangeFilter) ProtoMessage

func (*DoubleRangeFilter) ProtoMessage()

func (*DoubleRangeFilter) ProtoReflect

func (x *DoubleRangeFilter) ProtoReflect() protoreflect.Message

func (*DoubleRangeFilter) Reset

func (x *DoubleRangeFilter) Reset()

func (*DoubleRangeFilter) String

func (x *DoubleRangeFilter) String() string

type DoubleRangeFilter_Exclude

type DoubleRangeFilter_Exclude int32
const (
	// No bounds should be excluded when evaluating the filter, i.e.: MIN <= x <= MAX
	DoubleRangeFilter_NONE DoubleRangeFilter_Exclude = 0
	// Only the minimum bound should be excluded when evaluating the filter, i.e.: MIN < x <= MAX
	DoubleRangeFilter_MIN DoubleRangeFilter_Exclude = 1
	// Only the maximum bound should be excluded when evaluating the filter, i.e.: MIN <= x < MAX
	DoubleRangeFilter_MAX DoubleRangeFilter_Exclude = 2
	// Both bounds should be excluded when evaluating the filter, i.e.: MIN < x < MAX
	DoubleRangeFilter_BOTH DoubleRangeFilter_Exclude = 3
)

func (DoubleRangeFilter_Exclude) Descriptor

func (DoubleRangeFilter_Exclude) Enum

func (DoubleRangeFilter_Exclude) EnumDescriptor deprecated

func (DoubleRangeFilter_Exclude) EnumDescriptor() ([]byte, []int)

Deprecated: Use DoubleRangeFilter_Exclude.Descriptor instead.

func (DoubleRangeFilter_Exclude) Number

func (DoubleRangeFilter_Exclude) String

func (x DoubleRangeFilter_Exclude) String() string

func (DoubleRangeFilter_Exclude) Type

type Extensions

type Extensions struct {

	//extensions is a map of string to arbitrary data which does not fit within any of the typed fields below. This object
	//is harder to work with, and so the typed extensions should be preferred if available.
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	//double_extensions are double-typed extensions contained within the ticket/backfill
	DoubleExtensions map[string]float64 `` /* 177-byte string literal not displayed */
	//string_extensions are string-typed extensions contained within the ticket/backfill
	StringExtensions map[string]string `` /* 175-byte string literal not displayed */
	//tag_extensions are tag-typed extensions contained within the ticket/backfill
	TagExtensions []string `protobuf:"bytes,4,rep,name=tag_extensions,proto3" json:"tag_extensions,omitempty"`
	// contains filtered or unexported fields
}

Extensions are data elements passed through to the match function and to the Game Server. While these fields are not indexed by Open Match, the volume of data contained within does affect matchmaking performance so consideration should be given to whether data is required in extensions or not.

func (*Extensions) Descriptor deprecated

func (*Extensions) Descriptor() ([]byte, []int)

Deprecated: Use Extensions.ProtoReflect.Descriptor instead.

func (*Extensions) GetDoubleExtensions

func (x *Extensions) GetDoubleExtensions() map[string]float64

func (*Extensions) GetExtensions

func (x *Extensions) GetExtensions() map[string]*anypb.Any

func (*Extensions) GetStringExtensions

func (x *Extensions) GetStringExtensions() map[string]string

func (*Extensions) GetTagExtensions

func (x *Extensions) GetTagExtensions() []string

func (*Extensions) ProtoMessage

func (*Extensions) ProtoMessage()

func (*Extensions) ProtoReflect

func (x *Extensions) ProtoReflect() protoreflect.Message

func (*Extensions) Reset

func (x *Extensions) Reset()

func (*Extensions) String

func (x *Extensions) String() string

type FrontendServiceClient

type FrontendServiceClient interface {
	// CreateTicket assigns an unique TicketId to the input Ticket and record it in state storage.
	// A ticket is considered as ready for matchmaking once it is created.
	//   - If a TicketId exists in a Ticket request, an auto-generated TicketId will override this field.
	//   - If SearchFields exist in a Ticket, CreateTicket will also index these fields such that one can query the ticket with query.QueryTickets function.
	CreateTicket(ctx context.Context, in *CreateTicketRequest, opts ...grpc.CallOption) (*Ticket, error)
	// DeleteTicket immediately stops Open Match from using the Ticket for matchmaking and removes the Ticket from state storage.
	// The client should delete the Ticket when finished matchmaking with it.
	DeleteTicket(ctx context.Context, in *DeleteTicketRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// GetTicket get the Ticket associated with the specified TicketId.
	GetTicket(ctx context.Context, in *GetTicketRequest, opts ...grpc.CallOption) (*Ticket, error)
	// WatchAssignments stream back Assignment of the specified TicketId if it is updated.
	//   - If the Assignment is not updated, GetAssignment will retry using the configured backoff strategy.
	WatchAssignments(ctx context.Context, in *WatchAssignmentsRequest, opts ...grpc.CallOption) (FrontendService_WatchAssignmentsClient, error)
	// AcknowledgeBackfill is used to notify OpenMatch about GameServer connection info
	// This triggers an assignment process.
	// BETA FEATURE WARNING: This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	AcknowledgeBackfill(ctx context.Context, in *AcknowledgeBackfillRequest, opts ...grpc.CallOption) (*Backfill, error)
	// CreateBackfill creates a new Backfill object.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	CreateBackfill(ctx context.Context, in *CreateBackfillRequest, opts ...grpc.CallOption) (*Backfill, error)
	// DeleteBackfill receives a backfill ID and deletes its resource.
	// Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	DeleteBackfill(ctx context.Context, in *DeleteBackfillRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// GetBackfill returns a backfill object by its ID.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	GetBackfill(ctx context.Context, in *GetBackfillRequest, opts ...grpc.CallOption) (*Backfill, error)
	// UpdateBackfill updates search_fields and extensions for the backfill with the provided id.
	// Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	UpdateBackfill(ctx context.Context, in *UpdateBackfillRequest, opts ...grpc.CallOption) (*Backfill, error)
}

FrontendServiceClient is the client API for FrontendService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type FrontendServiceServer

type FrontendServiceServer interface {
	// CreateTicket assigns an unique TicketId to the input Ticket and record it in state storage.
	// A ticket is considered as ready for matchmaking once it is created.
	//   - If a TicketId exists in a Ticket request, an auto-generated TicketId will override this field.
	//   - If SearchFields exist in a Ticket, CreateTicket will also index these fields such that one can query the ticket with query.QueryTickets function.
	CreateTicket(context.Context, *CreateTicketRequest) (*Ticket, error)
	// DeleteTicket immediately stops Open Match from using the Ticket for matchmaking and removes the Ticket from state storage.
	// The client should delete the Ticket when finished matchmaking with it.
	DeleteTicket(context.Context, *DeleteTicketRequest) (*emptypb.Empty, error)
	// GetTicket get the Ticket associated with the specified TicketId.
	GetTicket(context.Context, *GetTicketRequest) (*Ticket, error)
	// WatchAssignments stream back Assignment of the specified TicketId if it is updated.
	//   - If the Assignment is not updated, GetAssignment will retry using the configured backoff strategy.
	WatchAssignments(*WatchAssignmentsRequest, FrontendService_WatchAssignmentsServer) error
	// AcknowledgeBackfill is used to notify OpenMatch about GameServer connection info
	// This triggers an assignment process.
	// BETA FEATURE WARNING: This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	AcknowledgeBackfill(context.Context, *AcknowledgeBackfillRequest) (*Backfill, error)
	// CreateBackfill creates a new Backfill object.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	CreateBackfill(context.Context, *CreateBackfillRequest) (*Backfill, error)
	// DeleteBackfill receives a backfill ID and deletes its resource.
	// Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	DeleteBackfill(context.Context, *DeleteBackfillRequest) (*emptypb.Empty, error)
	// GetBackfill returns a backfill object by its ID.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	GetBackfill(context.Context, *GetBackfillRequest) (*Backfill, error)
	// UpdateBackfill updates search_fields and extensions for the backfill with the provided id.
	// Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
	// BETA FEATURE WARNING:  This call and the associated Request and Response
	// messages are not finalized and still subject to possible change or removal.
	UpdateBackfill(context.Context, *UpdateBackfillRequest) (*Backfill, error)
}

FrontendServiceServer is the server API for FrontendService service.

type FrontendService_WatchAssignmentsClient

type FrontendService_WatchAssignmentsClient interface {
	Recv() (*WatchAssignmentsResponse, error)
	grpc.ClientStream
}

type FrontendService_WatchAssignmentsServer

type FrontendService_WatchAssignmentsServer interface {
	Send(*WatchAssignmentsResponse) error
	grpc.ServerStream
}

type GatherDataResponse

type GatherDataResponse struct {

	// Search fields are the fields which Open Match is aware of, and can be used when specifying filters.
	SearchFields *SearchFields `protobuf:"bytes,1,opt,name=search_fields,proto3" json:"search_fields,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match making function, evaluator, and
	// components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions *Extensions `protobuf:"bytes,2,opt,name=extensions,proto3" json:"extensions,omitempty"`
	// contains filtered or unexported fields
}

func (*GatherDataResponse) Descriptor deprecated

func (*GatherDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use GatherDataResponse.ProtoReflect.Descriptor instead.

func (*GatherDataResponse) GetExtensions

func (x *GatherDataResponse) GetExtensions() *Extensions

func (*GatherDataResponse) GetSearchFields

func (x *GatherDataResponse) GetSearchFields() *SearchFields

func (*GatherDataResponse) ProtoMessage

func (*GatherDataResponse) ProtoMessage()

func (*GatherDataResponse) ProtoReflect

func (x *GatherDataResponse) ProtoReflect() protoreflect.Message

func (*GatherDataResponse) Reset

func (x *GatherDataResponse) Reset()

func (*GatherDataResponse) String

func (x *GatherDataResponse) String() string

type GetBackfillRequest

type GetBackfillRequest struct {

	// An existing ID of Backfill to retrieve.
	BackfillId string `protobuf:"bytes,1,opt,name=backfill_id,json=backfillId,proto3" json:"backfill_id,omitempty"`
	// contains filtered or unexported fields
}

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*GetBackfillRequest) Descriptor deprecated

func (*GetBackfillRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetBackfillRequest.ProtoReflect.Descriptor instead.

func (*GetBackfillRequest) GetBackfillId

func (x *GetBackfillRequest) GetBackfillId() string

func (*GetBackfillRequest) ProtoMessage

func (*GetBackfillRequest) ProtoMessage()

func (*GetBackfillRequest) ProtoReflect

func (x *GetBackfillRequest) ProtoReflect() protoreflect.Message

func (*GetBackfillRequest) Reset

func (x *GetBackfillRequest) Reset()

func (*GetBackfillRequest) String

func (x *GetBackfillRequest) String() string

type GetTicketRequest

type GetTicketRequest struct {

	// A TicketId of a generated Ticket.
	TicketId string `protobuf:"bytes,1,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTicketRequest) Descriptor deprecated

func (*GetTicketRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTicketRequest.ProtoReflect.Descriptor instead.

func (*GetTicketRequest) GetTicketId

func (x *GetTicketRequest) GetTicketId() string

func (*GetTicketRequest) ProtoMessage

func (*GetTicketRequest) ProtoMessage()

func (*GetTicketRequest) ProtoReflect

func (x *GetTicketRequest) ProtoReflect() protoreflect.Message

func (*GetTicketRequest) Reset

func (x *GetTicketRequest) Reset()

func (*GetTicketRequest) String

func (x *GetTicketRequest) String() string

type MakeMatchesRequest

type MakeMatchesRequest struct {

	// A MatchProfile is Open Match's representation of a Match specification. It is used to indicate the criteria for
	// selecting players for a match. A MatchProfile is the input to the API to get matches and is passed to the
	// MatchFunction. It contains all the information required by the MatchFunction to generate match proposals.
	MatchProfile *MatchProfile `protobuf:"bytes,1,opt,name=match_profile,proto3" json:"match_profile,omitempty"`
	// Pool tickets is a map from a pool name to a list of tickets that match the given pool in the match profile.
	PoolTickets map[string]*MakeMatchesRequest_PoolTickets `` /* 165-byte string literal not displayed */
	// Pool Backfills is a map from a pool name to a list of backfills that match the given pool in the match profile.
	PoolBackfills map[string]*MakeMatchesRequest_PoolBackfills `` /* 169-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*MakeMatchesRequest) Descriptor deprecated

func (*MakeMatchesRequest) Descriptor() ([]byte, []int)

Deprecated: Use MakeMatchesRequest.ProtoReflect.Descriptor instead.

func (*MakeMatchesRequest) GetMatchProfile

func (x *MakeMatchesRequest) GetMatchProfile() *MatchProfile

func (*MakeMatchesRequest) GetPoolBackfills

func (x *MakeMatchesRequest) GetPoolBackfills() map[string]*MakeMatchesRequest_PoolBackfills

func (*MakeMatchesRequest) GetPoolTickets

func (x *MakeMatchesRequest) GetPoolTickets() map[string]*MakeMatchesRequest_PoolTickets

func (*MakeMatchesRequest) ProtoMessage

func (*MakeMatchesRequest) ProtoMessage()

func (*MakeMatchesRequest) ProtoReflect

func (x *MakeMatchesRequest) ProtoReflect() protoreflect.Message

func (*MakeMatchesRequest) Reset

func (x *MakeMatchesRequest) Reset()

func (*MakeMatchesRequest) String

func (x *MakeMatchesRequest) String() string

type MakeMatchesRequest_PoolBackfills

type MakeMatchesRequest_PoolBackfills struct {

	// A list of backfills that match this pool
	Backfill []*Backfill `protobuf:"bytes,1,rep,name=backfill,proto3" json:"backfill,omitempty"`
	// contains filtered or unexported fields
}

func (*MakeMatchesRequest_PoolBackfills) Descriptor deprecated

func (*MakeMatchesRequest_PoolBackfills) Descriptor() ([]byte, []int)

Deprecated: Use MakeMatchesRequest_PoolBackfills.ProtoReflect.Descriptor instead.

func (*MakeMatchesRequest_PoolBackfills) GetBackfill

func (x *MakeMatchesRequest_PoolBackfills) GetBackfill() []*Backfill

func (*MakeMatchesRequest_PoolBackfills) ProtoMessage

func (*MakeMatchesRequest_PoolBackfills) ProtoMessage()

func (*MakeMatchesRequest_PoolBackfills) ProtoReflect

func (*MakeMatchesRequest_PoolBackfills) Reset

func (*MakeMatchesRequest_PoolBackfills) String

type MakeMatchesRequest_PoolTickets

type MakeMatchesRequest_PoolTickets struct {

	// A list of tickets that match this pool
	Tickets []*Ticket `protobuf:"bytes,1,rep,name=tickets,proto3" json:"tickets,omitempty"`
	// contains filtered or unexported fields
}

func (*MakeMatchesRequest_PoolTickets) Descriptor deprecated

func (*MakeMatchesRequest_PoolTickets) Descriptor() ([]byte, []int)

Deprecated: Use MakeMatchesRequest_PoolTickets.ProtoReflect.Descriptor instead.

func (*MakeMatchesRequest_PoolTickets) GetTickets

func (x *MakeMatchesRequest_PoolTickets) GetTickets() []*Ticket

func (*MakeMatchesRequest_PoolTickets) ProtoMessage

func (*MakeMatchesRequest_PoolTickets) ProtoMessage()

func (*MakeMatchesRequest_PoolTickets) ProtoReflect

func (*MakeMatchesRequest_PoolTickets) Reset

func (x *MakeMatchesRequest_PoolTickets) Reset()

func (*MakeMatchesRequest_PoolTickets) String

type MakeMatchesResponse

type MakeMatchesResponse struct {
	Match *Match  `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	Score float64 `protobuf:"fixed64,2,opt,name=score,proto3" json:"score,omitempty"`
	// contains filtered or unexported fields
}

func (*MakeMatchesResponse) Descriptor deprecated

func (*MakeMatchesResponse) Descriptor() ([]byte, []int)

Deprecated: Use MakeMatchesResponse.ProtoReflect.Descriptor instead.

func (*MakeMatchesResponse) GetMatch

func (x *MakeMatchesResponse) GetMatch() *Match

func (*MakeMatchesResponse) GetScore

func (x *MakeMatchesResponse) GetScore() float64

func (*MakeMatchesResponse) ProtoMessage

func (*MakeMatchesResponse) ProtoMessage()

func (*MakeMatchesResponse) ProtoReflect

func (x *MakeMatchesResponse) ProtoReflect() protoreflect.Message

func (*MakeMatchesResponse) Reset

func (x *MakeMatchesResponse) Reset()

func (*MakeMatchesResponse) String

func (x *MakeMatchesResponse) String() string

type Match

type Match struct {

	// A Match ID that should be passed through the stack for tracing.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId,proto3" json:"match_id,omitempty"`
	// Name of the match profile that generated this Match.
	MatchProfile string `protobuf:"bytes,2,opt,name=match_profile,json=matchProfile,proto3" json:"match_profile,omitempty"`
	// Name of the match function that generated this Match.
	MatchFunction string `protobuf:"bytes,3,opt,name=match_function,json=matchFunction,proto3" json:"match_function,omitempty"`
	// Tickets belonging to this match.
	Tickets []*Ticket `protobuf:"bytes,4,rep,name=tickets,proto3" json:"tickets,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match
	// making function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// Backfill request which contains additional information to the match
	// and contains an association to a GameServer.
	// BETA FEATURE WARNING: This field is not finalized and still subject
	// to possible change or removal.
	Backfill *Backfill `protobuf:"bytes,8,opt,name=backfill,proto3" json:"backfill,omitempty"`
	// AllocateGameServer signalise Director that Backfill is new and it should
	// allocate a GameServer, this Backfill would be assigned.
	// BETA FEATURE WARNING: This field is not finalized and still subject
	// to possible change or removal.
	AllocateGameserver bool `protobuf:"varint,9,opt,name=allocate_gameserver,json=allocateGameserver,proto3" json:"allocate_gameserver,omitempty"`
	// contains filtered or unexported fields
}

A Match is used to represent a completed match object. It can be generated by a MatchFunction as a proposal or can be returned by OpenMatch as a result in response to the FetchMatches call. When a match is returned by the FetchMatches call, it should contain at least one ticket to be considered as valid.

func (*Match) Descriptor deprecated

func (*Match) Descriptor() ([]byte, []int)

Deprecated: Use Match.ProtoReflect.Descriptor instead.

func (*Match) GetAllocateGameserver

func (x *Match) GetAllocateGameserver() bool

func (*Match) GetBackfill

func (x *Match) GetBackfill() *Backfill

func (*Match) GetExtensions

func (x *Match) GetExtensions() map[string]*anypb.Any

func (*Match) GetMatchFunction

func (x *Match) GetMatchFunction() string

func (*Match) GetMatchId

func (x *Match) GetMatchId() string

func (*Match) GetMatchProfile

func (x *Match) GetMatchProfile() string

func (*Match) GetTickets

func (x *Match) GetTickets() []*Ticket

func (*Match) ProtoMessage

func (*Match) ProtoMessage()

func (*Match) ProtoReflect

func (x *Match) ProtoReflect() protoreflect.Message

func (*Match) Reset

func (x *Match) Reset()

func (*Match) String

func (x *Match) String() string

type MatchMakerServiceClient

type MatchMakerServiceClient interface {
	// MakeMatches takes a MatchProfile and a map of pool names to ticket slices, and creates
	// a slice of Match's from that information
	MakeMatches(ctx context.Context, in *MakeMatchesRequest, opts ...grpc.CallOption) (MatchMakerService_MakeMatchesClient, error)
}

MatchMakerServiceClient is the client API for MatchMakerService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type MatchMakerServiceServer

type MatchMakerServiceServer interface {
	// MakeMatches takes a MatchProfile and a map of pool names to ticket slices, and creates
	// a slice of Match's from that information
	MakeMatches(*MakeMatchesRequest, MatchMakerService_MakeMatchesServer) error
}

MatchMakerServiceServer is the server API for MatchMakerService service.

type MatchMakerService_MakeMatchesClient

type MatchMakerService_MakeMatchesClient interface {
	Recv() (*MakeMatchesResponse, error)
	grpc.ClientStream
}

type MatchMakerService_MakeMatchesServer

type MatchMakerService_MakeMatchesServer interface {
	Send(*MakeMatchesResponse) error
	grpc.ServerStream
}

type MatchProfile

type MatchProfile struct {

	// Name of this match profile.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Set of pools to be queried when generating a match for this MatchProfile.
	Pools []*Pool `protobuf:"bytes,3,rep,name=pools,proto3" json:"pools,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match
	// making function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

A MatchProfile is Open Match's representation of a Match specification. It is used to indicate the criteria for selecting players for a match. A MatchProfile is the input to the API to get matches and is passed to the MatchFunction. It contains all the information required by the MatchFunction to generate match proposals.

func (*MatchProfile) Descriptor deprecated

func (*MatchProfile) Descriptor() ([]byte, []int)

Deprecated: Use MatchProfile.ProtoReflect.Descriptor instead.

func (*MatchProfile) GetExtensions

func (x *MatchProfile) GetExtensions() map[string]*anypb.Any

func (*MatchProfile) GetName

func (x *MatchProfile) GetName() string

func (*MatchProfile) GetPools

func (x *MatchProfile) GetPools() []*Pool

func (*MatchProfile) ProtoMessage

func (*MatchProfile) ProtoMessage()

func (*MatchProfile) ProtoReflect

func (x *MatchProfile) ProtoReflect() protoreflect.Message

func (*MatchProfile) Reset

func (x *MatchProfile) Reset()

func (*MatchProfile) String

func (x *MatchProfile) String() string

type Pool

type Pool struct {

	// A developer-chosen human-readable name for this Pool.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Set of Filters indicating the filtering criteria. Selected tickets must
	// match every Filter.
	DoubleRangeFilters  []*DoubleRangeFilter  `protobuf:"bytes,2,rep,name=double_range_filters,json=doubleRangeFilters,proto3" json:"double_range_filters,omitempty"`
	StringEqualsFilters []*StringEqualsFilter `protobuf:"bytes,4,rep,name=string_equals_filters,json=stringEqualsFilters,proto3" json:"string_equals_filters,omitempty"`
	TagPresentFilters   []*TagPresentFilter   `protobuf:"bytes,5,rep,name=tag_present_filters,json=tagPresentFilters,proto3" json:"tag_present_filters,omitempty"`
	// If specified, only Tickets created before the specified time are selected.
	CreatedBefore *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created_before,json=createdBefore,proto3" json:"created_before,omitempty"`
	// If specified, only Tickets created after the specified time are selected.
	CreatedAfter *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=created_after,json=createdAfter,proto3" json:"created_after,omitempty"`
	// contains filtered or unexported fields
}

Pool specfies a set of criteria that are used to select a subset of Tickets that meet all the criteria.

func (*Pool) Descriptor deprecated

func (*Pool) Descriptor() ([]byte, []int)

Deprecated: Use Pool.ProtoReflect.Descriptor instead.

func (*Pool) GetCreatedAfter

func (x *Pool) GetCreatedAfter() *timestamppb.Timestamp

func (*Pool) GetCreatedBefore

func (x *Pool) GetCreatedBefore() *timestamppb.Timestamp

func (*Pool) GetDoubleRangeFilters

func (x *Pool) GetDoubleRangeFilters() []*DoubleRangeFilter

func (*Pool) GetName

func (x *Pool) GetName() string

func (*Pool) GetStringEqualsFilters

func (x *Pool) GetStringEqualsFilters() []*StringEqualsFilter

func (*Pool) GetTagPresentFilters

func (x *Pool) GetTagPresentFilters() []*TagPresentFilter

func (*Pool) ProtoMessage

func (*Pool) ProtoMessage()

func (*Pool) ProtoReflect

func (x *Pool) ProtoReflect() protoreflect.Message

func (*Pool) Reset

func (x *Pool) Reset()

func (*Pool) String

func (x *Pool) String() string

type SearchFields

type SearchFields struct {

	// Float arguments.  Filterable on ranges.
	DoubleArgs map[string]float64 `` /* 181-byte string literal not displayed */
	// String arguments.  Filterable on equality.
	StringArgs map[string]string `` /* 179-byte string literal not displayed */
	// Filterable on presence or absence of given value.
	Tags []string `protobuf:"bytes,3,rep,name=tags,proto3" json:"tags,omitempty"`
	// contains filtered or unexported fields
}

Search fields are the fields which Open Match is aware of, and can be used when specifying filters.

func (*SearchFields) Descriptor deprecated

func (*SearchFields) Descriptor() ([]byte, []int)

Deprecated: Use SearchFields.ProtoReflect.Descriptor instead.

func (*SearchFields) GetDoubleArgs

func (x *SearchFields) GetDoubleArgs() map[string]float64

func (*SearchFields) GetStringArgs

func (x *SearchFields) GetStringArgs() map[string]string

func (*SearchFields) GetTags

func (x *SearchFields) GetTags() []string

func (*SearchFields) ProtoMessage

func (*SearchFields) ProtoMessage()

func (*SearchFields) ProtoReflect

func (x *SearchFields) ProtoReflect() protoreflect.Message

func (*SearchFields) Reset

func (x *SearchFields) Reset()

func (*SearchFields) String

func (x *SearchFields) String() string

type StreamTicket

type StreamTicket struct {
	Profile  string `protobuf:"bytes,1,opt,name=profile,proto3" json:"profile,omitempty"`
	Pool     string `protobuf:"bytes,2,opt,name=pool,proto3" json:"pool,omitempty"`
	TicketId string `protobuf:"bytes,3,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamTicket) Descriptor deprecated

func (*StreamTicket) Descriptor() ([]byte, []int)

Deprecated: Use StreamTicket.ProtoReflect.Descriptor instead.

func (*StreamTicket) GetPool

func (x *StreamTicket) GetPool() string

func (*StreamTicket) GetProfile

func (x *StreamTicket) GetProfile() string

func (*StreamTicket) GetTicketId

func (x *StreamTicket) GetTicketId() string

func (*StreamTicket) ProtoMessage

func (*StreamTicket) ProtoMessage()

func (*StreamTicket) ProtoReflect

func (x *StreamTicket) ProtoReflect() protoreflect.Message

func (*StreamTicket) Reset

func (x *StreamTicket) Reset()

func (*StreamTicket) String

func (x *StreamTicket) String() string

type StringEqualsFilter

type StringEqualsFilter struct {

	// Name of the ticket's search_fields.string_args this Filter operates on.
	StringArg string `protobuf:"bytes,1,opt,name=string_arg,json=stringArg,proto3" json:"string_arg,omitempty"`
	Value     string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Filters strings exactly equaling a value.

string_arg: "foo"
value: "bar"

matches:

{"foo": "bar"}

does not match:

{"foo": "baz"}
{"bar": "foo"}
{}

func (*StringEqualsFilter) Descriptor deprecated

func (*StringEqualsFilter) Descriptor() ([]byte, []int)

Deprecated: Use StringEqualsFilter.ProtoReflect.Descriptor instead.

func (*StringEqualsFilter) GetStringArg

func (x *StringEqualsFilter) GetStringArg() string

func (*StringEqualsFilter) GetValue

func (x *StringEqualsFilter) GetValue() string

func (*StringEqualsFilter) ProtoMessage

func (*StringEqualsFilter) ProtoMessage()

func (*StringEqualsFilter) ProtoReflect

func (x *StringEqualsFilter) ProtoReflect() protoreflect.Message

func (*StringEqualsFilter) Reset

func (x *StringEqualsFilter) Reset()

func (*StringEqualsFilter) String

func (x *StringEqualsFilter) String() string

type TagPresentFilter

type TagPresentFilter struct {
	Tag string `protobuf:"bytes,1,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

Filters to the tag being present on the search_fields.

tag: "foo"

matches:

["foo"]
["bar","foo"]

does not match:

["bar"]
[]

func (*TagPresentFilter) Descriptor deprecated

func (*TagPresentFilter) Descriptor() ([]byte, []int)

Deprecated: Use TagPresentFilter.ProtoReflect.Descriptor instead.

func (*TagPresentFilter) GetTag

func (x *TagPresentFilter) GetTag() string

func (*TagPresentFilter) ProtoMessage

func (*TagPresentFilter) ProtoMessage()

func (*TagPresentFilter) ProtoReflect

func (x *TagPresentFilter) ProtoReflect() protoreflect.Message

func (*TagPresentFilter) Reset

func (x *TagPresentFilter) Reset()

func (*TagPresentFilter) String

func (x *TagPresentFilter) String() string

type Ticket

type Ticket struct {

	// Id represents an auto-generated Id issued by Open Match.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// An Assignment represents a game server assignment associated with a Ticket,
	// or whatever finalized matched state means for your use case.
	// Open Match does not require or inspect any fields on Assignment.
	Assignment *Assignment `protobuf:"bytes,3,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// Search fields are the fields which Open Match is aware of, and can be used
	// when specifying filters.
	SearchFields *SearchFields `protobuf:"bytes,4,opt,name=search_fields,json=searchFields,proto3" json:"search_fields,omitempty"`
	// Customized information not inspected by Open Match, to be used by the match
	// making function, evaluator, and components making calls to Open Match.
	// Optional, depending on the requirements of the connected systems.
	Extensions *Extensions `protobuf:"bytes,5,opt,name=extensions,proto3" json:"extensions,omitempty"`
	// Create time is the time the Ticket was created. It is populated by Open
	// Match at the time of Ticket creation.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

A Ticket is a basic matchmaking entity in Open Match. A Ticket may represent an individual 'Player', a 'Group' of players, or any other concepts unique to your use case. Open Match will not interpret what the Ticket represents but just treat it as a matchmaking unit with a set of SearchFields. Open Match stores the Ticket in state storage and enables an Assignment to be set on the Ticket.

func (*Ticket) Descriptor deprecated

func (*Ticket) Descriptor() ([]byte, []int)

Deprecated: Use Ticket.ProtoReflect.Descriptor instead.

func (*Ticket) GetAssignment

func (x *Ticket) GetAssignment() *Assignment

func (*Ticket) GetCreateTime

func (x *Ticket) GetCreateTime() *timestamppb.Timestamp

func (*Ticket) GetExtensions

func (x *Ticket) GetExtensions() *Extensions

func (*Ticket) GetId

func (x *Ticket) GetId() string

func (*Ticket) GetSearchFields

func (x *Ticket) GetSearchFields() *SearchFields

func (*Ticket) ProtoMessage

func (*Ticket) ProtoMessage()

func (*Ticket) ProtoReflect

func (x *Ticket) ProtoReflect() protoreflect.Message

func (*Ticket) Reset

func (x *Ticket) Reset()

func (*Ticket) String

func (x *Ticket) String() string

type UnimplementedAssignmentServiceServer

type UnimplementedAssignmentServiceServer struct {
}

UnimplementedAssignmentServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedAssignmentServiceServer) MakeAssignment

type UnimplementedDataServiceServer

type UnimplementedDataServiceServer struct {
}

UnimplementedDataServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDataServiceServer) GatherData

type UnimplementedFrontendServiceServer

type UnimplementedFrontendServiceServer struct {
}

UnimplementedFrontendServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedFrontendServiceServer) AcknowledgeBackfill

func (*UnimplementedFrontendServiceServer) CreateBackfill

func (*UnimplementedFrontendServiceServer) CreateTicket

func (*UnimplementedFrontendServiceServer) DeleteBackfill

func (*UnimplementedFrontendServiceServer) DeleteTicket

func (*UnimplementedFrontendServiceServer) GetBackfill

func (*UnimplementedFrontendServiceServer) GetTicket

func (*UnimplementedFrontendServiceServer) UpdateBackfill

type UnimplementedMatchMakerServiceServer

type UnimplementedMatchMakerServiceServer struct {
}

UnimplementedMatchMakerServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedMatchMakerServiceServer) MakeMatches

type UnimplementedValidationServiceServer

type UnimplementedValidationServiceServer struct {
}

UnimplementedValidationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedValidationServiceServer) Validate

type UpdateBackfillRequest

type UpdateBackfillRequest struct {

	// A Backfill object with ID set and fields to update.
	Backfill *Backfill `protobuf:"bytes,1,opt,name=backfill,proto3" json:"backfill,omitempty"`
	// contains filtered or unexported fields
}

UpdateBackfillRequest - update searchFields, extensions and set assignment.

BETA FEATURE WARNING: This Request message is not finalized and still subject to possible change or removal.

func (*UpdateBackfillRequest) Descriptor deprecated

func (*UpdateBackfillRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateBackfillRequest.ProtoReflect.Descriptor instead.

func (*UpdateBackfillRequest) GetBackfill

func (x *UpdateBackfillRequest) GetBackfill() *Backfill

func (*UpdateBackfillRequest) ProtoMessage

func (*UpdateBackfillRequest) ProtoMessage()

func (*UpdateBackfillRequest) ProtoReflect

func (x *UpdateBackfillRequest) ProtoReflect() protoreflect.Message

func (*UpdateBackfillRequest) Reset

func (x *UpdateBackfillRequest) Reset()

func (*UpdateBackfillRequest) String

func (x *UpdateBackfillRequest) String() string

type ValidateResponse

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

func (*ValidateResponse) Descriptor deprecated

func (*ValidateResponse) Descriptor() ([]byte, []int)

Deprecated: Use ValidateResponse.ProtoReflect.Descriptor instead.

func (*ValidateResponse) ProtoMessage

func (*ValidateResponse) ProtoMessage()

func (*ValidateResponse) ProtoReflect

func (x *ValidateResponse) ProtoReflect() protoreflect.Message

func (*ValidateResponse) Reset

func (x *ValidateResponse) Reset()

func (*ValidateResponse) String

func (x *ValidateResponse) String() string

type ValidationServiceClient

type ValidationServiceClient interface {
	// Validate is where custom validation can be performed
	Validate(ctx context.Context, in *Ticket, opts ...grpc.CallOption) (*ValidateResponse, error)
}

ValidationServiceClient is the client API for ValidationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type ValidationServiceServer

type ValidationServiceServer interface {
	// Validate is where custom validation can be performed
	Validate(context.Context, *Ticket) (*ValidateResponse, error)
}

ValidationServiceServer is the server API for ValidationService service.

type WatchAssignmentsRequest

type WatchAssignmentsRequest struct {

	// A TicketId of a generated Ticket to get updates on.
	TicketId string `protobuf:"bytes,1,opt,name=ticket_id,json=ticketId,proto3" json:"ticket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*WatchAssignmentsRequest) Descriptor deprecated

func (*WatchAssignmentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use WatchAssignmentsRequest.ProtoReflect.Descriptor instead.

func (*WatchAssignmentsRequest) GetTicketId

func (x *WatchAssignmentsRequest) GetTicketId() string

func (*WatchAssignmentsRequest) ProtoMessage

func (*WatchAssignmentsRequest) ProtoMessage()

func (*WatchAssignmentsRequest) ProtoReflect

func (x *WatchAssignmentsRequest) ProtoReflect() protoreflect.Message

func (*WatchAssignmentsRequest) Reset

func (x *WatchAssignmentsRequest) Reset()

func (*WatchAssignmentsRequest) String

func (x *WatchAssignmentsRequest) String() string

type WatchAssignmentsResponse

type WatchAssignmentsResponse struct {

	// An updated Assignment of the requested Ticket.
	Assignment *Assignment `protobuf:"bytes,1,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// contains filtered or unexported fields
}

func (*WatchAssignmentsResponse) Descriptor deprecated

func (*WatchAssignmentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use WatchAssignmentsResponse.ProtoReflect.Descriptor instead.

func (*WatchAssignmentsResponse) GetAssignment

func (x *WatchAssignmentsResponse) GetAssignment() *Assignment

func (*WatchAssignmentsResponse) ProtoMessage

func (*WatchAssignmentsResponse) ProtoMessage()

func (*WatchAssignmentsResponse) ProtoReflect

func (x *WatchAssignmentsResponse) ProtoReflect() protoreflect.Message

func (*WatchAssignmentsResponse) Reset

func (x *WatchAssignmentsResponse) Reset()

func (*WatchAssignmentsResponse) String

func (x *WatchAssignmentsResponse) String() string

Directories

Path Synopsis
Package mock_pb is a generated GoMock package.
Package mock_pb is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL