V1Alpha1.ListDeploymentsRequest Class

Namespace: Improbable.SpatialOS.Deployment

Inheritance

IPageRequest
pb::IMessage<ListDeploymentsRequest>

Child types

Name
Description

Container for nested types declared in the ListDeploymentsRequest message type.


Const Fields

ProjectNameFieldNumber
const int ProjectNameFieldNumber = 1

Field number for the "project_name" field.

PageSizeFieldNumber
const int PageSizeFieldNumber = 2

Field number for the "page_size" field.

PageTokenFieldNumber
const int PageTokenFieldNumber = 3

Field number for the "page_token" field.

DeploymentNameFieldNumber
const int DeploymentNameFieldNumber = 4

Field number for the "deployment_name" field.

ViewFieldNumber
const int ViewFieldNumber = 5

Field number for the "view" field.

DeploymentStoppedStatusFilterFieldNumber
const int DeploymentStoppedStatusFilterFieldNumber = 6

Field number for the "deployment_stopped_status_filter" field.

FiltersFieldNumber
const int FiltersFieldNumber = 7

Field number for the "filters" field.


Static Properties

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


Descriptor
pbr::MessageDescriptor Descriptor { get; }


Properties

ProjectName
string ProjectName { get; set; }

The project to list all deployments for.

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

PageSize
int PageSize { get; set; }

The maximum number of deployments to return in the response.

Notes:
  • It must not be negative. If unset or 0, it defaults to 20.

PageToken
string PageToken { get; set; }

The token to identify the starting point of the request. An empty or invalid token defaults to listing from the start.

DeploymentName
string DeploymentName { get; set; }

The name of the deployment.

Notes:
  • Leave it empty to list all deployments under the given project. If provided, it must conform to the regex: ^[a-z0-9]{3,32}$ TODO(COMP-1834): deprecate this

View
global::Improbable.SpatialOS.Deployment.V1Alpha1.ViewType View { get; set; }

How much data is returned for each deployment in the list. Optional. The default is FULL, which returns all fields for each Deployment in the response, but is more expensive than requesting a BASIC response.

DeploymentStoppedStatusFilter
global::Improbable.SpatialOS.Deployment.V1Alpha1.ListDeploymentsRequest.Types.DeploymentStoppedStatusFilter DeploymentStoppedStatusFilter { get; set; }

Filter for all deployments, or filter by whether deployments are stopped or not. TODO(COMP-1834): deprecate this

Filters
pbc::RepeatedField<global::Improbable.SpatialOS.Deployment.V1Alpha1.Filter> Filters { get; }


Constructors

ListDeploymentsRequest
ListDeploymentsRequest()


ListDeploymentsRequest
ListDeploymentsRequest(ListDeploymentsRequest other)

Parameters


Methods

Clone
ListDeploymentsRequest Clone()


Equals
bool Equals(ListDeploymentsRequest other)

Parameters

WriteTo
void WriteTo(pb::CodedOutputStream output)

Parameters
  • pb::CodedOutputStream output :

CalculateSize
int CalculateSize()


MergeFrom
void MergeFrom(ListDeploymentsRequest 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.ListDeploymentsRequest Class


Suggested Edits are limited on API Reference Pages

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