Class WorkspaceSelector

Namespace

Openshell.Datamodel.V1

Assembly

OpenShell.Sdk.dll

Selects the workspace scope for a public API request.

Requests that operate on one workspace require a non-empty workspace. Cross-workspace list requests additionally accept all_workspaces. The containing request documents which selections it supports; an omitted selector is invalid for workspace-scoped operations.

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

Inheritance

object

WorkspaceSelector

Implements

IMessage<WorkspaceSelector>

IEquatable<WorkspaceSelector>

IDeepCloneable<WorkspaceSelector>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkspaceSelector()

public WorkspaceSelector()

WorkspaceSelector(WorkspaceSelector)

public WorkspaceSelector(WorkspaceSelector other)

Parameters

other WorkspaceSelector

Fields

AllWorkspacesFieldNumber

Field number for the "all_workspaces" field.

public const int AllWorkspacesFieldNumber = 2

Field Value

int

WorkspaceFieldNumber

Field number for the "workspace" field.

public const int WorkspaceFieldNumber = 1

Field Value

int

Properties

AllWorkspaces

All workspaces the caller is authorized to access. Only supported by requests that explicitly document cross-workspace behavior.

public AllWorkspaces AllWorkspaces { get; set; }

Property Value

AllWorkspaces

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasWorkspace

Gets whether the "workspace" field is set

public bool HasWorkspace { get; }

Property Value

bool

Parser

public static MessageParser<WorkspaceSelector> Parser { get; }

Property Value

MessageParser<WorkspaceSelector>

SelectionCase

public WorkspaceSelector.SelectionOneofCase SelectionCase { get; }

Property Value

WorkspaceSelector.SelectionOneofCase

Workspace

One explicitly named workspace. Use default to select the gateway's default workspace; an empty name is invalid.

public string Workspace { get; set; }

Property Value

string

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.

ClearSelection()

public void ClearSelection()

ClearWorkspace()

Clears the value of the oneof if it's currently set to "workspace"

public void ClearWorkspace()

Clone()

Creates a deep clone of this object.

public WorkspaceSelector Clone()

Returns

WorkspaceSelector

A deep clone of this object.

Equals(WorkspaceSelector)

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

public bool Equals(WorkspaceSelector other)

Parameters

other WorkspaceSelector

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

Merges the given message into this one.

public void MergeFrom(WorkspaceSelector other)

Parameters

other WorkspaceSelector

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.