Class ListServicesRequest

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Request to list exposed sandbox service endpoints.

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

Inheritance

object

ListServicesRequest

Implements

IMessage<ListServicesRequest>

IEquatable<ListServicesRequest>

IDeepCloneable<ListServicesRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ListServicesRequest()

public ListServicesRequest()

ListServicesRequest(ListServicesRequest)

public ListServicesRequest(ListServicesRequest other)

Parameters

other ListServicesRequest

Fields

PageSizeFieldNumber

Field number for the "page_size" field.

public const int PageSizeFieldNumber = 2

Field Value

int

PageTokenFieldNumber

Field number for the "page_token" field.

public const int PageTokenFieldNumber = 3

Field Value

int

SandboxFieldNumber

Field number for the "sandbox" field.

public const int SandboxFieldNumber = 1

Field Value

int

WorkspaceScopeFieldNumber

Field number for the "workspace_scope" field.

public const int WorkspaceScopeFieldNumber = 4

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

PageSize

The maximum number of services to return. Zero uses 100. Values above 1000 are coerced to 1000; negative values are invalid.

public int PageSize { get; set; }

Property Value

int

PageToken

Token from a previous ListServices response. All other request parameters except page_size must match the request that produced it.

public string PageToken { get; set; }

Property Value

string

Parser

public static MessageParser<ListServicesRequest> Parser { get; }

Property Value

MessageParser<ListServicesRequest>

Sandbox

Optional sandbox name. Empty lists endpoints for all sandboxes.

public string Sandbox { get; set; }

Property Value

string

WorkspaceScope

Workspace scope. Named and all-workspaces selections are 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 ListServicesRequest Clone()

Returns

ListServicesRequest

A deep clone of this object.

Equals(ListServicesRequest)

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

public bool Equals(ListServicesRequest other)

Parameters

other ListServicesRequest

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

Merges the given message into this one.

public void MergeFrom(ListServicesRequest other)

Parameters

other ListServicesRequest

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.