V1Beta1.Deployment Class

Namespace: Improbable.SpatialOS.Deployment

Inheritance

pb::IMessage<Deployment>

Child types

Name
Description

Container for nested types declared in the Deployment message type.


Const Fields

IdFieldNumber
const int IdFieldNumber = 1

Field number for the "id" field.

ProjectNameFieldNumber
const int ProjectNameFieldNumber = 2

Field number for the "project_name" field.

DeploymentNameFieldNumber
const int DeploymentNameFieldNumber = 3

Field number for the "deployment_name" field.

RegionCodeFieldNumber
const int RegionCodeFieldNumber = 4

Field number for the "region_code" field.

ClusterCodeFieldNumber
const int ClusterCodeFieldNumber = 5

Field number for the "cluster_code" field.

AssemblyNameFieldNumber
const int AssemblyNameFieldNumber = 7

Field number for the "assembly_name" field.

StartingSnapshotIdFieldNumber
const int StartingSnapshotIdFieldNumber = 8

Field number for the "starting_snapshot_id" field.

TagsFieldNumber
const int TagsFieldNumber = 9

Field number for the "tags" field.

StatusFieldNumber
const int StatusFieldNumber = 10

Field number for the "status" field.

LaunchConfigFieldNumber
const int LaunchConfigFieldNumber = 11

Field number for the "launch_config" field.

WorkerFlagsFieldNumber
const int WorkerFlagsFieldNumber = 12

Field number for the "worker_flags" field.

StartTimeFieldNumber
const int StartTimeFieldNumber = 13

Field number for the "start_time" field.

StopTimeFieldNumber
const int StopTimeFieldNumber = 14

Field number for the "stop_time" field.

WorkerConnectionCapacitiesFieldNumber
const int WorkerConnectionCapacitiesFieldNumber = 15

Field number for the "worker_connection_capacities" field.

WorkerConnectionRateLimitsFieldNumber
const int WorkerConnectionRateLimitsFieldNumber = 16

Field number for the "worker_connection_rate_limits" field.

DescriptionFieldNumber
const int DescriptionFieldNumber = 17

Field number for the "description" field.

RuntimeVersionFieldNumber
const int RuntimeVersionFieldNumber = 18

Field number for the "runtime_version" field.

ExpiryTimeFieldNumber
const int ExpiryTimeFieldNumber = 19

Field number for the "expiry_time" field.


Static Properties

Parser
pb::MessageParser<Deployment> Parser { get; }


Descriptor
pbr::MessageDescriptor Descriptor { get; }


Properties

Id
long Id { get; set; }

A unique identifier for the deployment. Read-only. The deployment's id is assigned automatically and uniquely identifies a particular run of a deployment.

ProjectName
string ProjectName { get; set; }

The name of the project this deployment belongs to. It must be lower case letters or numbers or underscores and 3-32 characters in length.

DeploymentName
string DeploymentName { get; set; }

The name of the deployment. It must be lower case letters or numbers or underscores and 3-32 characters in length.

RegionCode
string RegionCode { get; set; }

The region that the deployment is running in. The supported regions are "EU" and "US" (and "AP" for specific users who have requested access).

ClusterCode
string ClusterCode { get; set; }

The name of the cluster this deployment is in.

AssemblyName
string AssemblyName { get; set; }

The assembly to use for the deployment.

StartingSnapshotId
string StartingSnapshotId { get; set; }

The starting snapshot for the deployment. This is a string to allow users to provide a filepath to a snapshot in the local workflow.

Tags
pbc::RepeatedField<string> Tags { get; }

Tags associated with the deployment. Tags are a set of strings you can use to identify deployments. A tag must be upper or lower case letters or numbers or underscores and 3-32 characters in length.

Status
global::Improbable.SpatialOS.Deployment.V1Beta1.Deployment.Types.Status Status { get; set; }

Whether the deployment is running.

LaunchConfig
global::Improbable.SpatialOS.Deployment.V1Beta1.LaunchConfig LaunchConfig { get; set; }

The configuration for starting the deployment.

WorkerFlags
pbc::RepeatedField<global::Improbable.SpatialOS.Deployment.V1Beta1.WorkerFlag> WorkerFlags { get; }

The worker flags that the deployment exposes at runtime.

Notes:
  • Only applicable to running deployments. It is omitted for deployments in other states.

StartTime
global::Google.Protobuf.WellKnownTypes.Timestamp StartTime { get; set; }

The time the deployment is started.

StopTime
global::Google.Protobuf.WellKnownTypes.Timestamp StopTime { get; set; }

The time the deployment is stopped.

WorkerConnectionCapacities
pbc::RepeatedField<global::Improbable.SpatialOS.Deployment.V1Beta1.WorkerCapacity> WorkerConnectionCapacities { get; }

Only applicable to running deployments.

Notes:
  • 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, i.e. 0x7FFFFFFF. But, it is not guaranteed.
  • The current used capacity can always be calculated as max_capacity - remaining_capacity.
  • Note: if you set the same worker type more than once, we provide no guarantee which overrides which.

WorkerConnectionRateLimits
pbc::RepeatedField<global::Improbable.SpatialOS.Deployment.V1Beta1.WorkerRateLimit> WorkerConnectionRateLimits { get; }

Only applicable to running deployments.

Notes:
  • The rate limits of the deployment, broken down by worker type. If a worker type is absent or has zero'ed value, you can assume that worker type is not rate limited.
  • Note: if you set the same worker type more than once, we provide no guarantee which overrides which.

Description
string Description { get; set; }

The description provided when the deployment was started

RuntimeVersion
string RuntimeVersion { get; set; }

Only use this field if you were directed to do so by SpatialOS support

Notes:
  • The version of the Runtime to start the deployment.

ExpiryTime
global::Google.Protobuf.WellKnownTypes.Timestamp ExpiryTime { get; set; }

The time the deployment will expire.


Constructors

Deployment
Deployment()


Deployment
Deployment(Deployment other)

Parameters


Methods

Clone
Deployment Clone()


Equals
bool Equals(Deployment other)

Parameters

WriteTo
void WriteTo(pb::CodedOutputStream output)

Parameters
  • pb::CodedOutputStream output :

CalculateSize
int CalculateSize()


MergeFrom
void MergeFrom(Deployment other)

Parameters

MergeFrom
void MergeFrom(pb::CodedInputStream input)

Parameters
  • pb::CodedInputStream input :


Overrides

Equals
override bool Equals(object other)

Parameters
  • object other :

GetHashCode
override int GetHashCode()


ToString
override string ToString()

Updated about a year ago


V1Beta1.Deployment Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.