V1Alpha1.Snapshot Class

Namespace: Improbable.SpatialOS.Snapshot

Inheritance

pb::IMessage<Snapshot>


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.

CreateTimeFieldNumber
const int CreateTimeFieldNumber = 4

Field number for the "create_time" field.

SizeFieldNumber
const int SizeFieldNumber = 5

Field number for the "size" field.

TagsFieldNumber
const int TagsFieldNumber = 6

Field number for the "tags" field.

DownloadUrlFieldNumber
const int DownloadUrlFieldNumber = 7

Field number for the "download_url" field.

ChecksumFieldNumber
const int ChecksumFieldNumber = 8

Field number for the "checksum" field.


Static Properties

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


Descriptor
pbr::MessageDescriptor Descriptor { get; }


Properties

Id
string Id { get; set; }

A unique identifier for the snapshot. Read-only.

ProjectName
string ProjectName { get; set; }

The project that the snapshot is associated with. You can only supply this with TakeSnapshotor UploadSnapshot.

Notes:
  • It must conform to the regex: ^[a-z0-9]{3,32}$

DeploymentName
string DeploymentName { get; set; }

The deployment that the snapshot is associated with. You can only supply this with TakeSnapshot or UploadSnapshot.

Notes:
  • It must conform to the regex: ^[a-z0-9]{3,32}$

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

The time at which the snapshot was taken (either taken from a running deployment or initiated by an upload). Read-only.

Size
long Size { get; set; }

The size of the snapshot in bytes. Read-only.

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

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.

Notes:
  • It must conform to the regex: ^[a-zA-Z0-9_:.-]{2,32}$

DownloadUrl
string DownloadUrl { get; set; }

A download URL for the snapshot, which is valid for five minutes. Read-only.

Checksum
string Checksum { get; set; }

A checksum hash of the snapshot file. You can only supply this with UploadSnapshot.

Notes:
  • Currently, we only support base64 MD5 format.


Constructors

Snapshot
Snapshot()


Snapshot
Snapshot(Snapshot other)

Parameters


Methods

Clone
Snapshot Clone()


Equals
bool Equals(Snapshot other)

Parameters

WriteTo
void WriteTo(pb::CodedOutputStream output)

Parameters
  • pb::CodedOutputStream output :

CalculateSize
int CalculateSize()


MergeFrom
void MergeFrom(Snapshot 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


V1Alpha1.Snapshot Class


Suggested Edits are limited on API Reference Pages

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