allocation

package
v1.48.0 Latest Latest
Warning

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

 Go to latest Published: Mar 25, 2025 License: Apache-2.0 Imports: 19 Imported by: 12

Documentation

Overview

Package allocation is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	AllocationRequest_SchedulingStrategy_name = map[int32]string{
		0: "Packed",
		1: "Distributed",
	}
	AllocationRequest_SchedulingStrategy_value = map[string]int32{
		"Packed":      0,
		"Distributed": 1,
	}
)

Enum value maps for AllocationRequest_SchedulingStrategy.

View Source 
var (
	GameServerSelector_GameServerState_name = map[int32]string{
		0: "READY",
		1: "ALLOCATED",
	}
	GameServerSelector_GameServerState_value = map[string]int32{
		"READY":     0,
		"ALLOCATED": 1,
	}
)

Enum value maps for GameServerSelector_GameServerState.

View Source 
var (
	Priority_Type_name = map[int32]string{
		0: "Counter",
		1: "List",
	}
	Priority_Type_value = map[string]int32{
		"Counter": 0,
		"List":    1,
	}
)

Enum value maps for Priority_Type.

View Source 
var (
	Priority_Order_name = map[int32]string{
		0: "Ascending",
		1: "Descending",
	}
	Priority_Order_value = map[string]int32{
		"Ascending":  0,
		"Descending": 1,
	}
)

Enum value maps for Priority_Order.

View Source 
var AllocationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "allocation.AllocationService",
	HandlerType: (*AllocationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Allocate",
			Handler:    _AllocationService_Allocate_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/allocation/allocation.proto",
}

AllocationService_ServiceDesc is the grpc.ServiceDesc for AllocationService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_proto_allocation_allocation_proto protoreflect.FileDescriptor

Functions

func RegisterAllocationServiceHandler 

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

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

func RegisterAllocationServiceHandlerClient 

func RegisterAllocationServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AllocationServiceClient) error

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

func RegisterAllocationServiceHandlerFromEndpoint 

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

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

func RegisterAllocationServiceHandlerServer 

func RegisterAllocationServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AllocationServiceServer) error

RegisterAllocationServiceHandlerServer registers the http handlers for service AllocationService to "mux". UnaryRPC :call AllocationServiceServer 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 RegisterAllocationServiceHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterAllocationServiceServer 

func RegisterAllocationServiceServer(s grpc.ServiceRegistrar, srv AllocationServiceServer)

Types

type AllocationRequest 

