Class ExposeServiceRequest

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Request to expose an HTTP service running inside a sandbox.

public sealed class ExposeServiceRequest : IMessage<ExposeServiceRequest>, IEquatable<ExposeServiceRequest>, IDeepCloneable<ExposeServiceRequest>, IBufferMessage, IMessage

Inheritance

object

ExposeServiceRequest

Implements

IMessage<ExposeServiceRequest>

IEquatable<ExposeServiceRequest>

IDeepCloneable<ExposeServiceRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ExposeServiceRequest()

public ExposeServiceRequest()

ExposeServiceRequest(ExposeServiceRequest)

public ExposeServiceRequest(ExposeServiceRequest other)

Parameters

other ExposeServiceRequest

Fields

AuthorizationModeFieldNumber

Field number for the "authorization_mode" field.

public const int AuthorizationModeFieldNumber = 7

Field Value

int

DomainFieldNumber

Field number for the "domain" field.

public const int DomainFieldNumber = 4

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 2

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 6

Field Value

int

SandboxFieldNumber

Field number for the "sandbox" field.

public const int SandboxFieldNumber = 1

Field Value

int

TargetPortFieldNumber

Field number for the "target_port" field.

public const int TargetPortFieldNumber = 3

Field Value

int

WorkspaceScopeFieldNumber

Field number for the "workspace_scope" field.

public const int WorkspaceScopeFieldNumber = 5

Field Value

int

Properties

AuthorizationMode

Application authorization behavior. Omission resolves to STRIP.

public ServiceAuthorizationMode AuthorizationMode { get; set; }

Property Value

ServiceAuthorizationMode

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Domain

Whether to print/use the browser-facing service URL.

public bool Domain { get; set; }

Property Value

bool

Name

Service name within the sandbox.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<ExposeServiceRequest> Parser { get; }

Property Value

MessageParser<ExposeServiceRequest>

RequestId

Optional nonzero UUID for durable at-most-once admission. Successful results can be replayed for 24 hours; see the API errors and retries reference.

public string RequestId { get; set; }

Property Value

string

Sandbox

public string Sandbox { get; set; }

Property Value

string

TargetPort

Loopback TCP port inside the sandbox.

public uint TargetPort { get; set; }

Property Value

uint

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 ExposeServiceRequest Clone()

Returns

ExposeServiceRequest

A deep clone of this object.

Equals(ExposeServiceRequest)

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

public bool Equals(ExposeServiceRequest other)

Parameters

other ExposeServiceRequest

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(ExposeServiceRequest)

Merges the given message into this one.

public void MergeFrom(ExposeServiceRequest other)

Parameters

other ExposeServiceRequest

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.