Table of Contents

Class BeginRootfsTarStagingRequest

Namespace
Openshell.V1
Assembly
OpenShell.Sdk.dll

Request a gateway-owned staging slot for a local rootfs tar archive.

public sealed class BeginRootfsTarStagingRequest : IMessage<BeginRootfsTarStagingRequest>, IEquatable<BeginRootfsTarStagingRequest>, IDeepCloneable<BeginRootfsTarStagingRequest>, IBufferMessage, IMessage
Inheritance
BeginRootfsTarStagingRequest
Implements
IBufferMessage
IMessage
Inherited Members

Constructors

BeginRootfsTarStagingRequest() 

public BeginRootfsTarStagingRequest()

BeginRootfsTarStagingRequest(BeginRootfsTarStagingRequest) 

public BeginRootfsTarStagingRequest(BeginRootfsTarStagingRequest other)

Parameters

other BeginRootfsTarStagingRequest

Fields

FileNameFieldNumber

Field number for the "file_name" field.

public const int FileNameFieldNumber = 1

Field Value

int

SizeBytesFieldNumber

Field number for the "size_bytes" field.

public const int SizeBytesFieldNumber = 2

Field Value

int

WorkspaceScopeFieldNumber

Field number for the "workspace_scope" field.

public const int WorkspaceScopeFieldNumber = 3

Field Value

int

Properties

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FileName

Base file name of the local archive. The gateway uses it only to name the staged file; path separators and traversal components are rejected.

public string FileName { get; set; }

Property Value

string

Parser 

public static MessageParser<BeginRootfsTarStagingRequest> Parser { get; }

Property Value

MessageParser<BeginRootfsTarStagingRequest>

SizeBytes

Size of the local archive in bytes, checked against the driver limit before the gateway allocates a slot.

public ulong SizeBytes { get; set; }

Property Value

ulong

WorkspaceScope

Workspace scope. Only a named workspace selection is accepted.

public WorkspaceSelector WorkspaceScope { get; set; }

Property Value

WorkspaceSelector

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public BeginRootfsTarStagingRequest Clone()

Returns

BeginRootfsTarStagingRequest

A deep clone of this object.

Equals(BeginRootfsTarStagingRequest)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(BeginRootfsTarStagingRequest other)

Parameters

other BeginRootfsTarStagingRequest

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(BeginRootfsTarStagingRequest)

Merges the given message into this one.

public void MergeFrom(BeginRootfsTarStagingRequest other)

Parameters

other BeginRootfsTarStagingRequest

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.