type AllocationRequest struct {

	// The k8s namespace that is hosting the targeted fleet of gameservers to be allocated
	Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// If specified, multi-cluster policies are applied. Otherwise, allocation will happen locally.
	MultiClusterSetting *MultiClusterSetting `protobuf:"bytes,2,opt,name=multiClusterSetting,proto3" json:"multiClusterSetting,omitempty"`
	// Deprecated: Please use gameServerSelectors instead. This field is ignored if the
	// gameServerSelectors field is set
	// The required allocation. Defaults to all GameServers.
	//
	// Deprecated: Do not use.
	RequiredGameServerSelector *GameServerSelector `protobuf:"bytes,3,opt,name=requiredGameServerSelector,proto3" json:"requiredGameServerSelector,omitempty"`
	// Deprecated: Please use gameServerSelectors instead. This field is ignored if the
	// gameServerSelectors field is set
	// The ordered list of preferred allocations out of the `required` set.
	// If the first selector is not matched, the selection attempts the second selector, and so on.
	//
	// Deprecated: Do not use.
	PreferredGameServerSelectors []*GameServerSelector `protobuf:"bytes,4,rep,name=preferredGameServerSelectors,proto3" json:"preferredGameServerSelectors,omitempty"`
	// Scheduling strategy. Defaults to "Packed".
	Scheduling AllocationRequest_SchedulingStrategy `` /* 127-byte string literal not displayed */
	// Deprecated: Please use metadata instead. This field is ignored if the
	// metadata field is set
	MetaPatch *MetaPatch `protobuf:"bytes,6,opt,name=metaPatch,proto3" json:"metaPatch,omitempty"`
	// Metadata is optional custom metadata that is added to the game server at
	// allocation. You can use this to tell the server necessary session data
	Metadata *MetaPatch `protobuf:"bytes,7,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Ordered list of GameServer label selectors.
	// If the first selector is not matched, the selection attempts the second selector, and so on.
	// This is useful for things like smoke testing of new game servers.
	// Note: This field can only be set if neither Required or Preferred is set.
	GameServerSelectors []*GameServerSelector `protobuf:"bytes,8,rep,name=gameServerSelectors,proto3" json:"gameServerSelectors,omitempty"`
	// [Stage: Beta]
	// [FeatureFlag:CountsAndLists]
	// `Priorities` configuration alters the order in which `GameServers` are searched for matches to the configured `selectors`.
	//
	// Priority of sorting is in descending importance. I.e. The position 0 `priority` entry is checked first.
	//
	// For `Packed` strategy sorting, this priority list will be the tie-breaker within the least utilised infrastructure, to ensure optimal
	// infrastructure usage while also allowing some custom prioritisation of `GameServers`.
	//
	// For `Distributed` strategy sorting, the entire selection of `GameServers` will be sorted by this priority list to provide the
	// order that `GameServers` will be allocated by.
	Priorities []*Priority `protobuf:"bytes,9,rep,name=priorities,proto3" json:"priorities,omitempty"`
	// [Stage: Beta]
	// [FeatureFlag:CountsAndLists]
	// Counters and Lists provide a set of actions to perform
	// on Counters and Lists during allocation.
	Counters map[string]*CounterAction `` /* 158-byte string literal not displayed */
	Lists    map[string]*ListAction    `` /* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*AllocationRequest) Descriptor deprecated 

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

Deprecated: Use AllocationRequest.ProtoReflect.Descriptor instead.

func (*AllocationRequest) GetCounters added in v1.36.0 

func (x *AllocationRequest) GetCounters() map[string]*CounterAction

func (*AllocationRequest) GetGameServerSelectors added in v1.17.0 

func (x *AllocationRequest) GetGameServerSelectors() []*GameServerSelector

func (*AllocationRequest) GetLists added in v1.36.0 

func (x *AllocationRequest) GetLists() map[string]*ListAction

func (*AllocationRequest) GetMetaPatch 

func (x *AllocationRequest) GetMetaPatch() *MetaPatch

func (*AllocationRequest) GetMetadata added in v1.15.0 

func (x *AllocationRequest) GetMetadata() *MetaPatch

func (*AllocationRequest) GetMultiClusterSetting 

func (x *AllocationRequest) GetMultiClusterSetting() *MultiClusterSetting

func (*AllocationRequest) GetNamespace 

func (x *AllocationRequest) GetNamespace() string

func (*AllocationRequest) GetPreferredGameServerSelectors deprecated 

func (x *AllocationRequest) GetPreferredGameServerSelectors() []*GameServerSelector

Deprecated: Do not use.

func (*AllocationRequest) GetPriorities added in v1.32.0 

func (x *AllocationRequest) GetPriorities() []*Priority

func (*AllocationRequest) GetRequiredGameServerSelector deprecated 

func (x *AllocationRequest) GetRequiredGameServerSelector() *GameServerSelector

Deprecated: Do not use.

func (*AllocationRequest) GetScheduling 

func (x *AllocationRequest) GetScheduling() AllocationRequest_SchedulingStrategy

func (*AllocationRequest) ProtoMessage 

func (*AllocationRequest) ProtoMessage()

func (*AllocationRequest) ProtoReflect added in v1.29.0 

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

func (*AllocationRequest) Reset 

func (x *AllocationRequest) Reset()

func (*AllocationRequest) String 

func (x *AllocationRequest) String() string

type AllocationRequest_SchedulingStrategy 

type AllocationRequest_SchedulingStrategy int32
const (
	AllocationRequest_Packed      AllocationRequest_SchedulingStrategy = 0
	AllocationRequest_Distributed AllocationRequest_SchedulingStrategy = 1
)

func (AllocationRequest_SchedulingStrategy) Descriptor added in v1.29.0 

func (AllocationRequest_SchedulingStrategy) Descriptor() protoreflect.EnumDescriptor

func (AllocationRequest_SchedulingStrategy) Enum added in v1.29.0 

func (x AllocationRequest_SchedulingStrategy) Enum() *AllocationRequest_SchedulingStrategy

func (AllocationRequest_SchedulingStrategy) EnumDescriptor deprecated 

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

Deprecated: Use AllocationRequest_SchedulingStrategy.Descriptor instead.

func (AllocationRequest_SchedulingStrategy) Number added in v1.29.0 

func (x AllocationRequest_SchedulingStrategy) Number() protoreflect.EnumNumber

func (AllocationRequest_SchedulingStrategy) String 

func (x AllocationRequest_SchedulingStrategy) String() string

func (AllocationRequest_SchedulingStrategy) Type added in v1.29.0 

func (AllocationRequest_SchedulingStrategy) Type() protoreflect.EnumType

type AllocationResponse 

type AllocationResponse struct {
	GameServerName string                                     `protobuf:"bytes,2,opt,name=gameServerName,proto3" json:"gameServerName,omitempty"`
	Ports          []*AllocationResponse_GameServerStatusPort `protobuf:"bytes,3,rep,name=ports,proto3" json:"ports,omitempty"`
	// Primary address at which game server can be reached
	Address string `protobuf:"bytes,4,opt,name=address,proto3" json:"address,omitempty"`
	// All addresses at which game server can be reached; copy of Node.Status.addresses
	Addresses []*AllocationResponse_GameServerStatusAddress `protobuf:"bytes,8,rep,name=addresses,proto3" json:"addresses,omitempty"`
	NodeName  string                                        `protobuf:"bytes,5,opt,name=nodeName,proto3" json:"nodeName,omitempty"`
	Source    string                                        `protobuf:"bytes,6,opt,name=source,proto3" json:"source,omitempty"`
	Metadata  *AllocationResponse_GameServerMetadata        `protobuf:"bytes,7,opt,name=metadata,proto3,oneof" json:"metadata,omitempty"`
	// (Beta, CountsAndLists feature flag) Status of Counters and Lists on allocation.
	Counters map[string]*AllocationResponse_CounterStatus `` /* 157-byte string literal not displayed */
	Lists    map[string]*AllocationResponse_ListStatus    `` /* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*AllocationResponse) Descriptor deprecated 

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

Deprecated: Use AllocationResponse.ProtoReflect.Descriptor instead.

func (*AllocationResponse) GetAddress 

func (x *AllocationResponse) GetAddress() string

func (*AllocationResponse) GetAddresses added in v1.34.0 

func (x *AllocationResponse) GetAddresses() []*AllocationResponse_GameServerStatusAddress

func (*AllocationResponse) GetCounters added in v1.39.0 

func (x *AllocationResponse) GetCounters() map[string]*AllocationResponse_CounterStatus

func (*AllocationResponse) GetGameServerName 

func (x *AllocationResponse) GetGameServerName() string

func (*AllocationResponse) GetLists added in v1.39.0 

func (x *AllocationResponse) GetLists() map[string]*AllocationResponse_ListStatus

func (*AllocationResponse) GetMetadata added in v1.33.0 

func (x *AllocationResponse) GetMetadata() *AllocationResponse_GameServerMetadata

func (*AllocationResponse) GetNodeName 

func (x *AllocationResponse) GetNodeName() string

func (*AllocationResponse) GetPorts 

func (x *AllocationResponse) GetPorts() []*AllocationResponse_GameServerStatusPort

func (*AllocationResponse) GetSource added in v1.29.0 

func (x *AllocationResponse) GetSource() string

func (*AllocationResponse) ProtoMessage 

func (*AllocationResponse) ProtoMessage()

func (*AllocationResponse) ProtoReflect added in v1.29.0 

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

func (*AllocationResponse) Reset 

func (x *AllocationResponse) Reset()

func (*AllocationResponse) String 

func (x *AllocationResponse) String() string

type AllocationResponse_CounterStatus added in v1.39.0 

type AllocationResponse_CounterStatus struct {
	Count    *wrapperspb.Int64Value `protobuf:"bytes,1,opt,name=count,proto3" json:"count,omitempty"`
	Capacity *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=capacity,proto3" json:"capacity,omitempty"`
	// contains filtered or unexported fields
}

