model

Documentation

Index

• type HoldRequest
• type HoldStatus
• type PatchAllocationRequest
• type ReserveRequest
• type ReserveResponse
• type UnexpectedResponseError
  • func (e *UnexpectedResponseError) Error() string

Types

type HoldRequest

type HoldRequest struct {
	// The duration of the server hold. Formatted as a duration string with a sequence of numbers and time units (e.g. 2m / 1h).
	// Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Holds are stored at a per-second granularity.
	Timeout string `json:"timeout"`
}

HoldRequest defines the model for the request to hold a server.

type HoldStatus

type HoldStatus struct {
	// The unix epoch when the hold will automatically expire, in seconds.
	ExpiresAt int64 `json:"expiresAt"`
	// Whether the server is currently held.
	Held bool `json:"held"`
}

HoldStatus defines the model for the status of server hold, returned from a successful hold request or status request.

type PatchAllocationRequest

type PatchAllocationRequest struct {
	// Ready is the ready state of the server.
	Ready bool `json:"ready"`
}

PatchAllocationRequest defines the model for the request to patch a server allocation.

type ReserveRequest

type ReserveRequest struct{}

ReserveRequest defines the model for the request to reserve a server.

type ReserveResponse

type ReserveResponse struct {
	// BuildConfigurationID is the build configuration this server is using
	BuildConfigurationID int64 `json:"buildConfigurationId"`
	// Creates is the time at which the reservation was made
	Created time.Time `json:"created"`
	// Fulfilled is the time at which the reservation was fulfilled
	Fulfilled time.Time `json:"fulfilled"`
	// GamePort is the port of the server on the requested machine
	GamePort int64 `json:"gamePort"`
	// Ipv4 address of the machine the server is running on
	Ipv4 *string `json:"ipv4,omitempty"`
	// Ipv6 address of the machine the server is running on
	Ipv6 *string `json:"ipv6,omitempty"`
	// Requested is the time at which the reservation was requested
	Requested time.Time `json:"requested"`
	// ReservationID is the UUID of the reservation generated by the service
	ReservationID string `json:"reservationId"`
}

ReserveResponse defines the model for a successful response to a reservation request.

type UnexpectedResponseError

type UnexpectedResponseError struct {
	RequestID    string
	StatusCode   int
	ResponseBody string
}

UnexpectedResponseError represents an unexpected response from the local proxy.

func (*UnexpectedResponseError) Error

func (e *UnexpectedResponseError) Error() string

Error returns the string representation of the error.