API reference

Deployment.V1Alpha1

CreateDeploymentMetadata

For internal use only

public class Improbable.SpatialOS.Deployment.V1Alpha1.CreateDeploymentMetadata
    : IMessage<CreateDeploymentMetadata>, IDeepCloneable<CreateDeploymentMetadata>, IEquatable<CreateDeploymentMetadata>, IMessage

Methods

Type	Name	Summary
Int32	CalculateSize()
CreateDeploymentMetadata	Clone()
Boolean	Equals(Object other)
Boolean	Equals(CreateDeploymentMetadata other)
Int32	GetHashCode()
void	MergeFrom(CreateDeploymentMetadata other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<CreateDeploymentMetadata>	Parser

CreateDeploymentRequest

public class Improbable.SpatialOS.Deployment.V1Alpha1.CreateDeploymentRequest
    : IMessage<CreateDeploymentRequest>, IDeepCloneable<CreateDeploymentRequest>, IEquatable<CreateDeploymentRequest>, IMessage

Properties

Type	Name	Summary
Deployment	Deployment	The deployment to start. You can only supply fields that are mutable at the point when you start the deployment. Non-empty read-only fields passed in will be ignored.

Methods

Type	Name	Summary
Int32	CalculateSize()
CreateDeploymentRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(CreateDeploymentRequest other)
Int32	GetHashCode()
void	MergeFrom(CreateDeploymentRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentFieldNumber	Field number for the “deployment” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<CreateDeploymentRequest>	Parser

Deployment

• A deployment of a game in the cloud.

public class Improbable.SpatialOS.Deployment.V1Alpha1.Deployment
    : IMessage<Deployment>, IDeepCloneable<Deployment>, IEquatable<Deployment>, IMessage

Properties

Type	Name	Summary
String	AssemblyId	Read-only once created. The assembly to use for the deployment.
String	ClusterCode	Read-only once created. The name of the cluster this deployment is in.
String	Id	A unique identifier for the deployment. Read-only.
LaunchConfig	LaunchConfig	Read-only once created. The configuration for starting the deployment.
String	Name	Read-only once created. The name of the deployment. It must conform to the regex: ^[a-z0-9_]{3,32}$
PlayerInfo	PlayerInfo	Read-only. Information about the players participating in the deployment. Only applicable to running deployments.
String	ProjectName	Read-only once created. The name of the project this deployment belongs to. It must conform to the regex: ^[a-z0-9_]{3,32}$
String	RegionCode	Read-only once created. The region that the deployment is running in. The supported regions are “EU” and “US” (and “AP” for specific users who have requested access). Leave blank if unknown.
String	StartingSnapshotId	Read-only once created. The starting snapshot for the deployment.
Timestamp	StartTime	Read-only. The time the deployment is started.
Status	Status	Read-only. Whether the deployment is running.
Timestamp	StopTime	Read-only. The time the deployment is stopped.
RepeatedField<String>	Tag	Tags associated with the deployment. Tags are set of strings you can use to identify deployments. A tag must be upper or lower case letters or numbers and 3-32 characters in length.
RepeatedField<WorkerCapacity>	WorkerConnectionCapacities	Mutable. Only applicable to running deployments. The capacities of the deployment, broken down by worker type. The default maximum capacity for any worker type is a very large number, usually the maximum value of int32 (0x7FFFFFFF). However, we can’t guarantee that this limit will always stay the same.
RepeatedField<WorkerRateLimit>	WorkerConnectionRateLimits	Mutable. Only applicable to running deployments. The rate limits of the deployment, broken down by worker type. If a worker type is absent or has the zero value, you can assume that worker type is not rate limited.
RepeatedField<WorkerFlag>	WorkerFlags	Supply in UpdateDeployment RPC, or in the LaunchConfig field when creating a deployment. The worker flags that the deployment exposes at runtime. Only applicable to running deployments.

Methods

Type	Name	Summary
Int32	CalculateSize()
Deployment	Clone()
Boolean	Equals(Object other)
Boolean	Equals(Deployment other)
Int32	GetHashCode()
void	MergeFrom(Deployment other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	AssemblyIdFieldNumber	Field number for the “assembly_id” field.
Int32	ClusterCodeFieldNumber	Field number for the “cluster_code” field.
Int32	IdFieldNumber	Field number for the “id” field.
Int32	LaunchConfigFieldNumber	Field number for the “launch_config” field.
Int32	NameFieldNumber	Field number for the “name” field.
Int32	PlayerInfoFieldNumber	Field number for the “player_info” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.
Int32	RegionCodeFieldNumber	Field number for the “region_code” field.
Int32	StartingSnapshotIdFieldNumber	Field number for the “starting_snapshot_id” field.
Int32	StartTimeFieldNumber	Field number for the “start_time” field.
Int32	StatusFieldNumber	Field number for the “status” field.
Int32	StopTimeFieldNumber	Field number for the “stop_time” field.
Int32	TagFieldNumber	Field number for the “tag” field.
Int32	WorkerFlagsFieldNumber	Field number for the “worker_flags” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<Deployment>	Parser

DeploymentReflection

Placeholder for reflection information generated from proto/improbable/spatialos/deployment/v1alpha1/deployment.proto

public static class Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentReflection

Static properties

Type	Name	Summary
FileDescriptor	Descriptor	File descriptor for proto/improbable/spatialos/deployment/v1alpha1/deployment.proto

DeploymentService

DeploymentService provides methods for managing deployments.

public static class Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentService

Static properties

Type	Name	Summary
ServiceDescriptor	Descriptor	Service descriptor

Static methods

Type	Name	Summary
ServerServiceDefinition	BindService(DeploymentServiceBase serviceImpl)	Creates service definition that can be registered with a server

DeploymentServiceClient

DeploymentService client wrapper, for convenient use.

public abstract class Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClient

Properties

Type	Name	Summary
OperationsClient	CreateDeploymentOperationsClient	The long-running operations client for CreateDeployment.
DeploymentServiceClient	GrpcClient	The underlying gRPC DeploymentService client.

Methods

Type	Name	Summary
Operation<Deployment, CreateDeploymentMetadata>	CreateDeployment(CreateDeploymentRequest request, CallSettings callSettings = null)
Task<Operation<Deployment, CreateDeploymentMetadata>>	CreateDeploymentAsync(CreateDeploymentRequest request, CallSettings callSettings = null)
GetDeploymentResponse	GetDeployment(GetDeploymentRequest request, CallSettings callSettings = null)
Task<GetDeploymentResponse>	GetDeploymentAsync(GetDeploymentRequest request, CallSettings callSettings = null)
Task<GetDeploymentResponse>	GetDeploymentAsync(GetDeploymentRequest request, CancellationToken cancellationToken)
PagedEnumerable<ListDeploymentsResponse, Deployment>	ListDeployments(ListDeploymentsRequest request, CallSettings callSettings = null)
PagedAsyncEnumerable<ListDeploymentsResponse, Deployment>	ListDeploymentsAsync(ListDeploymentsRequest request, CallSettings callSettings = null)
Operation<Deployment, CreateDeploymentMetadata>	PollOnceCreateDeployment(String operationName, CallSettings callSettings = null)	Poll an operation once, using an operationName from a previous invocation of CreateDeployment.
Task<Operation<Deployment, CreateDeploymentMetadata>>	PollOnceCreateDeploymentAsync(String operationName, CallSettings callSettings = null)	Asynchronously poll an operation once, using an operationName from a previous invocation of CreateDeploymentAsync.
StopDeploymentResponse	StopDeployment(StopDeploymentRequest request, CallSettings callSettings = null)
Task<StopDeploymentResponse>	StopDeploymentAsync(StopDeploymentRequest request, CallSettings callSettings = null)
Task<StopDeploymentResponse>	StopDeploymentAsync(StopDeploymentRequest request, CancellationToken cancellationToken)
UpdateDeploymentResponse	UpdateDeployment(UpdateDeploymentRequest request, CallSettings callSettings = null)
Task<UpdateDeploymentResponse>	UpdateDeploymentAsync(UpdateDeploymentRequest request, CallSettings callSettings = null)
Task<UpdateDeploymentResponse>	UpdateDeploymentAsync(UpdateDeploymentRequest request, CancellationToken cancellationToken)

Static properties

Type	Name	Summary
PlatformApiEndpoint	DefaultEndpoint	The default endpoint for the DeploymentService service, which is a host of “platform.api.improbable.io” and a port of 443.

Static methods

Type	Name	Summary
DeploymentServiceClient	Create(PlatformApiEndpoint endpoint = null, PlatformCredential credentials = null, DeploymentServiceSettings settings = null)	Synchronously creates a Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application auto-detected credentials where necessary. See the example for how to use custom credentials.
DeploymentServiceClient	Create(Channel channel, DeploymentServiceSettings settings = null)	Synchronously creates a Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application auto-detected credentials where necessary. See the example for how to use custom credentials.

DeploymentServiceClientImpl

DeploymentService client wrapper implementation, for convenient use.

public class Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClientImpl
    : DeploymentServiceClient

Properties

Type	Name	Summary
OperationsClient	CreateDeploymentOperationsClient	The long-running operations client for CreateDeployment.
DeploymentServiceClient	GrpcClient	The underlying gRPC DeploymentService client.

Methods

Type	Name	Summary
Operation<Deployment, CreateDeploymentMetadata>	CreateDeployment(CreateDeploymentRequest request, CallSettings callSettings = null)
Task<Operation<Deployment, CreateDeploymentMetadata>>	CreateDeploymentAsync(CreateDeploymentRequest request, CallSettings callSettings = null)
GetDeploymentResponse	GetDeployment(GetDeploymentRequest request, CallSettings callSettings = null)
Task<GetDeploymentResponse>	GetDeploymentAsync(GetDeploymentRequest request, CallSettings callSettings = null)
PagedEnumerable<ListDeploymentsResponse, Deployment>	ListDeployments(ListDeploymentsRequest request, CallSettings callSettings = null)
PagedAsyncEnumerable<ListDeploymentsResponse, Deployment>	ListDeploymentsAsync(ListDeploymentsRequest request, CallSettings callSettings = null)
StopDeploymentResponse	StopDeployment(StopDeploymentRequest request, CallSettings callSettings = null)
Task<StopDeploymentResponse>	StopDeploymentAsync(StopDeploymentRequest request, CallSettings callSettings = null)
UpdateDeploymentResponse	UpdateDeployment(UpdateDeploymentRequest request, CallSettings callSettings = null)
Task<UpdateDeploymentResponse>	UpdateDeploymentAsync(UpdateDeploymentRequest request, CallSettings callSettings = null)

DeploymentServiceSettings

Settings for a Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClient.

public class Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceSettings
    : ServiceSettingsBase

Properties

Type	Name	Summary
OperationsSettings	CreateDeploymentOperationsSettings	Long Running Operation settings for calls to DeploymentServiceClient.CreateDeployment.
CallSettings	CreateDeploymentSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to DeploymentServiceClient.CreateDeployment and DeploymentServiceClient.CreateDeploymentAsync.
CallSettings	GetDeploymentSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to DeploymentServiceClient.GetDeployment and DeploymentServiceClient.GetDeploymentAsync.
CallSettings	ListDeploymentsSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to DeploymentServiceClient.ListDeployments and DeploymentServiceClient.ListDeploymentsAsync.
CallSettings	StopDeploymentSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to DeploymentServiceClient.StopDeployment and DeploymentServiceClient.StopDeploymentAsync.
CallSettings	UpdateDeploymentSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to DeploymentServiceClient.UpdateDeployment and DeploymentServiceClient.UpdateDeploymentAsync.

Methods

Type	Name	Summary
DeploymentServiceSettings	Clone()	Creates a deep clone of this object, with all the same property values.

Static properties

Type	Name	Summary
Predicate<RpcException>	IdempotentRetryFilter	The filter specifying which RPC Grpc.Core.StatusCodes are eligible for retry for “Idempotent” Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClient RPC methods.
Predicate<RpcException>	NonIdempotentRetryFilter	The filter specifying which RPC Grpc.Core.StatusCodes are eligible for retry for “NonIdempotent” Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClient RPC methods.

Static methods

Type	Name	Summary
DeploymentServiceSettings	GetDefault()	Get a new instance of the default Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceSettings.
BackoffSettings	GetDefaultRetryBackoff()	“Default” retry backoff for Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClient RPC methods.
BackoffSettings	GetDefaultTimeoutBackoff()	“Default” timeout backoff for Improbable.SpatialOS.Deployment.V1Alpha1.DeploymentServiceClient RPC methods.

GetDeploymentRequest

public class Improbable.SpatialOS.Deployment.V1Alpha1.GetDeploymentRequest
    : IMessage<GetDeploymentRequest>, IDeepCloneable<GetDeploymentRequest>, IEquatable<GetDeploymentRequest>, IMessage

Properties

Type	Name	Summary
String	Id	A unique identifier for the deployment.
String	ProjectName	The deployment’s project. It must conform to the regex: ^[a-z0-9_]{3,32}$

Methods

Type	Name	Summary
Int32	CalculateSize()
GetDeploymentRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(GetDeploymentRequest other)
Int32	GetHashCode()
void	MergeFrom(GetDeploymentRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	IdFieldNumber	Field number for the “id” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<GetDeploymentRequest>	Parser

GetDeploymentResponse

public class Improbable.SpatialOS.Deployment.V1Alpha1.GetDeploymentResponse
    : IMessage<GetDeploymentResponse>, IDeepCloneable<GetDeploymentResponse>, IEquatable<GetDeploymentResponse>, IMessage

Properties

Type	Name	Summary
Deployment	Deployment

Methods

Type	Name	Summary
Int32	CalculateSize()
GetDeploymentResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(GetDeploymentResponse other)
Int32	GetHashCode()
void	MergeFrom(GetDeploymentResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentFieldNumber	Field number for the “deployment” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<GetDeploymentResponse>	Parser

LaunchConfig

public class Improbable.SpatialOS.Deployment.V1Alpha1.LaunchConfig
    : IMessage<LaunchConfig>, IDeepCloneable<LaunchConfig>, IEquatable<LaunchConfig>, IMessage

Properties

Type	Name	Summary
String	ConfigJson	The launch configuration for the deployment, supplied as JSON. For information about the launch configuration, see the SpatialOS documentation: https://docs.improbable.io/reference/latest/shared/project-layout/launch-config

Methods

Type	Name	Summary
Int32	CalculateSize()
LaunchConfig	Clone()
Boolean	Equals(Object other)
Boolean	Equals(LaunchConfig other)
Int32	GetHashCode()
void	MergeFrom(LaunchConfig other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	ConfigJsonFieldNumber	Field number for the “config_json” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<LaunchConfig>	Parser

ListDeploymentsRequest

public class Improbable.SpatialOS.Deployment.V1Alpha1.ListDeploymentsRequest
    : IMessage<ListDeploymentsRequest>, IPageRequest, IDeepCloneable<ListDeploymentsRequest>, IEquatable<ListDeploymentsRequest>, IMessage

Properties

Type	Name	Summary
String	DeploymentName	The name of the deployment. Leave it empty to list all deployments under the given project. If provided, it must conform to the regex: ^[a-z0-9_]{3,32}$
Int32	PageSize	The maximum number of deployments to return in the response. It must not be negative. If unset or 0, it defaults to 20.
String	PageToken	The token to identify the starting point of the request. An empty or invalid token defaults to listing from the start.
String	ProjectName	The project to list all deployments for. project_name must conform to the regex: ^[a-z0-9_]{3,32}$

Methods

Type	Name	Summary
Int32	CalculateSize()
ListDeploymentsRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ListDeploymentsRequest other)
Int32	GetHashCode()
void	MergeFrom(ListDeploymentsRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentNameFieldNumber	Field number for the “deployment_name” field.
Int32	PageSizeFieldNumber	Field number for the “page_size” field.
Int32	PageTokenFieldNumber	Field number for the “page_token” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ListDeploymentsRequest>	Parser

ListDeploymentsResponse

public class Improbable.SpatialOS.Deployment.V1Alpha1.ListDeploymentsResponse
    : IMessage<ListDeploymentsResponse>, IPageResponse<Deployment>, IEnumerable<Deployment>, IEnumerable, IDeepCloneable<ListDeploymentsResponse>, IEquatable<ListDeploymentsResponse>, IMessage

Properties

Type	Name	Summary
RepeatedField<Deployment>	Deployments
String	NextPageToken	A token you can supply to the ListDeployments RPC to retrieve the next page of paginated results.

Methods

Type	Name	Summary
Int32	CalculateSize()
ListDeploymentsResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ListDeploymentsResponse other)
IEnumerator<Deployment>	GetEnumerator()	Returns an enumerator that iterates through the resources in this response.
Int32	GetHashCode()
void	MergeFrom(ListDeploymentsResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentsFieldNumber	Field number for the “deployments” field.
Int32	NextPageTokenFieldNumber	Field number for the “next_page_token” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ListDeploymentsResponse>	Parser

PlayerInfo

public class Improbable.SpatialOS.Deployment.V1Alpha1.PlayerInfo
    : IMessage<PlayerInfo>, IDeepCloneable<PlayerInfo>, IEquatable<PlayerInfo>, IMessage

Properties

Type	Name	Summary
Int64	ActivePlayers	The number of players in this deployment.
Int64	Capacity	The number of player this deployment can support.
Int64	QueueLength	The number of players queuing to enter this deployment. This is not implemented. A default value of zero is always returned.

Methods

Type	Name	Summary
Int32	CalculateSize()
PlayerInfo	Clone()
Boolean	Equals(Object other)
Boolean	Equals(PlayerInfo other)
Int32	GetHashCode()
void	MergeFrom(PlayerInfo other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	ActivePlayersFieldNumber	Field number for the “active_players” field.
Int32	CapacityFieldNumber	Field number for the “capacity” field.
Int32	QueueLengthFieldNumber	Field number for the “queue_length” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<PlayerInfo>	Parser

StopDeploymentRequest

public class Improbable.SpatialOS.Deployment.V1Alpha1.StopDeploymentRequest
    : IMessage<StopDeploymentRequest>, IDeepCloneable<StopDeploymentRequest>, IEquatable<StopDeploymentRequest>, IMessage

Properties

Type	Name	Summary
String	Id	The deployment to stop.
String	ProjectName	The deployment’s project. It must conform to the regex: ^[a-z0-9_]{3,32}$

Methods

Type	Name	Summary
Int32	CalculateSize()
StopDeploymentRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(StopDeploymentRequest other)
Int32	GetHashCode()
void	MergeFrom(StopDeploymentRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	IdFieldNumber	Field number for the “id” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<StopDeploymentRequest>	Parser

StopDeploymentResponse

public class Improbable.SpatialOS.Deployment.V1Alpha1.StopDeploymentResponse
    : IMessage<StopDeploymentResponse>, IDeepCloneable<StopDeploymentResponse>, IEquatable<StopDeploymentResponse>, IMessage

Methods

Type	Name	Summary
Int32	CalculateSize()
StopDeploymentResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(StopDeploymentResponse other)
Int32	GetHashCode()
void	MergeFrom(StopDeploymentResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<StopDeploymentResponse>	Parser

UpdateDeploymentRequest

public class Improbable.SpatialOS.Deployment.V1Alpha1.UpdateDeploymentRequest
    : IMessage<UpdateDeploymentRequest>, IDeepCloneable<UpdateDeploymentRequest>, IEquatable<UpdateDeploymentRequest>, IMessage

Properties

Type	Name	Summary
Deployment	Deployment
FieldMask	UpdateMask	A mask which you can provide for partial updates of the resource. Only the fields specified in the mask are modified on the response. Further Documentation: https://github.com/google/protobuf/blob/master/src/google/protobuf/field_mask.proto

Methods

Type	Name	Summary
Int32	CalculateSize()
UpdateDeploymentRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(UpdateDeploymentRequest other)
Int32	GetHashCode()
void	MergeFrom(UpdateDeploymentRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentFieldNumber	Field number for the “deployment” field.
Int32	UpdateMaskFieldNumber	Field number for the “update_mask” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<UpdateDeploymentRequest>	Parser

UpdateDeploymentResponse

public class Improbable.SpatialOS.Deployment.V1Alpha1.UpdateDeploymentResponse
    : IMessage<UpdateDeploymentResponse>, IDeepCloneable<UpdateDeploymentResponse>, IEquatable<UpdateDeploymentResponse>, IMessage

Properties

Type	Name	Summary
Deployment	Deployment

Methods

Type	Name	Summary
Int32	CalculateSize()
UpdateDeploymentResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(UpdateDeploymentResponse other)
Int32	GetHashCode()
void	MergeFrom(UpdateDeploymentResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentFieldNumber	Field number for the “deployment” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<UpdateDeploymentResponse>	Parser

WorkerCapacity

public class Improbable.SpatialOS.Deployment.V1Alpha1.WorkerCapacity
    : IMessage<WorkerCapacity>, IDeepCloneable<WorkerCapacity>, IEquatable<WorkerCapacity>, IMessage

Properties

Type	Name	Summary
String	WorkerType	The type of worker that this capacity limit applies to.
Int32	MaxCapacity	Mutable. The maximum number of worker instances of the specified type that are allowed to connect to a SpatialOS deployment. Setting it to a lower number than the number of already connected workers does not drop their connections. It must not be a negative number.
Int32	RemainingCapacity	Read-only. The available capacity for connection. Note: it can go negative when you set max_capacity lower than the connection capacity already used.

WorkerRateLimit

public class Improbable.SpatialOS.Deployment.V1Alpha1.WorkerRateLimit
    : IMessage<WorkerRateLimit>, IDeepCloneable<WorkerRateLimit>, IEquatable<WorkerRateLimit>, IMessage

Properties

Type	Name	Summary
String	WorkerType	The type of worker that this rate limit applies to.
Duration	Duration	Mutable. The duration window to apply the rate limit in.
Int32	RequestsInDuration	Mutable. The maximum number of requests allowed during the specified duration window.

WorkerFlag

public class Improbable.SpatialOS.Deployment.V1Alpha1.WorkerFlag
    : IMessage<WorkerFlag>, IDeepCloneable<WorkerFlag>, IEquatable<WorkerFlag>, IMessage

Properties

Type	Name	Summary
String	Key	The key of the flag.
String	Value	The value of the flag.
String	WorkerType	The type of server worker that can see the flag.

Methods

Type	Name	Summary
Int32	CalculateSize()
WorkerFlag	Clone()
Boolean	Equals(Object other)
Boolean	Equals(WorkerFlag other)
Int32	GetHashCode()
void	MergeFrom(WorkerFlag other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	KeyFieldNumber	Field number for the “key” field.
Int32	ValueFieldNumber	Field number for the “value” field.
Int32	WorkerTypeFieldNumber	Field number for the “worker_type” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<WorkerFlag>	Parser

Platform.Common

NoCredentialInSecureConnectionException

This exception indicates that the user didn’t provide a user credential (required for a secure connection).

public class Improbable.SpatialOS.Platform.Common.NoCredentialInSecureConnectionException
    : Exception, _Exception, ISerializable

NoRefreshTokenFoundException

This exception indicates that the user didn’t provide a valid refresh token with AutoDetected mode.

public class Improbable.SpatialOS.Platform.Common.NoRefreshTokenFoundException
    : Exception, _Exception, ISerializable

PlatformApiChannel

The channel wrapping the endpoint of a SpatialOS Platform API and a SpatialOS credential.

public class Improbable.SpatialOS.Platform.Common.PlatformApiChannel
    : Channel

PlatformApiEndpoint

Settings specifying a service endpoint in the form of a host name and port. This class is immutable and thread-safe.

public class Improbable.SpatialOS.Platform.Common.PlatformApiEndpoint
    : IEquatable<PlatformApiEndpoint>

Properties

Type	Name	Summary
String	Host	The host name to connect to. Must not be null or empty.
Boolean	Insecure	Whether the connection is encrypted or not. For unencrypted connections no authentication data is sent.
Int32	Port	The port to connect to, in the range 1 to 65535 inclusive.

Methods

Type	Name	Summary
Boolean	Equals(PlatformApiEndpoint other)	Determines equality between this endpoint and ``.
Boolean	Equals(Object obj)	Determines equality between this endpoint and ``.
Int32	GetHashCode()	Returns a hash code for this object, consistent with Improbable.SpatialOS.Platform.Common.PlatformApiEndpoint.Equals(Improbable.SpatialOS.Platform.Common.PlatformApiEndpoint).
String	ToString()	Returns this endpoint’s data in the format “host:port”.
PlatformApiEndpoint	WithHost(String host)	Creates a new endpoint with the same port but the given host.
PlatformApiEndpoint	WithPort(Int32 port)	Creates a new endpoint with the same host but the given port.

PlatformCredential

This is the abstract base class for SpatialOS platform credentials. Clients should use a concrete credential provider such as Improbable.SpatialOS.Platform.Common.PlatformRefreshTokenCredential instead of trying to instantiate this class directly.

public abstract class Improbable.SpatialOS.Platform.Common.PlatformCredential
    : UserCredential, IConfigurableHttpClientInitializer, IHttpExecuteInterceptor, IHttpUnsuccessfulResponseHandler, ICredential, ITokenAccess

PlatformRefreshTokenCredential

This provides support to automatically acquire access tokens from SpatialOS refresh tokens.

public class Improbable.SpatialOS.Platform.Common.PlatformRefreshTokenCredential
    : PlatformCredential, IConfigurableHttpClientInitializer, IHttpExecuteInterceptor, IHttpUnsuccessfulResponseHandler, ICredential, ITokenAccess

Static properties

Type	Name	Summary
PlatformRefreshTokenCredential	AutoDetected	Gets an instance of the Improbable.SpatialOS.Platform.Common.PlatformRefreshTokenCredential class by retrieving the locally stored refresh token from a file. It tries to determine the path to the refresh token in the following order: 1. use the environment variable SPATIALOS_REFRESH_TOKEN_FILE 2. use the same well-known location SpatialOS CLI tool uses, e.g. $HOME/.improbable/oauth2/oauth2_refresh_token on a Mac; Note: invoking spatial init creates the refresh token file in the well-known location.

ServiceAccount.V1Alpha1

CreateServiceAccountRequest

A request to create a new service account.

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.CreateServiceAccountRequest
    : IMessage<CreateServiceAccountRequest>, IDeepCloneable<CreateServiceAccountRequest>, IEquatable<CreateServiceAccountRequest>, IMessage

Properties

Type	Name	Summary
Duration	Lifetime	The lifetime of the service account. If not specified, then the new service account will have a default lifetime of 30 days. This value cannot be larger than 90 days.
String	Name	The name of the service account.
RepeatedField<Permission>	Permissions	The service account’s scope.
String	ProjectName	The name of the project associated with the service account.

Methods

Type	Name	Summary
Int32	CalculateSize()
CreateServiceAccountRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(CreateServiceAccountRequest other)
Int32	GetHashCode()
void	MergeFrom(CreateServiceAccountRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	LifetimeFieldNumber	Field number for the “lifetime” field.
Int32	NameFieldNumber	Field number for the “name” field.
Int32	PermissionsFieldNumber	Field number for the “permissions” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<CreateServiceAccountRequest>	Parser

DeleteServiceAccountRequest

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.DeleteServiceAccountRequest
    : IMessage<DeleteServiceAccountRequest>, IDeepCloneable<DeleteServiceAccountRequest>, IEquatable<DeleteServiceAccountRequest>, IMessage

Properties

Type	Name	Summary
Int64	Id	ID of the service account to delete.

Methods

Type	Name	Summary
Int32	CalculateSize()
DeleteServiceAccountRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(DeleteServiceAccountRequest other)
Int32	GetHashCode()
void	MergeFrom(DeleteServiceAccountRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	IdFieldNumber	Field number for the “id” field.

Static Properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<DeleteServiceAccountRequest>	Parser

ListServiceAccountsRequest

A request used to list all the service accounts you have permission to view.

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.ListServiceAccountsRequest
    : IMessage<ListServiceAccountsRequest>, IPageRequest, IDeepCloneable<ListServiceAccountsRequest>, IEquatable<ListServiceAccountsRequest>, IMessage

Properties

Type	Name	Summary
Int32	PageSize	The maximum number of service accounts to return in the response. If unspecified this will be 20 results per page.
String	PageToken	The token to identify the starting point of the request. An empty or invalid token defaults to listing from the start.
String	ProjectName	The name of the project whose service accounts should be listed. You must have access to this project.

Methods

Type	Name	Summary
Int32	CalculateSize()
ListServiceAccountsRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ListServiceAccountsRequest other)
Int32	GetHashCode()
void	MergeFrom(ListServiceAccountsRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	PageSizeFieldNumber	Field number for the “page_size” field.
Int32	PageTokenFieldNumber	Field number for the “page_token” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ListServiceAccountsRequest>	Parser

ListServiceAccountsResponse

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.ListServiceAccountsResponse
    : IMessage<ListServiceAccountsResponse>, IPageResponse<ServiceAccount>, IEnumerable<ServiceAccount>, IEnumerable, IDeepCloneable<ListServiceAccountsResponse>, IEquatable<ListServiceAccountsResponse>, IMessage

Properties

Type	Name	Summary
String	NextPageToken	A token you can supply to the ListDeployments RPC to retrieve the next page of paginated results.
RepeatedField<ServiceAccount>	ServiceAccounts

Methods

Type	Name	Summary
Int32	CalculateSize()
ListServiceAccountsResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ListServiceAccountsResponse other)
IEnumerator<ServiceAccount>	GetEnumerator()	Returns an enumerator that iterates through the resources in this response.
Int32	GetHashCode()
void	MergeFrom(ListServiceAccountsResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	NextPageTokenFieldNumber	Field number for the “next_page_token” field.
Int32	ServiceAccountsFieldNumber	Field number for the “service_accounts” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ListServiceAccountsResponse>	Parser

Permission

EXAMPLE: For the permission, [r,w]:prj/gamex [r,w] represented by READ, WRITE VERBs prj/gamex represented by “prj”, “gamex” PARTs

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.Permission
    : IMessage<Permission>, IDeepCloneable<Permission>, IEquatable<Permission>, IMessage

Properties

Type	Name	Summary
RepeatedField<String>	Parts
RepeatedField<Verb>	Verbs

Methods

Type	Name	Summary
Int32	CalculateSize()
Permission	Clone()
Boolean	Equals(Object other)
Boolean	Equals(Permission other)
Int32	GetHashCode()
void	MergeFrom(Permission other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	PartsFieldNumber	Field number for the “parts” field.
Int32	VerbsFieldNumber	Field number for the “verbs” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<Permission>	Parser

ServiceAccount

A representation of service account containing the information required to display them to a user.

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccount
    : IMessage<ServiceAccount>, IDeepCloneable<ServiceAccount>, IEquatable<ServiceAccount>, IMessage

Properties

Type	Name	Summary
Timestamp	CreationTime	Creation and expiration time of the service account token. Expiration time optional, if non-expiring.
Timestamp	ExpirationTime
Int64	Id	The unique service account id.
String	Name	The name of the service account.
RepeatedField<Permission>	Permissions	The service account’s scope, as Permissions.
String	ProjectName	The name of the project associated with the service account.
String	Token	A refresh token representing the created service account.

Methods

Type	Name	Summary
Int32	CalculateSize()
ServiceAccount	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ServiceAccount other)
Int32	GetHashCode()
void	MergeFrom(ServiceAccount other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	CreationTimeFieldNumber	Field number for the “creation_time” field.
Int32	ExpirationTimeFieldNumber	Field number for the “expiration_time” field.
Int32	IdFieldNumber	Field number for the “id” field.
Int32	NameFieldNumber	Field number for the “name” field.
Int32	PermissionsFieldNumber	Field number for the “permissions” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.
Int32	TokenFieldNumber	Field number for the “token” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ServiceAccount>	Parser

ServiceAccountReflection

Placeholder for reflection information generated from proto/improbable/spatialos/serviceaccount/v1alpha1/service_account.proto

public static class Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountReflection

Static properties

Type	Name	Summary
FileDescriptor	Descriptor	File descriptor for proto/improbable/spatialos/serviceaccount/v1alpha1/service_account.proto

ServiceAccountService

ServiceAccountService provides methods for managing service accounts.

public static class Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountService

Static properties

Type	Name	Summary
ServiceDescriptor	Descriptor	Service descriptor

Static methods

Type	Name	Summary
ServerServiceDefinition	BindService(ServiceAccountServiceBase serviceImpl)	Creates service definition that can be registered with a server

ServiceAccountServiceClient

ServiceAccountService client wrapper, for convenient use.

public abstract class Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClient

Properties

Type	Name	Summary
ServiceAccountServiceClient	GrpcClient	The underlying gRPC ServiceAccountService client.

Methods

Type	Name	Summary
ServiceAccount	CreateServiceAccount(CreateServiceAccountRequest request, CallSettings callSettings = null)
Task<ServiceAccount>	CreateServiceAccountAsync(CreateServiceAccountRequest request, CallSettings callSettings = null)
Task<ServiceAccount>	CreateServiceAccountAsync(CreateServiceAccountRequest request, CancellationToken cancellationToken)
void	DeleteServiceAccount(DeleteServiceAccountRequest request, CallSettings callSettings = null)
Task	DeleteServiceAccountAsync(DeleteServiceAccountRequest request, CallSettings callSettings = null)
Task	DeleteServiceAccountAsync(DeleteServiceAccountRequest request, CancellationToken cancellationToken)
PagedEnumerable<ListServiceAccountsResponse, ServiceAccount>	ListServiceAccounts(ListServiceAccountsRequest request, CallSettings callSettings = null)
PagedAsyncEnumerable<ListServiceAccountsResponse, ServiceAccount>	ListServiceAccountsAsync(ListServiceAccountsRequest request, CallSettings callSettings = null)
ServiceAccount	UpdateServiceAccount(UpdateServiceAccountRequest request, CallSettings callSettings = null)
Task<ServiceAccount>	UpdateServiceAccountAsync(UpdateServiceAccountRequest request, CallSettings callSettings = null)
Task<ServiceAccount>	UpdateServiceAccountAsync(UpdateServiceAccountRequest request, CancellationToken cancellationToken)

Static properties

Type	Name	Summary
PlatformApiEndpoint	DefaultEndpoint	The default endpoint for the ServiceAccountService service, which is a host of “platform.api.improbable.io” and a port of 443.

Static methods

Type	Name	Summary
ServiceAccountServiceClient	Create(PlatformApiEndpoint endpoint = null, PlatformCredential credentials = null, ServiceAccountServiceSettings settings = null)	Synchronously creates a Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application auto-detected credentials where necessary. See the example for how to use custom credentials.
ServiceAccountServiceClient	Create(Channel channel, ServiceAccountServiceSettings settings = null)	Synchronously creates a Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application auto-detected credentials where necessary. See the example for how to use custom credentials.

ServiceAccountServiceClientImpl

ServiceAccountService client wrapper implementation, for convenient use.

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClientImpl
    : ServiceAccountServiceClient

Properties

Type	Name	Summary
ServiceAccountServiceClient	GrpcClient	The underlying gRPC ServiceAccountService client.

Methods

Type	Name	Summary
ServiceAccount	CreateServiceAccount(CreateServiceAccountRequest request, CallSettings callSettings = null)
Task<ServiceAccount>	CreateServiceAccountAsync(CreateServiceAccountRequest request, CallSettings callSettings = null)
void	DeleteServiceAccount(DeleteServiceAccountRequest request, CallSettings callSettings = null)
Task	DeleteServiceAccountAsync(DeleteServiceAccountRequest request, CallSettings callSettings = null)
PagedEnumerable<ListServiceAccountsResponse, ServiceAccount>	ListServiceAccounts(ListServiceAccountsRequest request, CallSettings callSettings = null)
PagedAsyncEnumerable<ListServiceAccountsResponse, ServiceAccount>	ListServiceAccountsAsync(ListServiceAccountsRequest request, CallSettings callSettings = null)
ServiceAccount	UpdateServiceAccount(UpdateServiceAccountRequest request, CallSettings callSettings = null)
Task<ServiceAccount>	UpdateServiceAccountAsync(UpdateServiceAccountRequest request, CallSettings callSettings = null)

ServiceAccountServiceSettings

Settings for a Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClient.

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceSettings
    : ServiceSettingsBase

Properties

Type	Name	Summary
CallSettings	CreateServiceAccountSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to ServiceAccountServiceClient.CreateServiceAccount and ServiceAccountServiceClient.CreateServiceAccountAsync.
CallSettings	DeleteServiceAccountSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to ServiceAccountServiceClient.DeleteServiceAccount and ServiceAccountServiceClient.DeleteServiceAccountAsync.
CallSettings	ListServiceAccountsSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to ServiceAccountServiceClient.ListServiceAccounts and ServiceAccountServiceClient.ListServiceAccountsAsync.
CallSettings	UpdateServiceAccountSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to ServiceAccountServiceClient.UpdateServiceAccount and ServiceAccountServiceClient.UpdateServiceAccountAsync.

Methods

Type	Name	Summary
ServiceAccountServiceSettings	Clone()	Creates a deep clone of this object, with all the same property values.

Static properties

Type	Name	Summary
Predicate<RpcException>	IdempotentRetryFilter	The filter specifying which RPC Grpc.Core.StatusCodes are eligible for retry for “Idempotent” Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClient RPC methods.
Predicate<RpcException>	NonIdempotentRetryFilter	The filter specifying which RPC Grpc.Core.StatusCodes are eligible for retry for “NonIdempotent” Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClient RPC methods.

Static methods

Type	Name	Summary
ServiceAccountServiceSettings	GetDefault()	Get a new instance of the default Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceSettings.
BackoffSettings	GetDefaultRetryBackoff()	“Default” retry backoff for Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClient RPC methods.
BackoffSettings	GetDefaultTimeoutBackoff()	“Default” timeout backoff for Improbable.SpatialOS.ServiceAccount.V1Alpha1.ServiceAccountServiceClient RPC methods.

UpdateServiceAccountRequest

public class Improbable.SpatialOS.ServiceAccount.V1Alpha1.UpdateServiceAccountRequest
    : IMessage<UpdateServiceAccountRequest>, IDeepCloneable<UpdateServiceAccountRequest>, IEquatable<UpdateServiceAccountRequest>, IMessage

Properties

Type	Name	Summary
Timestamp	ExpirationTime	An updated expiration time for the account. This cannot be more than 90 days in the future.
Int64	Id	The ID of the service account which is to be updated.
RepeatedField<Permission>	Permissions	An updated set of grants for the service account.

Methods

Type	Name	Summary
Int32	CalculateSize()
UpdateServiceAccountRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(UpdateServiceAccountRequest other)
Int32	GetHashCode()
void	MergeFrom(UpdateServiceAccountRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	ExpirationTimeFieldNumber	Field number for the “expiration_time” field.
Int32	IdFieldNumber	Field number for the “id” field.
Int32	PermissionsFieldNumber	Field number for the “permissions” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<UpdateServiceAccountRequest>	Parser

Snapshot.V1Alpha1

ConfirmUploadRequest

public class Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadRequest
    : IMessage<ConfirmUploadRequest>, IDeepCloneable<ConfirmUploadRequest>, IEquatable<ConfirmUploadRequest>, IMessage

Properties

Type	Name	Summary
String	DeploymentName	The deployment the snapshot belongs to. It must conform to the regex: ^[a-z0-9_]{3,32}$
String	Id	The identifier for the uploaded snapshot.
String	ProjectName	The project the snapshot belongs to. It must conform to the regex: ^[a-z0-9_]{3,32}$

Methods

Type	Name	Summary
Int32	CalculateSize()
ConfirmUploadRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ConfirmUploadRequest other)
Int32	GetHashCode()
void	MergeFrom(ConfirmUploadRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentNameFieldNumber	Field number for the “deployment_name” field.
Int32	IdFieldNumber	Field number for the “id” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ConfirmUploadRequest>	Parser

ConfirmUploadResponse

public class Improbable.SpatialOS.Snapshot.V1Alpha1.ConfirmUploadResponse
    : IMessage<ConfirmUploadResponse>, IDeepCloneable<ConfirmUploadResponse>, IEquatable<ConfirmUploadResponse>, IMessage

Properties

Type	Name	Summary
Snapshot	Snapshot

Methods

Type	Name	Summary
Int32	CalculateSize()
ConfirmUploadResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ConfirmUploadResponse other)
Int32	GetHashCode()
void	MergeFrom(ConfirmUploadResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	SnapshotFieldNumber	Field number for the “snapshot” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ConfirmUploadResponse>	Parser

GetSnapshotRequest

public class Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotRequest
    : IMessage<GetSnapshotRequest>, IDeepCloneable<GetSnapshotRequest>, IEquatable<GetSnapshotRequest>, IMessage

Properties

Type	Name	Summary
String	DeploymentName	The deployment the snapshot belongs to. It must conform to the regex: ^[a-z0-9_]{3,32}$
String	Id	The identifier for the desired snapshot.
String	ProjectName	The project the snapshot belongs to. It must conform to the regex: ^[a-z0-9_]{3,32}$

Methods

Type	Name	Summary
Int32	CalculateSize()
GetSnapshotRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(GetSnapshotRequest other)
Int32	GetHashCode()
void	MergeFrom(GetSnapshotRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentNameFieldNumber	Field number for the “deployment_name” field.
Int32	IdFieldNumber	Field number for the “id” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<GetSnapshotRequest>	Parser

GetSnapshotResponse

public class Improbable.SpatialOS.Snapshot.V1Alpha1.GetSnapshotResponse
    : IMessage<GetSnapshotResponse>, IDeepCloneable<GetSnapshotResponse>, IEquatable<GetSnapshotResponse>, IMessage

Properties

Type	Name	Summary
Snapshot	Snapshot

Methods

Type	Name	Summary
Int32	CalculateSize()
GetSnapshotResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(GetSnapshotResponse other)
Int32	GetHashCode()
void	MergeFrom(GetSnapshotResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	SnapshotFieldNumber	Field number for the “snapshot” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<GetSnapshotResponse>	Parser

ListSnapshotsRequest

public class Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsRequest
    : IMessage<ListSnapshotsRequest>, IPageRequest, IDeepCloneable<ListSnapshotsRequest>, IEquatable<ListSnapshotsRequest>, IMessage

Properties

Type	Name	Summary
String	DeploymentName	The deployment to list snapshots for. It must conform to the regex: ^[a-z0-9_]{3,32}$
Int32	PageSize	The number of snapshots to provide in each page of the paginated results.
String	PageToken	A token, previously provided by the service as a next_page_token, for retrieving additional pages of paginated results.
String	ProjectName	The name of the project to list snapshots for. It must conform to the regex: ^[a-z0-9_]{3,32}$

Methods

Type	Name	Summary
Int32	CalculateSize()
ListSnapshotsRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ListSnapshotsRequest other)
Int32	GetHashCode()
void	MergeFrom(ListSnapshotsRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	DeploymentNameFieldNumber	Field number for the “deployment_name” field.
Int32	PageSizeFieldNumber	Field number for the “page_size” field.
Int32	PageTokenFieldNumber	Field number for the “page_token” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ListSnapshotsRequest>	Parser

ListSnapshotsResponse

public class Improbable.SpatialOS.Snapshot.V1Alpha1.ListSnapshotsResponse
    : IMessage<ListSnapshotsResponse>, IPageResponse<Snapshot>, IEnumerable<Snapshot>, IEnumerable, IDeepCloneable<ListSnapshotsResponse>, IEquatable<ListSnapshotsResponse>, IMessage

Properties

Type	Name	Summary
String	NextPageToken	A token which you can supply to the ListSnapshot RPC to retrieve the next page of paginated results.
RepeatedField<Snapshot>	Snapshot

Methods

Type	Name	Summary
Int32	CalculateSize()
ListSnapshotsResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(ListSnapshotsResponse other)
IEnumerator<Snapshot>	GetEnumerator()	Returns an enumerator that iterates through the resources in this response.
Int32	GetHashCode()
void	MergeFrom(ListSnapshotsResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	NextPageTokenFieldNumber	Field number for the “next_page_token” field.
Int32	SnapshotFieldNumber	Field number for the “snapshot” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<ListSnapshotsResponse>	Parser

Snapshot

public class Improbable.SpatialOS.Snapshot.V1Alpha1.Snapshot
    : IMessage<Snapshot>, IDeepCloneable<Snapshot>, IEquatable<Snapshot>, IMessage

Properties

Type	Name	Summary
String	Checksum	A checksum hash of the snapshot file. You can only supply this with UploadSnapshot. Currently, we only support base64 MD5 format.
Timestamp	CreateTime	The time at which the snapshot was taken (either taken from a running deployment or initiated by an upload). Read-only.
String	DeploymentName	The deployment that the snapshot is associated with. You can only supply this with TakeSnapshot or UploadSnapshot. It must conform to the regex: ^[a-z0-9_]{3,32}$
String	DownloadUrl	A download URL for the snapshot, which is valid for five minutes. Read-only.
String	Id	A unique identifier for the snapshot. Read-only.
String	ProjectName	The project that the snapshot is associated with. You can only supply this with TakeSnapshotor UploadSnapshot. It must conform to the regex: ^[a-z0-9_]{3,32}$
Int64	Size	The size of the snapshot in bytes. Read-only.
RepeatedField<String>	Tags	Tags associated with the snapshot. Tags are set of strings which you can use to identify deployments. You must supply this with TakeSnapshot or UploadSnapshot. It must conform to the regex: ^[a-zA-Z0-9_:.-]{2,32}$

Methods

Type	Name	Summary
Int32	CalculateSize()
Snapshot	Clone()
Boolean	Equals(Object other)
Boolean	Equals(Snapshot other)
Int32	GetHashCode()
void	MergeFrom(Snapshot other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	ChecksumFieldNumber	Field number for the “checksum” field.
Int32	CreateTimeFieldNumber	Field number for the “create_time” field.
Int32	DeploymentNameFieldNumber	Field number for the “deployment_name” field.
Int32	DownloadUrlFieldNumber	Field number for the “download_url” field.
Int32	IdFieldNumber	Field number for the “id” field.
Int32	ProjectNameFieldNumber	Field number for the “project_name” field.
Int32	SizeFieldNumber	Field number for the “size” field.
Int32	TagsFieldNumber	Field number for the “tags” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<Snapshot>	Parser

SnapshotReflection

Placholder for reflection information generated from proto/improbable/spatialos/snapshot/v1alpha1/snapshot.proto

public static class Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotReflection

Static properties

Type	Name	Summary
FileDescriptor	Descriptor	File descriptor for proto/improbable/spatialos/snapshot/v1alpha1/snapshot.proto

SnapshotService

SnapshotService provides methods for managing snapshots.

public static class Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotService

Static properties

Type	Name	Summary
ServiceDescriptor	Descriptor	Service descriptor

Static methods

Type	Name	Summary
ServerServiceDefinition	BindService(SnapshotServiceBase serviceImpl)	Creates service definition that can be registered with a server

SnapshotServiceClient

SnapshotService client wrapper, for convenient use.

public abstract class Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClient

Properties

Type	Name	Summary
SnapshotServiceClient	GrpcClient	The underlying gRPC SnapshotService client.
OperationsClient	TakeSnapshotOperationsClient	The long-running operations client for TakeSnapshot.

Methods

Type	Name	Summary
ConfirmUploadResponse	ConfirmUpload(ConfirmUploadRequest request, CallSettings callSettings = null)
Task<ConfirmUploadResponse>	ConfirmUploadAsync(ConfirmUploadRequest request, CallSettings callSettings = null)
Task<ConfirmUploadResponse>	ConfirmUploadAsync(ConfirmUploadRequest request, CancellationToken cancellationToken)
GetSnapshotResponse	GetSnapshot(GetSnapshotRequest request, CallSettings callSettings = null)
Task<GetSnapshotResponse>	GetSnapshotAsync(GetSnapshotRequest request, CallSettings callSettings = null)
Task<GetSnapshotResponse>	GetSnapshotAsync(GetSnapshotRequest request, CancellationToken cancellationToken)
PagedEnumerable<ListSnapshotsResponse, Snapshot>	ListSnapshots(ListSnapshotsRequest request, CallSettings callSettings = null)
PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot>	ListSnapshotsAsync(ListSnapshotsRequest request, CallSettings callSettings = null)
Operation<Snapshot, TakeSnapshotMetadata>	PollOnceTakeSnapshot(String operationName, CallSettings callSettings = null)	Poll an operation once, using an operationName from a previous invocation of TakeSnapshot.
Task<Operation<Snapshot, TakeSnapshotMetadata>>	PollOnceTakeSnapshotAsync(String operationName, CallSettings callSettings = null)	Asynchronously poll an operation once, using an operationName from a previous invocation of TakeSnapshotAsync.
Operation<Snapshot, TakeSnapshotMetadata>	TakeSnapshot(TakeSnapshotRequest request, CallSettings callSettings = null)
Task<Operation<Snapshot, TakeSnapshotMetadata>>	TakeSnapshotAsync(TakeSnapshotRequest request, CallSettings callSettings = null)
UploadSnapshotResponse	UploadSnapshot(UploadSnapshotRequest request, CallSettings callSettings = null)
Task<UploadSnapshotResponse>	UploadSnapshotAsync(UploadSnapshotRequest request, CallSettings callSettings = null)
Task<UploadSnapshotResponse>	UploadSnapshotAsync(UploadSnapshotRequest request, CancellationToken cancellationToken)

Static properties

Type	Name	Summary
PlatformApiEndpoint	DefaultEndpoint	The default endpoint for the SnapshotService service, which is a host of “platform.api.improbable.io” and a port of 443.

Static methods

Type	Name	Summary
SnapshotServiceClient	Create(PlatformApiEndpoint endpoint = null, PlatformCredential credentials = null, SnapshotServiceSettings settings = null)	Synchronously creates a Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application auto-detected credentials where necessary. See the example for how to use custom credentials.
SnapshotServiceClient	Create(Channel channel, SnapshotServiceSettings settings = null)	Synchronously creates a Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application auto-detected credentials where necessary. See the example for how to use custom credentials.

SnapshotServiceClientImpl

SnapshotService client wrapper implementation, for convenient use.

public class Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClientImpl
    : SnapshotServiceClient

Properties

Type	Name	Summary
SnapshotServiceClient	GrpcClient	The underlying gRPC SnapshotService client.
OperationsClient	TakeSnapshotOperationsClient	The long-running operations client for TakeSnapshot.

Methods

Type	Name	Summary
ConfirmUploadResponse	ConfirmUpload(ConfirmUploadRequest request, CallSettings callSettings = null)
Task<ConfirmUploadResponse>	ConfirmUploadAsync(ConfirmUploadRequest request, CallSettings callSettings = null)
GetSnapshotResponse	GetSnapshot(GetSnapshotRequest request, CallSettings callSettings = null)
Task<GetSnapshotResponse>	GetSnapshotAsync(GetSnapshotRequest request, CallSettings callSettings = null)
PagedEnumerable<ListSnapshotsResponse, Snapshot>	ListSnapshots(ListSnapshotsRequest request, CallSettings callSettings = null)
PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot>	ListSnapshotsAsync(ListSnapshotsRequest request, CallSettings callSettings = null)
Operation<Snapshot, TakeSnapshotMetadata>	TakeSnapshot(TakeSnapshotRequest request, CallSettings callSettings = null)
Task<Operation<Snapshot, TakeSnapshotMetadata>>	TakeSnapshotAsync(TakeSnapshotRequest request, CallSettings callSettings = null)
UploadSnapshotResponse	UploadSnapshot(UploadSnapshotRequest request, CallSettings callSettings = null)
Task<UploadSnapshotResponse>	UploadSnapshotAsync(UploadSnapshotRequest request, CallSettings callSettings = null)

SnapshotServiceSettings

Settings for a Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClient.

public class Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceSettings
    : ServiceSettingsBase

Properties

Type	Name	Summary
CallSettings	ConfirmUploadSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to SnapshotServiceClient.ConfirmUpload and SnapshotServiceClient.ConfirmUploadAsync.
CallSettings	GetSnapshotSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to SnapshotServiceClient.GetSnapshot and SnapshotServiceClient.GetSnapshotAsync.
CallSettings	ListSnapshotsSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to SnapshotServiceClient.ListSnapshots and SnapshotServiceClient.ListSnapshotsAsync.
OperationsSettings	TakeSnapshotOperationsSettings	Long Running Operation settings for calls to SnapshotServiceClient.TakeSnapshot.
CallSettings	TakeSnapshotSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to SnapshotServiceClient.TakeSnapshot and SnapshotServiceClient.TakeSnapshotAsync.
CallSettings	UploadSnapshotSettings	Google.Api.Gax.Grpc.CallSettings for synchronous and asynchronous calls to SnapshotServiceClient.UploadSnapshot and SnapshotServiceClient.UploadSnapshotAsync.

Methods

Type	Name	Summary
SnapshotServiceSettings	Clone()	Creates a deep clone of this object, with all the same property values.

Static properties

Type	Name	Summary
Predicate<RpcException>	IdempotentRetryFilter	The filter specifying which RPC Grpc.Core.StatusCodes are eligible for retry for “Idempotent” Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClient RPC methods.
Predicate<RpcException>	NonIdempotentRetryFilter	The filter specifying which RPC Grpc.Core.StatusCodes are eligible for retry for “NonIdempotent” Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClient RPC methods.

Static methods

Type	Name	Summary
SnapshotServiceSettings	GetDefault()	Get a new instance of the default Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceSettings.
BackoffSettings	GetDefaultRetryBackoff()	“Default” retry backoff for Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClient RPC methods.
BackoffSettings	GetDefaultTimeoutBackoff()	“Default” timeout backoff for Improbable.SpatialOS.Snapshot.V1Alpha1.SnapshotServiceClient RPC methods.

TakeSnapshotMetadata

public class Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotMetadata
    : IMessage<TakeSnapshotMetadata>, IDeepCloneable<TakeSnapshotMetadata>, IEquatable<TakeSnapshotMetadata>, IMessage

Methods

Type	Name	Summary
Int32	CalculateSize()
TakeSnapshotMetadata	Clone()
Boolean	Equals(Object other)
Boolean	Equals(TakeSnapshotMetadata other)
Int32	GetHashCode()
void	MergeFrom(TakeSnapshotMetadata other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<TakeSnapshotMetadata>	Parser

TakeSnapshotRequest

public class Improbable.SpatialOS.Snapshot.V1Alpha1.TakeSnapshotRequest
    : IMessage<TakeSnapshotRequest>, IDeepCloneable<TakeSnapshotRequest>, IEquatable<TakeSnapshotRequest>, IMessage

Properties

Type	Name	Summary
Snapshot	Snapshot

Methods

Type	Name	Summary
Int32	CalculateSize()
TakeSnapshotRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(TakeSnapshotRequest other)
Int32	GetHashCode()
void	MergeFrom(TakeSnapshotRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	SnapshotFieldNumber	Field number for the “snapshot” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<TakeSnapshotRequest>	Parser

UploadSnapshotRequest

public class Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotRequest
    : IMessage<UploadSnapshotRequest>, IDeepCloneable<UploadSnapshotRequest>, IEquatable<UploadSnapshotRequest>, IMessage

Properties

Type	Name	Summary
Snapshot	Snapshot

Methods

Type	Name	Summary
Int32	CalculateSize()
UploadSnapshotRequest	Clone()
Boolean	Equals(Object other)
Boolean	Equals(UploadSnapshotRequest other)
Int32	GetHashCode()
void	MergeFrom(UploadSnapshotRequest other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	SnapshotFieldNumber	Field number for the “snapshot” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<UploadSnapshotRequest>	Parser

UploadSnapshotResponse

public class Improbable.SpatialOS.Snapshot.V1Alpha1.UploadSnapshotResponse
    : IMessage<UploadSnapshotResponse>, IDeepCloneable<UploadSnapshotResponse>, IEquatable<UploadSnapshotResponse>, IMessage

Properties

Type	Name	Summary
Snapshot	Snapshot	The created snapshot.
String	UploadUrl	A URL to accept the snapshot’s contents. You should supply the contents in the body of an HTTP POST request.

Methods

Type	Name	Summary
Int32	CalculateSize()
UploadSnapshotResponse	Clone()
Boolean	Equals(Object other)
Boolean	Equals(UploadSnapshotResponse other)
Int32	GetHashCode()
void	MergeFrom(UploadSnapshotResponse other)
void	MergeFrom(CodedInputStream input)
String	ToString()
void	WriteTo(CodedOutputStream output)

Static fields

Type	Name	Summary
Int32	SnapshotFieldNumber	Field number for the “snapshot” field.
Int32	UploadUrlFieldNumber	Field number for the “upload_url” field.

Static properties

Type	Name	Summary
MessageDescriptor	Descriptor
MessageParser<UploadSnapshotResponse>	Parser

Search results