func (*AllocationResponse_CounterStatus) Descriptor deprecated added in v1.39.0 

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

Deprecated: Use AllocationResponse_CounterStatus.ProtoReflect.Descriptor instead.

func (*AllocationResponse_CounterStatus) GetCapacity added in v1.39.0 

func (x *AllocationResponse_CounterStatus) GetCapacity() *wrapperspb.Int64Value

func (*AllocationResponse_CounterStatus) GetCount added in v1.39.0 

func (x *AllocationResponse_CounterStatus) GetCount() *wrapperspb.Int64Value

func (*AllocationResponse_CounterStatus) ProtoMessage added in v1.39.0 

func (*AllocationResponse_CounterStatus) ProtoMessage()

func (*AllocationResponse_CounterStatus) ProtoReflect added in v1.39.0 

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

func (*AllocationResponse_CounterStatus) Reset added in v1.39.0 

func (x *AllocationResponse_CounterStatus) Reset()

func (*AllocationResponse_CounterStatus) String added in v1.39.0 

func (x *AllocationResponse_CounterStatus) String() string

type AllocationResponse_GameServerMetadata added in v1.33.0 

type AllocationResponse_GameServerMetadata struct {
	Labels      map[string]string `` /* 153-byte string literal not displayed */
	Annotations map[string]string `` /* 163-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*AllocationResponse_GameServerMetadata) Descriptor deprecated added in v1.33.0 

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

Deprecated: Use AllocationResponse_GameServerMetadata.ProtoReflect.Descriptor instead.

func (*AllocationResponse_GameServerMetadata) GetAnnotations added in v1.33.0 

func (x *AllocationResponse_GameServerMetadata) GetAnnotations() map[string]string

func (*AllocationResponse_GameServerMetadata) GetLabels added in v1.33.0 

func (x *AllocationResponse_GameServerMetadata) GetLabels() map[string]string

func (*AllocationResponse_GameServerMetadata) ProtoMessage added in v1.33.0 

func (*AllocationResponse_GameServerMetadata) ProtoMessage()

func (*AllocationResponse_GameServerMetadata) ProtoReflect added in v1.33.0 

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

func (*AllocationResponse_GameServerMetadata) Reset added in v1.33.0 

func (x *AllocationResponse_GameServerMetadata) Reset()

func (*AllocationResponse_GameServerMetadata) String added in v1.33.0 

func (x *AllocationResponse_GameServerMetadata) String() string

type AllocationResponse_GameServerStatusAddress added in v1.34.0 

type AllocationResponse_GameServerStatusAddress struct {
	Type    string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

A single address; identical to corev1.NodeAddress

func (*AllocationResponse_GameServerStatusAddress) Descriptor deprecated added in v1.34.0 

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

Deprecated: Use AllocationResponse_GameServerStatusAddress.ProtoReflect.Descriptor instead.

func (*AllocationResponse_GameServerStatusAddress) GetAddress added in v1.34.0 

func (x *AllocationResponse_GameServerStatusAddress) GetAddress() string

func (*AllocationResponse_GameServerStatusAddress) GetType added in v1.34.0 

func (x *AllocationResponse_GameServerStatusAddress) GetType() string

func (*AllocationResponse_GameServerStatusAddress) ProtoMessage added in v1.34.0 

func (*AllocationResponse_GameServerStatusAddress) ProtoMessage()

func (*AllocationResponse_GameServerStatusAddress) ProtoReflect added in v1.34.0 

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

func (*AllocationResponse_GameServerStatusAddress) Reset added in v1.34.0 

func (x *AllocationResponse_GameServerStatusAddress) Reset()

func (*AllocationResponse_GameServerStatusAddress) String added in v1.34.0 

func (x *AllocationResponse_GameServerStatusAddress) String() string

type AllocationResponse_GameServerStatusPort 

type AllocationResponse_GameServerStatusPort struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Port int32  `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
	// contains filtered or unexported fields
}

The gameserver port info that is allocated.

func (*AllocationResponse_GameServerStatusPort) Descriptor deprecated 

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

Deprecated: Use AllocationResponse_GameServerStatusPort.ProtoReflect.Descriptor instead.

func (*AllocationResponse_GameServerStatusPort) GetName 

func (x *AllocationResponse_GameServerStatusPort) GetName() string

func (*AllocationResponse_GameServerStatusPort) GetPort 

func (x *AllocationResponse_GameServerStatusPort) GetPort() int32

func (*AllocationResponse_GameServerStatusPort) ProtoMessage 

func (*AllocationResponse_GameServerStatusPort) ProtoMessage()

func (*AllocationResponse_GameServerStatusPort) ProtoReflect added in v1.29.0 

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

func (*AllocationResponse_GameServerStatusPort) Reset 

func (x *AllocationResponse_GameServerStatusPort) Reset()

func (*AllocationResponse_GameServerStatusPort) String 

func (x *AllocationResponse_GameServerStatusPort) String() string

type AllocationResponse_ListStatus added in v1.39.0 

type AllocationResponse_ListStatus struct {
	Values   []string               `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	Capacity *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=capacity,proto3" json:"capacity,omitempty"`
	// contains filtered or unexported fields
}

func (*AllocationResponse_ListStatus) Descriptor deprecated added in v1.39.0 

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

Deprecated: Use AllocationResponse_ListStatus.ProtoReflect.Descriptor instead.

func (*AllocationResponse_ListStatus) GetCapacity added in v1.39.0 

func (x *AllocationResponse_ListStatus) GetCapacity() *wrapperspb.Int64Value

func (*AllocationResponse_ListStatus) GetValues added in v1.39.0 

func (x *AllocationResponse_ListStatus) GetValues() []string

func (*AllocationResponse_ListStatus) ProtoMessage added in v1.39.0 

func (*AllocationResponse_ListStatus) ProtoMessage()

func (*AllocationResponse_ListStatus) ProtoReflect added in v1.39.0 

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

func (*AllocationResponse_ListStatus) Reset added in v1.39.0 

func (x *AllocationResponse_ListStatus) Reset()

func (*AllocationResponse_ListStatus) String added in v1.39.0 

func (x *AllocationResponse_ListStatus) String() string

type AllocationServiceClient 

type AllocationServiceClient interface {
	Allocate(ctx context.Context, in *AllocationRequest, opts ...grpc.CallOption) (*AllocationResponse, error)
}

AllocationServiceClient is the client API for AllocationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAllocationServiceClient 

func NewAllocationServiceClient(cc grpc.ClientConnInterface) AllocationServiceClient

type AllocationServiceServer 

type AllocationServiceServer interface {
	Allocate(context.Context, *AllocationRequest) (*AllocationResponse, error)
}

AllocationServiceServer is the server API for AllocationService service. All implementations should embed UnimplementedAllocationServiceServer for forward compatibility

type CounterAction added in v1.36.0 

type CounterAction struct {
	Action   *wrapperspb.StringValue `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
	Amount   *wrapperspb.Int64Value  `protobuf:"bytes,2,opt,name=amount,proto3" json:"amount,omitempty"`
	Capacity *wrapperspb.Int64Value  `protobuf:"bytes,3,opt,name=capacity,proto3" json:"capacity,omitempty"`
	// contains filtered or unexported fields
}

CounterAction is an optional action that can be performed on a Counter at allocation. Action: "Increment" or "Decrement" the Counter's Count (optional). Must also define the Amount. Amount: The amount to increment or decrement the Count (optional). Must be a positive integer. Capacity: Update the maximum capacity of the Counter to this number (optional). Min 0, Max int64.

func (*CounterAction) Descriptor deprecated added in v1.36.0 

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

Deprecated: Use CounterAction.ProtoReflect.Descriptor instead.

func (*CounterAction) GetAction added in v1.36.0 

func (x *CounterAction) GetAction() *wrapperspb.StringValue

func (*CounterAction) GetAmount added in v1.36.0 

func (x *CounterAction) GetAmount() *wrapperspb.Int64Value

func (*CounterAction) GetCapacity added in v1.36.0 

func (x *CounterAction) GetCapacity() *wrapperspb.Int64Value

func (*CounterAction) ProtoMessage added in v1.36.0 

func (*CounterAction) ProtoMessage()

func (*CounterAction) ProtoReflect added in v1.36.0 

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

func (*CounterAction) Reset added in v1.36.0 

func (x *CounterAction) Reset()

func (*CounterAction) String added in v1.36.0 

func (x *CounterAction) String() string

type CounterSelector added in v1.32.0 

type CounterSelector struct {
	MinCount     int64 `protobuf:"varint,1,opt,name=minCount,proto3" json:"minCount,omitempty"`
	MaxCount     int64 `protobuf:"varint,2,opt,name=maxCount,proto3" json:"maxCount,omitempty"`
	MinAvailable int64 `protobuf:"varint,3,opt,name=minAvailable,proto3" json:"minAvailable,omitempty"`
	MaxAvailable int64 `protobuf:"varint,4,opt,name=maxAvailable,proto3" json:"maxAvailable,omitempty"`
	// contains filtered or unexported fields
}

CounterSelector is the filter options for a GameServer based on the count and/or available capacity. 0 for MaxCount or MaxAvailable means unlimited maximum. Default for all fields: 0

func (*CounterSelector) Descriptor deprecated added in v1.32.0 

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

Deprecated: Use CounterSelector.ProtoReflect.Descriptor instead.

func (*CounterSelector) GetMaxAvailable added in v1.32.0 

func (x *CounterSelector) GetMaxAvailable() int64

func (*CounterSelector) GetMaxCount added in v1.32.0 

func (x *CounterSelector) GetMaxCount() int64

func (*CounterSelector) GetMinAvailable added in v1.32.0 

func (x *CounterSelector) GetMinAvailable() int64

func (*CounterSelector) GetMinCount added in v1.32.0 

func (x *CounterSelector) GetMinCount() int64

func (*CounterSelector) ProtoMessage added in v1.32.0 

func (*CounterSelector) ProtoMessage()

func (*CounterSelector) ProtoReflect added in v1.32.0 

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

func (*CounterSelector) Reset added in v1.32.0 

func (x *CounterSelector) Reset()

func (*CounterSelector) String added in v1.32.0 

func (x *CounterSelector) String() string

type GameServerSelector added in v1.17.0 

type GameServerSelector struct {

	// Labels to match.
	MatchLabels     map[string]string                  `` /* 163-byte string literal not displayed */
	GameServerState GameServerSelector_GameServerState `` /* 135-byte string literal not displayed */
	Players         *PlayerSelector                    `protobuf:"bytes,3,opt,name=players,proto3" json:"players,omitempty"`
	Counters        map[string]*CounterSelector        `` /* 157-byte string literal not displayed */
	Lists           map[string]*ListSelector           `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

GameServerSelector used for finding a GameServer with matching filters.

func (*GameServerSelector) Descriptor deprecated added in v1.17.0 

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

Deprecated: Use GameServerSelector.ProtoReflect.Descriptor instead.

func (*GameServerSelector) GetCounters added in v1.32.0 

func (x *GameServerSelector) GetCounters() map[string]*CounterSelector

func (*GameServerSelector) GetGameServerState added in v1.17.0 

func (x *GameServerSelector) GetGameServerState() GameServerSelector_GameServerState

func (*GameServerSelector) GetLists added in v1.32.0 

func (x *GameServerSelector) GetLists() map[string]*ListSelector

func (*GameServerSelector) GetMatchLabels added in v1.17.0 

func (x *GameServerSelector) GetMatchLabels() map[string]string

func (*GameServerSelector) GetPlayers added in v1.17.0 

func (x *GameServerSelector) GetPlayers() *PlayerSelector

func (*GameServerSelector) ProtoMessage added in v1.17.0 

func (*GameServerSelector) ProtoMessage()

func (*GameServerSelector) ProtoReflect added in v1.29.0 

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

func (*GameServerSelector) Reset added in v1.17.0 

func (x *GameServerSelector) Reset()

func (*GameServerSelector) String added in v1.17.0 

func (x *GameServerSelector) String() string

type GameServerSelector_GameServerState added in v1.17.0 

type GameServerSelector_GameServerState int32
const (
	GameServerSelector_READY     GameServerSelector_GameServerState = 0
	GameServerSelector_ALLOCATED GameServerSelector_GameServerState = 1
)

func (GameServerSelector_GameServerState) Descriptor added in v1.29.0 

func (GameServerSelector_GameServerState) Descriptor() protoreflect.EnumDescriptor

func (GameServerSelector_GameServerState) Enum added in v1.29.0 

func (x GameServerSelector_GameServerState) Enum() *GameServerSelector_GameServerState

func (GameServerSelector_GameServerState) EnumDescriptor deprecated added in v1.17.0 

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

Deprecated: Use GameServerSelector_GameServerState.Descriptor instead.

func (GameServerSelector_GameServerState) Number added in v1.29.0 

func (x GameServerSelector_GameServerState) Number() protoreflect.EnumNumber

func (GameServerSelector_GameServerState) String added in v1.17.0 

func (x GameServerSelector_GameServerState) String() string

func (GameServerSelector_GameServerState) Type added in v1.29.0 

func (GameServerSelector_GameServerState) Type() protoreflect.EnumType

type LabelSelector 

type LabelSelector struct {

	// Labels to match.
	MatchLabels map[string]string `` /* 163-byte string literal not displayed */
	// contains filtered or unexported fields
}

LabelSelector used for finding a GameServer with matching labels.

func (*LabelSelector) Descriptor deprecated 

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

Deprecated: Use LabelSelector.ProtoReflect.Descriptor instead.

func (*LabelSelector) GetMatchLabels 

func (x *LabelSelector) GetMatchLabels() map[string]string

func (*LabelSelector) ProtoMessage 

func (*LabelSelector) ProtoMessage()

func (*LabelSelector) ProtoReflect added in v1.29.0 

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

func (*LabelSelector) Reset 

func (x *LabelSelector) Reset()

func (*LabelSelector) String 

func (x *LabelSelector) String() string

type ListAction added in v1.36.0 

type ListAction struct {
	AddValues    []string               `protobuf:"bytes,1,rep,name=addValues,proto3" json:"addValues,omitempty"`
	Capacity     *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=capacity,proto3" json:"capacity,omitempty"`
	DeleteValues []string               `protobuf:"bytes,3,rep,name=deleteValues,proto3" json:"deleteValues,omitempty"`
	// contains filtered or unexported fields
}

ListAction is an optional action that can be performed on a List at allocation. AddValues: Append values to a List's Values array (optional). Any duplicate values will be ignored. Capacity: Update the maximum capacity of the Counter to this number (optional). Min 0, Max 1000. DeleteValues: Remove values from a List's Values array (optional). Any nonexistant values will be ignored.

func (*ListAction) Descriptor deprecated added in v1.36.0 

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

Deprecated: Use ListAction.ProtoReflect.Descriptor instead.

func (*ListAction) GetAddValues added in v1.36.0 

func (x *ListAction) GetAddValues() []string

func (*ListAction) GetCapacity added in v1.36.0 

func (x *ListAction) GetCapacity() *wrapperspb.Int64Value

func (*ListAction) GetDeleteValues added in v1.46.0 

func (x *ListAction) GetDeleteValues() []string

func (*ListAction) ProtoMessage added in v1.36.0 

func (*ListAction) ProtoMessage()

func (*ListAction) ProtoReflect added in v1.36.0 

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

func (*ListAction) Reset added in v1.36.0 

func (x *ListAction) Reset()

func (*ListAction) String added in v1.36.0 

func (x *ListAction) String() string

type ListSelector added in v1.32.0 

type ListSelector struct {
	ContainsValue string `protobuf:"bytes,1,opt,name=containsValue,proto3" json:"containsValue,omitempty"`
	MinAvailable  int64  `protobuf:"varint,2,opt,name=minAvailable,proto3" json:"minAvailable,omitempty"`
	MaxAvailable  int64  `protobuf:"varint,3,opt,name=maxAvailable,proto3" json:"maxAvailable,omitempty"`
	// contains filtered or unexported fields
}

ListSelector is the filter options for a GameServer based on List available capacity and/or the existence of a value in a List. 0 for MaxAvailable means unlimited maximum. Default for integer fields: 0 "" for ContainsValue means ignore field. Default for string field: ""

func (*ListSelector) Descriptor deprecated added in v1.32.0 

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

Deprecated: Use ListSelector.ProtoReflect.Descriptor instead.

func (*ListSelector) GetContainsValue added in v1.32.0 

func (x *ListSelector) GetContainsValue() string

func (*ListSelector) GetMaxAvailable added in v1.32.0 

func (x *ListSelector) GetMaxAvailable() int64

func (*ListSelector) GetMinAvailable added in v1.32.0 

func (x *ListSelector) GetMinAvailable() int64

func (*ListSelector) ProtoMessage added in v1.32.0 

func (*ListSelector) ProtoMessage()

func (*ListSelector) ProtoReflect added in v1.32.0 

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

func (*ListSelector) Reset added in v1.32.0 

func (x *ListSelector) Reset()

func (*ListSelector) String added in v1.32.0 

func (x *ListSelector) String() string

type MetaPatch 

type MetaPatch struct {
	Labels      map[string]string `` /* 153-byte string literal not displayed */
	Annotations map[string]string `` /* 163-byte string literal not displayed */
	// contains filtered or unexported fields
}

MetaPatch is the metadata used to patch the GameServer metadata on allocation

func (*MetaPatch) Descriptor deprecated 

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

Deprecated: Use MetaPatch.ProtoReflect.Descriptor instead.

func (*MetaPatch) GetAnnotations 

func (x *MetaPatch) GetAnnotations() map[string]string

func (*MetaPatch) GetLabels 

func (x *MetaPatch) GetLabels() map[string]string

func (*MetaPatch) ProtoMessage 

func (*MetaPatch) ProtoMessage()

func (*MetaPatch) ProtoReflect added in v1.29.0 

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

func (*MetaPatch) Reset 

func (x *MetaPatch) Reset()

func (*MetaPatch) String 

func (x *MetaPatch) String() string

type MultiClusterSetting 

type MultiClusterSetting struct {

	// If set to true, multi-cluster allocation is enabled.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Selects multi-cluster allocation policies to apply. If not specified, all multi-cluster allocation policies are to be applied.
	PolicySelector *LabelSelector `protobuf:"bytes,2,opt,name=policySelector,proto3" json:"policySelector,omitempty"`
	// contains filtered or unexported fields
}

Specifies settings for multi-cluster allocation.

func (*MultiClusterSetting) Descriptor deprecated 

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

Deprecated: Use MultiClusterSetting.ProtoReflect.Descriptor instead.

func (*MultiClusterSetting) GetEnabled 

func (x *MultiClusterSetting) GetEnabled() bool

func (*MultiClusterSetting) GetPolicySelector 

func (x *MultiClusterSetting) GetPolicySelector() *LabelSelector

func (*MultiClusterSetting) ProtoMessage 

func (*MultiClusterSetting) ProtoMessage()

func (*MultiClusterSetting) ProtoReflect added in v1.29.0 

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

func (*MultiClusterSetting) Reset 

func (x *MultiClusterSetting) Reset()

func (*MultiClusterSetting) String 

func (x *MultiClusterSetting) String() string

type PlayerSelector added in v1.17.0 

type PlayerSelector struct {
	MinAvailable uint64 `protobuf:"varint,1,opt,name=minAvailable,proto3" json:"minAvailable,omitempty"`
	MaxAvailable uint64 `protobuf:"varint,2,opt,name=maxAvailable,proto3" json:"maxAvailable,omitempty"`
	// contains filtered or unexported fields
}

PlayerSelector is filter for player capacity values. minAvailable should always be less or equal to maxAvailable.

func (*PlayerSelector) Descriptor deprecated added in v1.17.0 

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

Deprecated: Use PlayerSelector.ProtoReflect.Descriptor instead.

func (*PlayerSelector) GetMaxAvailable added in v1.17.0 

func (x *PlayerSelector) GetMaxAvailable() uint64

func (*PlayerSelector) GetMinAvailable added in v1.17.0 

func (x *PlayerSelector) GetMinAvailable() uint64

func (*PlayerSelector) ProtoMessage added in v1.17.0 

func (*PlayerSelector) ProtoMessage()

func (*PlayerSelector) ProtoReflect added in v1.29.0 

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

func (*PlayerSelector) Reset added in v1.17.0 

func (x *PlayerSelector) Reset()

func (*PlayerSelector) String added in v1.17.0 

func (x *PlayerSelector) String() string

type Priority added in v1.32.0 

type Priority struct {
	Type  Priority_Type  `protobuf:"varint,1,opt,name=type,proto3,enum=allocation.Priority_Type" json:"type,omitempty"`
	Key   string         `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	Order Priority_Order `protobuf:"varint,3,opt,name=order,proto3,enum=allocation.Priority_Order" json:"order,omitempty"`
	// contains filtered or unexported fields
}

Priority is a sorting option for GameServers with Counters or Lists based on the Capacity. Type: Sort by a "Counter" or a "List". Key: The name of the Counter or List. If not found on the GameServer, has no impact. Order: Sort by "Ascending" or "Descending". "Descending" a bigger Capacity is preferred. "Ascending" would be smaller Capacity is preferred.

func (*Priority) Descriptor deprecated added in v1.32.0 

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

Deprecated: Use Priority.ProtoReflect.Descriptor instead.

func (*Priority) GetKey added in v1.32.0 

func (x *Priority) GetKey() string

func (*Priority) GetOrder added in v1.32.0 

func (x *Priority) GetOrder() Priority_Order

func (*Priority) GetType added in v1.34.0 

func (x *Priority) GetType() Priority_Type

func (*Priority) ProtoMessage added in v1.32.0 

func (*Priority) ProtoMessage()

func (*Priority) ProtoReflect added in v1.32.0 

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

func (*Priority) Reset added in v1.32.0 

func (x *Priority) Reset()

func (*Priority) String added in v1.32.0 

func (x *Priority) String() string

type Priority_Order added in v1.34.0 

type Priority_Order int32
const (
	Priority_Ascending  Priority_Order = 0
	Priority_Descending Priority_Order = 1
)

func (Priority_Order) Descriptor added in v1.34.0 

func (Priority_Order) Descriptor() protoreflect.EnumDescriptor

func (Priority_Order) Enum added in v1.34.0 

func (x Priority_Order) Enum() *Priority_Order

func (Priority_Order) EnumDescriptor deprecated added in v1.34.0 

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

Deprecated: Use Priority_Order.Descriptor instead.

func (Priority_Order) Number added in v1.34.0 

func (x Priority_Order) Number() protoreflect.EnumNumber

func (Priority_Order) String added in v1.34.0 

func (x Priority_Order) String() string

func (Priority_Order) Type added in v1.34.0 

func (Priority_Order) Type() protoreflect.EnumType

type Priority_Type added in v1.34.0 

type Priority_Type int32
const (
	Priority_Counter Priority_Type = 0
	Priority_List    Priority_Type = 1
)

func (Priority_Type) Descriptor added in v1.34.0 

func (Priority_Type) Descriptor() protoreflect.EnumDescriptor

func (Priority_Type) Enum added in v1.34.0 

func (x Priority_Type) Enum() *Priority_Type

func (Priority_Type) EnumDescriptor deprecated added in v1.34.0 

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

Deprecated: Use Priority_Type.Descriptor instead.

func (Priority_Type) Number added in v1.34.0 

func (x Priority_Type) Number() protoreflect.EnumNumber

func (Priority_Type) String added in v1.34.0 

func (x Priority_Type) String() string

func (Priority_Type) Type added in v1.34.0 

func (Priority_Type) Type() protoreflect.EnumType

type UnimplementedAllocationServiceServer added in v1.29.0 

type UnimplementedAllocationServiceServer struct {
}

UnimplementedAllocationServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedAllocationServiceServer) Allocate added in v1.29.0 

func (UnimplementedAllocationServiceServer) Allocate(context.Context, *AllocationRequest) (*AllocationResponse, error)

type UnsafeAllocationServiceServer added in v1.29.0 

type UnsafeAllocationServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeAllocationServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AllocationServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.