en-US
en-US

Service: Workplace (ntt.workplace.v1alpha - v1alpha)

Service Workplace

Index

Resources

Site

Site Resource

Fields
name
string

Name of Site

display_name
string

Display Name

location
StreetLocation

Site location

geometry
Geometry

Site geometry. May include multiple buildings.

Operations

GetSite
rpc GetSite(GetSiteRequest) returns (Site)

GetSite

BatchGetSites
rpc BatchGetSites(BatchGetSitesRequest) returns (BatchGetSitesResponse)

BatchGetSites

ListSites
rpc ListSites(ListSitesRequest) returns (ListSitesResponse)

ListSites

WatchSite
rpc WatchSite(WatchSiteRequest) returns (WatchSiteResponse)

WatchSite

WatchSites
rpc WatchSites(WatchSitesRequest) returns (WatchSitesResponse)

WatchSites

CreateSite
rpc CreateSite(CreateSiteRequest) returns (Site)

CreateSite

UpdateSite
rpc UpdateSite(UpdateSiteRequest) returns (Site)

UpdateSite

DeleteSite
rpc DeleteSite(DeleteSiteRequest) returns (Empty)

DeleteSite

Messages

GetSiteRequest

Request message for method [GetSite][ntt.workplace.v1alpha.GetSite]

Fields
name
string

Reference of ntt.workplace.v1alpha.Site

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetSitesRequest

Request message for method [BatchGetSites][ntt.workplace.v1alpha.BatchGetSites]

Fields
parent
string

Optional parent ntt.workplace.v1alpha.Site

names
repeated string

Names of Sites

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetSitesResponse

BatchGetSitesResponse

Fields
sites
repeated Site

found Sites

missing
repeated string

list of not found Sites

ListSitesRequest

Request message for method [ListSites][ntt.workplace.v1alpha.ListSites]

Fields
parent
string

Parent name of ntt.workplace.v1alpha.Site

page_size
int32

Requested page size. Server may return fewer Sites than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListSitesResponse.next_page_token][ntt.workplace.v1alpha.ListSitesResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListSitesResponse

Request message for method [ListSites][ntt.workplace.v1alpha.ListSites]

Fields
sites
repeated Site

The list of Sites

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListSitesRequest.page_token][ntt.workplace.v1alpha.ListSitesRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListSitesRequest.page_token][ntt.workplace.v1alpha.ListSitesRequest.page_token]

WatchSiteRequest

Request message for method [WatchSite][ntt.workplace.v1alpha.WatchSite]

Fields
name
string

Reference to ntt.workplace.v1alpha.Site

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchSiteResponse

WatchSiteResponse

Fields
change
SiteChange
WatchSitesRequest

Request message for method [WatchSites][ntt.workplace.v1alpha.WatchSites]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Site

page_size
int32

Requested page size. Server may return fewer Sites than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Site that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Site that don't affect any of masked fields won't be sent back.

WatchSitesResponse

WatchSitesResponse

Fields
site_changes
repeated SiteChange

Changes of Sites

page_token_change
WatchSitesResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchSitesResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateSiteRequest

Request message for method [CreateSite][ntt.workplace.v1alpha.CreateSite]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Site

site
Site

Site resource body

UpdateSiteRequest

Request message for method [UpdateSite][ntt.workplace.v1alpha.UpdateSite]

Fields
site
Site

Site resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteSiteRequest

Request message for method [DeleteSite][ntt.workplace.v1alpha.DeleteSite]

Fields
name
string

Reference of ntt.workplace.v1alpha.Site

Building

Building Resource

Fields
name
string

Name of Building

display_name
string

Display Name

location
StreetLocation

Street location of building

geometry
Geometry

Building geometry

Operations

GetBuilding
rpc GetBuilding(GetBuildingRequest) returns (Building)

GetBuilding

BatchGetBuildings
rpc BatchGetBuildings(BatchGetBuildingsRequest) returns (BatchGetBuildingsResponse)

BatchGetBuildings

ListBuildings
rpc ListBuildings(ListBuildingsRequest) returns (ListBuildingsResponse)

ListBuildings

WatchBuilding
rpc WatchBuilding(WatchBuildingRequest) returns (WatchBuildingResponse)

WatchBuilding

WatchBuildings
rpc WatchBuildings(WatchBuildingsRequest) returns (WatchBuildingsResponse)

WatchBuildings

CreateBuilding
rpc CreateBuilding(CreateBuildingRequest) returns (Building)

CreateBuilding

UpdateBuilding
rpc UpdateBuilding(UpdateBuildingRequest) returns (Building)

UpdateBuilding

DeleteBuilding
rpc DeleteBuilding(DeleteBuildingRequest) returns (Empty)

DeleteBuilding

Messages

GetBuildingRequest

Request message for method [GetBuilding][ntt.workplace.v1alpha.GetBuilding]

Fields
name
string

Reference of ntt.workplace.v1alpha.Building

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetBuildingsRequest

Request message for method [BatchGetBuildings][ntt.workplace.v1alpha.BatchGetBuildings]

Fields
parent
string

Optional parent ntt.workplace.v1alpha.Building

names
repeated string

Names of Buildings

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetBuildingsResponse

BatchGetBuildingsResponse

Fields
buildings
repeated Building

found Buildings

missing
repeated string

list of not found Buildings

ListBuildingsRequest

Request message for method [ListBuildings][ntt.workplace.v1alpha.ListBuildings]

Fields
parent
string

Parent name of ntt.workplace.v1alpha.Building

page_size
int32

Requested page size. Server may return fewer Buildings than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListBuildingsResponse.next_page_token][ntt.workplace.v1alpha.ListBuildingsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListBuildingsResponse

Request message for method [ListBuildings][ntt.workplace.v1alpha.ListBuildings]

Fields
buildings
repeated Building

The list of Buildings

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListBuildingsRequest.page_token][ntt.workplace.v1alpha.ListBuildingsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListBuildingsRequest.page_token][ntt.workplace.v1alpha.ListBuildingsRequest.page_token]

WatchBuildingRequest

Request message for method [WatchBuilding][ntt.workplace.v1alpha.WatchBuilding]

Fields
name
string

Reference to ntt.workplace.v1alpha.Building

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchBuildingResponse

WatchBuildingResponse

Fields
change
BuildingChange
WatchBuildingsRequest

Request message for method [WatchBuildings][ntt.workplace.v1alpha.WatchBuildings]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Building

page_size
int32

Requested page size. Server may return fewer Buildings than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Building that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Building that don't affect any of masked fields won't be sent back.

WatchBuildingsResponse

WatchBuildingsResponse

Fields
building_changes
repeated BuildingChange

Changes of Buildings

page_token_change
WatchBuildingsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchBuildingsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateBuildingRequest

Request message for method [CreateBuilding][ntt.workplace.v1alpha.CreateBuilding]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Building

building
Building

Building resource body

UpdateBuildingRequest

Request message for method [UpdateBuilding][ntt.workplace.v1alpha.UpdateBuilding]

Fields
building
Building

Building resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteBuildingRequest

Request message for method [DeleteBuilding][ntt.workplace.v1alpha.DeleteBuilding]

Fields
name
string

Reference of ntt.workplace.v1alpha.Building

Floor

Floor Resource describes Building floor

Fields
name
string

Name of Floor

display_name
string

Display Name of Floor, e.g. B1, Ground

ordering_number
sint32

Ordering number describes sorting order, usually:

  • ground floor is 0
  • above-ground floors use positive numbers
  • basement floors use negative numbers (-1 = B1)
geometry
Geometry

Floor geometry, usually same as parent Building.

Operations

GetFloor
rpc GetFloor(GetFloorRequest) returns (Floor)

GetFloor

BatchGetFloors
rpc BatchGetFloors(BatchGetFloorsRequest) returns (BatchGetFloorsResponse)

BatchGetFloors

ListFloors
rpc ListFloors(ListFloorsRequest) returns (ListFloorsResponse)

ListFloors

WatchFloor
rpc WatchFloor(WatchFloorRequest) returns (WatchFloorResponse)

WatchFloor

WatchFloors
rpc WatchFloors(WatchFloorsRequest) returns (WatchFloorsResponse)

WatchFloors

CreateFloor
rpc CreateFloor(CreateFloorRequest) returns (Floor)

CreateFloor

UpdateFloor
rpc UpdateFloor(UpdateFloorRequest) returns (Floor)

UpdateFloor

DeleteFloor
rpc DeleteFloor(DeleteFloorRequest) returns (Empty)

DeleteFloor

Messages

GetFloorRequest

Request message for method [GetFloor][ntt.workplace.v1alpha.GetFloor]

Fields
name
string

Reference of ntt.workplace.v1alpha.Floor

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetFloorsRequest

Request message for method [BatchGetFloors][ntt.workplace.v1alpha.BatchGetFloors]

Fields
parent
string

Optional parent ntt.workplace.v1alpha.Floor

names
repeated string

Names of Floors

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetFloorsResponse

BatchGetFloorsResponse

Fields
floors
repeated Floor

found Floors

missing
repeated string

list of not found Floors

ListFloorsRequest

Request message for method [ListFloors][ntt.workplace.v1alpha.ListFloors]

Fields
parent
string

Parent name of ntt.workplace.v1alpha.Floor

page_size
int32

Requested page size. Server may return fewer Floors than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListFloorsResponse.next_page_token][ntt.workplace.v1alpha.ListFloorsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListFloorsResponse

Request message for method [ListFloors][ntt.workplace.v1alpha.ListFloors]

Fields
floors
repeated Floor

The list of Floors

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListFloorsRequest.page_token][ntt.workplace.v1alpha.ListFloorsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListFloorsRequest.page_token][ntt.workplace.v1alpha.ListFloorsRequest.page_token]

WatchFloorRequest

Request message for method [WatchFloor][ntt.workplace.v1alpha.WatchFloor]

Fields
name
string

Reference to ntt.workplace.v1alpha.Floor

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchFloorResponse

WatchFloorResponse

Fields
change
FloorChange
WatchFloorsRequest

Request message for method [WatchFloors][ntt.workplace.v1alpha.WatchFloors]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Floor

page_size
int32

Requested page size. Server may return fewer Floors than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Floor that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Floor that don't affect any of masked fields won't be sent back.

WatchFloorsResponse

WatchFloorsResponse

Fields
floor_changes
repeated FloorChange

Changes of Floors

page_token_change
WatchFloorsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchFloorsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateFloorRequest

Request message for method [CreateFloor][ntt.workplace.v1alpha.CreateFloor]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Floor

floor
Floor

Floor resource body

UpdateFloorRequest

Request message for method [UpdateFloor][ntt.workplace.v1alpha.UpdateFloor]

Fields
floor
Floor

Floor resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteFloorRequest

Request message for method [DeleteFloor][ntt.workplace.v1alpha.DeleteFloor]

Fields
name
string

Reference of ntt.workplace.v1alpha.Floor

Area

Area Resource

Fields
name
string

Name of Area

display_name
string

Display name, e.g. "Room #203"

type
Area.Type

Type of this area

geometry
Geometry

Geometry of this area

Operations

GetArea
rpc GetArea(GetAreaRequest) returns (Area)

GetArea

BatchGetAreas
rpc BatchGetAreas(BatchGetAreasRequest) returns (BatchGetAreasResponse)

BatchGetAreas

ListAreas
rpc ListAreas(ListAreasRequest) returns (ListAreasResponse)

ListAreas

WatchArea
rpc WatchArea(WatchAreaRequest) returns (WatchAreaResponse)

WatchArea

WatchAreas
rpc WatchAreas(WatchAreasRequest) returns (WatchAreasResponse)

WatchAreas

CreateArea
rpc CreateArea(CreateAreaRequest) returns (Area)

CreateArea

UpdateArea
rpc UpdateArea(UpdateAreaRequest) returns (Area)

UpdateArea

DeleteArea
rpc DeleteArea(DeleteAreaRequest) returns (Empty)

DeleteArea

Messages

GetAreaRequest

Request message for method [GetArea][ntt.workplace.v1alpha.GetArea]

Fields
name
string

Reference of ntt.workplace.v1alpha.Area

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetAreasRequest

Request message for method [BatchGetAreas][ntt.workplace.v1alpha.BatchGetAreas]

Fields
parent
string

Optional parent ntt.workplace.v1alpha.Area

names
repeated string

Names of Areas

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetAreasResponse

BatchGetAreasResponse

Fields
areas
repeated Area

found Areas

missing
repeated string

list of not found Areas

ListAreasRequest

Request message for method [ListAreas][ntt.workplace.v1alpha.ListAreas]

Fields
parent
string

Parent name of ntt.workplace.v1alpha.Area

page_size
int32

Requested page size. Server may return fewer Areas than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListAreasResponse.next_page_token][ntt.workplace.v1alpha.ListAreasResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListAreasResponse

Request message for method [ListAreas][ntt.workplace.v1alpha.ListAreas]

Fields
areas
repeated Area

The list of Areas

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListAreasRequest.page_token][ntt.workplace.v1alpha.ListAreasRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListAreasRequest.page_token][ntt.workplace.v1alpha.ListAreasRequest.page_token]

WatchAreaRequest

Request message for method [WatchArea][ntt.workplace.v1alpha.WatchArea]

Fields
name
string

Reference to ntt.workplace.v1alpha.Area

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchAreaResponse

WatchAreaResponse

Fields
change
AreaChange
WatchAreasRequest

Request message for method [WatchAreas][ntt.workplace.v1alpha.WatchAreas]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Area

page_size
int32

Requested page size. Server may return fewer Areas than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Area that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Area that don't affect any of masked fields won't be sent back.

WatchAreasResponse

WatchAreasResponse

Fields
area_changes
repeated AreaChange

Changes of Areas

page_token_change
WatchAreasResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchAreasResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateAreaRequest

Request message for method [CreateArea][ntt.workplace.v1alpha.CreateArea]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Area

area
Area

Area resource body

UpdateAreaRequest

Request message for method [UpdateArea][ntt.workplace.v1alpha.UpdateArea]

Fields
area
Area

Area resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteAreaRequest

Request message for method [DeleteArea][ntt.workplace.v1alpha.DeleteArea]

Fields
name
string

Reference of ntt.workplace.v1alpha.Area

Enums

Area.Type

Area type

Values
TYPE_UNSPECIFIED
COMMON_AREA
BATHROOM
SERVER_ROOM
OFFICE
OPEN_OFFICE
CONFERENCE_ROOM

Agent

Agent Resource

Fields
name
string

Name of Agent

Operations

GetAgent
rpc GetAgent(GetAgentRequest) returns (Agent)

GetAgent

BatchGetAgents
rpc BatchGetAgents(BatchGetAgentsRequest) returns (BatchGetAgentsResponse)

BatchGetAgents

ListAgents
rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse)

ListAgents

WatchAgent
rpc WatchAgent(WatchAgentRequest) returns (WatchAgentResponse)

WatchAgent

WatchAgents
rpc WatchAgents(WatchAgentsRequest) returns (WatchAgentsResponse)

WatchAgents

CreateAgent
rpc CreateAgent(CreateAgentRequest) returns (Agent)

CreateAgent

UpdateAgent
rpc UpdateAgent(UpdateAgentRequest) returns (Agent)

UpdateAgent

DeleteAgent
rpc DeleteAgent(DeleteAgentRequest) returns (Empty)

DeleteAgent

Activation
rpc Activation(ActivationRequest) returns (ActivationResponse)

Activation

Messages

GetAgentRequest

Request message for method [GetAgent][ntt.workplace.v1alpha.GetAgent]

Fields
name
string

Reference of ntt.workplace.v1alpha.Agent

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetAgentsRequest

Request message for method [BatchGetAgents][ntt.workplace.v1alpha.BatchGetAgents]

Fields
parent
string

Optional parent ntt.workplace.v1alpha.Agent

names
repeated string

Names of Agents

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetAgentsResponse

BatchGetAgentsResponse

Fields
agents
repeated Agent

found Agents

missing
repeated string

list of not found Agents

ListAgentsRequest

Request message for method [ListAgents][ntt.workplace.v1alpha.ListAgents]

Fields
parent
string

Parent name of ntt.workplace.v1alpha.Agent

page_size
int32

Requested page size. Server may return fewer Agents than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListAgentsResponse.next_page_token][ntt.workplace.v1alpha.ListAgentsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListAgentsResponse

Request message for method [ListAgents][ntt.workplace.v1alpha.ListAgents]

Fields
agents
repeated Agent

The list of Agents

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListAgentsRequest.page_token][ntt.workplace.v1alpha.ListAgentsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListAgentsRequest.page_token][ntt.workplace.v1alpha.ListAgentsRequest.page_token]

WatchAgentRequest

Request message for method [WatchAgent][ntt.workplace.v1alpha.WatchAgent]

Fields
name
string

Reference to ntt.workplace.v1alpha.Agent

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchAgentResponse

WatchAgentResponse

Fields
change
AgentChange
WatchAgentsRequest

Request message for method [WatchAgents][ntt.workplace.v1alpha.WatchAgents]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Agent

page_size
int32

Requested page size. Server may return fewer Agents than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Agent that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Agent that don't affect any of masked fields won't be sent back.

WatchAgentsResponse

WatchAgentsResponse

Fields
agent_changes
repeated AgentChange

Changes of Agents

page_token_change
WatchAgentsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchAgentsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateAgentRequest

Request message for method [CreateAgent][ntt.workplace.v1alpha.CreateAgent]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Agent

agent
Agent

Agent resource body

UpdateAgentRequest

Request message for method [UpdateAgent][ntt.workplace.v1alpha.UpdateAgent]

Fields
agent
Agent

Agent resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteAgentRequest

Request message for method [DeleteAgent][ntt.workplace.v1alpha.DeleteAgent]

Fields
name
string

Reference of ntt.workplace.v1alpha.Agent

ActivationRequest

Request message for method [Activation][ntt.workplace.v1alpha.Activation]

Fields
activate
ActivationRequest.Activate

onboard is sent by client. Depending on configured onboarding policy, response may be immediate or take a long time (manual confirmation)

confirm_activation
ActivationRequest.ConfirmActivation

ACK message is required to complete onboarding process

ActivationRequest.Activate
Fields
token
string

Token - either individual or shared

client_cookie
string

Random cookie string generated by client to identify its session

agent
Agent

Optional agent data (required when using shared token).

ActivationRequest.ConfirmActivation
Fields
client_cookie
string

Acknowledgment after receiving activation response. Confirmation is required, otherwise received previously ServiceAccountKey won't be usable

ActivationResponse

Response message for method [Activation][ntt.workplace.v1alpha.Activation]

Fields
activated
ActivationResponse.Activated
confirm_activation_ack
ActivationResponse.ConfirmActivationAck

after receiving this message it's safe to close the onboarding stream

ActivationResponse.Activated
Fields
probe
Agent

Onboarded Probe resource

service_account_key
.ntt.iam.v1alpha.ServiceAccountKey

ServiceAccountKey to use with PrivateKeyData

ActivationResponse.ConfirmActivationAck
Fields
none

DeviceGroup

DeviceGroup Resource allows for grouping of multiple Devices

Fields
name
string

Name of DeviceGroup

display_name
string

Display Name

Operations

GetDeviceGroup
rpc GetDeviceGroup(GetDeviceGroupRequest) returns (DeviceGroup)

GetDeviceGroup

BatchGetDeviceGroups
rpc BatchGetDeviceGroups(BatchGetDeviceGroupsRequest) returns (BatchGetDeviceGroupsResponse)

BatchGetDeviceGroups

ListDeviceGroups
rpc ListDeviceGroups(ListDeviceGroupsRequest) returns (ListDeviceGroupsResponse)

ListDeviceGroups

WatchDeviceGroup
rpc WatchDeviceGroup(WatchDeviceGroupRequest) returns (WatchDeviceGroupResponse)

WatchDeviceGroup

WatchDeviceGroups
rpc WatchDeviceGroups(WatchDeviceGroupsRequest) returns (WatchDeviceGroupsResponse)

WatchDeviceGroups

CreateDeviceGroup
rpc CreateDeviceGroup(CreateDeviceGroupRequest) returns (DeviceGroup)

CreateDeviceGroup

UpdateDeviceGroup
rpc UpdateDeviceGroup(UpdateDeviceGroupRequest) returns (DeviceGroup)

UpdateDeviceGroup

DeleteDeviceGroup
rpc DeleteDeviceGroup(DeleteDeviceGroupRequest) returns (Empty)

DeleteDeviceGroup

Messages

GetDeviceGroupRequest

Request message for method [GetDeviceGroup][ntt.workplace.v1alpha.GetDeviceGroup]

Fields
name
string

Reference of ntt.workplace.v1alpha.DeviceGroup

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetDeviceGroupsRequest

Request message for method [BatchGetDeviceGroups][ntt.workplace.v1alpha.BatchGetDeviceGroups]

Fields
parent
string

Optional parent ntt.workplace.v1alpha.DeviceGroup

names
repeated string

Names of DeviceGroups

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetDeviceGroupsResponse

BatchGetDeviceGroupsResponse

Fields
device_groups
repeated DeviceGroup

found DeviceGroups

missing
repeated string

list of not found DeviceGroups

ListDeviceGroupsRequest

Request message for method [ListDeviceGroups][ntt.workplace.v1alpha.ListDeviceGroups]

Fields
parent
string

Parent name of ntt.workplace.v1alpha.DeviceGroup

page_size
int32

Requested page size. Server may return fewer DeviceGroups than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListDeviceGroupsResponse.next_page_token][ntt.workplace.v1alpha.ListDeviceGroupsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListDeviceGroupsResponse

Request message for method [ListDeviceGroups][ntt.workplace.v1alpha.ListDeviceGroups]

Fields
device_groups
repeated DeviceGroup

The list of DeviceGroups

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListDeviceGroupsRequest.page_token][ntt.workplace.v1alpha.ListDeviceGroupsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListDeviceGroupsRequest.page_token][ntt.workplace.v1alpha.ListDeviceGroupsRequest.page_token]

WatchDeviceGroupRequest

Request message for method [WatchDeviceGroup][ntt.workplace.v1alpha.WatchDeviceGroup]

Fields
name
string

Reference to ntt.workplace.v1alpha.DeviceGroup

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchDeviceGroupResponse

WatchDeviceGroupResponse

Fields
change
DeviceGroupChange
WatchDeviceGroupsRequest

Request message for method [WatchDeviceGroups][ntt.workplace.v1alpha.WatchDeviceGroups]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.DeviceGroup

page_size
int32

Requested page size. Server may return fewer DeviceGroups than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to DeviceGroup that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to DeviceGroup that don't affect any of masked fields won't be sent back.

WatchDeviceGroupsResponse

WatchDeviceGroupsResponse

Fields
device_group_changes
repeated DeviceGroupChange

Changes of DeviceGroups

page_token_change
WatchDeviceGroupsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchDeviceGroupsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateDeviceGroupRequest

Request message for method [CreateDeviceGroup][ntt.workplace.v1alpha.CreateDeviceGroup]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.DeviceGroup

device_group
DeviceGroup

DeviceGroup resource body

UpdateDeviceGroupRequest

Request message for method [UpdateDeviceGroup][ntt.workplace.v1alpha.UpdateDeviceGroup]

Fields
device_group
DeviceGroup

DeviceGroup resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteDeviceGroupRequest

Request message for method [DeleteDeviceGroup][ntt.workplace.v1alpha.DeleteDeviceGroup]

Fields
name
string

Reference of ntt.workplace.v1alpha.DeviceGroup

Device

Device Resource

Fields
name
string

Name of Device

display_name
string
type
Device.Type
geometry
Geometry

Site geometry

owner_agent
string

Owner agent

site_placement
Device.SitePlacement

Site Placement

bacnet
BACNetEntity

Bacnet Entity descriptor

Operations

GetDevice
rpc GetDevice(GetDeviceRequest) returns (Device)

GetDevice

BatchGetDevices
rpc BatchGetDevices(BatchGetDevicesRequest) returns (BatchGetDevicesResponse)

BatchGetDevices

ListDevices
rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

ListDevices

WatchDevice
rpc WatchDevice(WatchDeviceRequest) returns (WatchDeviceResponse)

WatchDevice

WatchDevices
rpc WatchDevices(WatchDevicesRequest) returns (WatchDevicesResponse)

WatchDevices

CreateDevice
rpc CreateDevice(CreateDeviceRequest) returns (Device)

CreateDevice

UpdateDevice
rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

UpdateDevice

DeleteDevice
rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

DeleteDevice

Messages

Device.SitePlacement

SitePlacement describes hierarchy of where Device is placed in Site. It may specify only some of those fields

Fields
site
string

Site references a site

building
string

Building in which the device is placed.

floor
string

Floor on which the device is placed.

area
string

area, e.g. room, commonlpace where the device is placed.

GetDeviceRequest

Request message for method [GetDevice][ntt.workplace.v1alpha.GetDevice]

Fields
name
string

Reference of ntt.workplace.v1alpha.Device

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetDevicesRequest

Request message for method [BatchGetDevices][ntt.workplace.v1alpha.BatchGetDevices]

Fields
parent
string

Optional parent ntt.workplace.v1alpha.Device

names
repeated string

Names of Devices

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetDevicesResponse

BatchGetDevicesResponse

Fields
devices
repeated Device

found Devices

missing
repeated string

list of not found Devices

ListDevicesRequest

Request message for method [ListDevices][ntt.workplace.v1alpha.ListDevices]

Fields
parent
string

Parent name of ntt.workplace.v1alpha.Device

page_size
int32

Requested page size. Server may return fewer Devices than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListDevicesResponse.next_page_token][ntt.workplace.v1alpha.ListDevicesResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListDevicesResponse

Request message for method [ListDevices][ntt.workplace.v1alpha.ListDevices]

Fields
devices
repeated Device

The list of Devices

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListDevicesRequest.page_token][ntt.workplace.v1alpha.ListDevicesRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListDevicesRequest.page_token][ntt.workplace.v1alpha.ListDevicesRequest.page_token]

WatchDeviceRequest

Request message for method [WatchDevice][ntt.workplace.v1alpha.WatchDevice]

Fields
name
string

Reference to ntt.workplace.v1alpha.Device

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchDeviceResponse

WatchDeviceResponse

Fields
change
DeviceChange
WatchDevicesRequest

Request message for method [WatchDevices][ntt.workplace.v1alpha.WatchDevices]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Device

page_size
int32

Requested page size. Server may return fewer Devices than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Device that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Device that don't affect any of masked fields won't be sent back.

WatchDevicesResponse

WatchDevicesResponse

Fields
device_changes
repeated DeviceChange

Changes of Devices

page_token_change
WatchDevicesResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchDevicesResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateDeviceRequest

Request message for method [CreateDevice][ntt.workplace.v1alpha.CreateDevice]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Device

device
Device

Device resource body

UpdateDeviceRequest

Request message for method [UpdateDevice][ntt.workplace.v1alpha.UpdateDevice]

Fields
device
Device

Device resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteDeviceRequest

Request message for method [DeleteDevice][ntt.workplace.v1alpha.DeleteDevice]

Fields
name
string

Reference of ntt.workplace.v1alpha.Device

Enums

Device.Type
Values
TYPE_UNSPECIFIED
HVAC

EDGELQ_DEVICE = 1;

RIPTIDE_HUB
WEATHER

Property

Property Resource describes BACNet property of Site or Device.

Fields
name
string

Name of Property

display_name
string

Display Name

placement
Property.Placement

Property placement

bacnet
BACNetEntity

BACNet Entity descriptor

Operations

GetProperty
rpc GetProperty(GetPropertyRequest) returns (Property)

GetProperty

BatchGetProperties
rpc BatchGetProperties(BatchGetPropertiesRequest) returns (BatchGetPropertiesResponse)

BatchGetProperties

ListProperties
rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

ListProperties

WatchProperty
rpc WatchProperty(WatchPropertyRequest) returns (WatchPropertyResponse)

WatchProperty

WatchProperties
rpc WatchProperties(WatchPropertiesRequest) returns (WatchPropertiesResponse)

WatchProperties

CreateProperty
rpc CreateProperty(CreatePropertyRequest) returns (Property)

CreateProperty

UpdateProperty
rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

UpdateProperty

DeleteProperty
rpc DeleteProperty(DeletePropertyRequest) returns (Empty)

DeleteProperty

Messages

Property.Placement
Fields
site
string
building
string
floor
string
area
string
GetPropertyRequest

Request message for method [GetProperty][ntt.workplace.v1alpha.GetProperty]

Fields
name
string

Reference of ntt.workplace.v1alpha.Property

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetPropertiesRequest

Request message for method [BatchGetProperties][ntt.workplace.v1alpha.BatchGetProperties]

Fields
parent
string

Optional parent ntt.workplace.v1alpha.Property

names
repeated string

Names of Properties

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetPropertiesResponse

BatchGetPropertiesResponse

Fields
properties
repeated Property

found Properties

missing
repeated string

list of not found Properties

ListPropertiesRequest

Request message for method [ListProperties][ntt.workplace.v1alpha.ListProperties]

Fields
parent
string

Parent name of ntt.workplace.v1alpha.Property

page_size
int32

Requested page size. Server may return fewer Properties than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListPropertiesResponse.next_page_token][ntt.workplace.v1alpha.ListPropertiesResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListPropertiesResponse

Request message for method [ListProperties][ntt.workplace.v1alpha.ListProperties]

Fields
properties
repeated Property

The list of Properties

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListPropertiesRequest.page_token][ntt.workplace.v1alpha.ListPropertiesRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListPropertiesRequest.page_token][ntt.workplace.v1alpha.ListPropertiesRequest.page_token]

WatchPropertyRequest

Request message for method [WatchProperty][ntt.workplace.v1alpha.WatchProperty]

Fields
name
string

Reference to ntt.workplace.v1alpha.Property

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchPropertyResponse

WatchPropertyResponse

Fields
change
PropertyChange
WatchPropertiesRequest

Request message for method [WatchProperties][ntt.workplace.v1alpha.WatchProperties]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Property

page_size
int32

Requested page size. Server may return fewer Properties than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Property that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Property that don't affect any of masked fields won't be sent back.

WatchPropertiesResponse

WatchPropertiesResponse

Fields
property_changes
repeated PropertyChange

Changes of Properties

page_token_change
WatchPropertiesResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchPropertiesResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreatePropertyRequest

Request message for method [CreateProperty][ntt.workplace.v1alpha.CreateProperty]

Fields
parent
string

Parent reference of ntt.workplace.v1alpha.Property

property
Property

Property resource body

UpdatePropertyRequest

Request message for method [UpdateProperty][ntt.workplace.v1alpha.UpdateProperty]

Fields
property
Property

Property resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeletePropertyRequest

Request message for method [DeleteProperty][ntt.workplace.v1alpha.DeleteProperty]

Fields
name
string

Reference of ntt.workplace.v1alpha.Property

Shared Resources

Operations
Messages
AgentChange

AgentChange is used by Watch notifications Responses to describe change of single Agent One of Added, Modified, Removed

Fields
added
AgentChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
AgentChange.Modified

Modified is returned when watched document is modified

removed
AgentChange.Removed

Removed is returned when Agent is deleted or leaves Query view

AgentChange.Added

Agent has been added to query view

Fields
agent
Agent
view_index
int32

Integer describing index of added Agent in resulting query view.

AgentChange.Modified

Agent changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Agent

agent
Agent

New version of Agent or masked difference, depending on mask_changes instrumentation of issued [WatchAgentRequest] or [WatchAgentsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Agent. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Agent new index in resulting query view.

AgentChange.Removed

Removed is returned when Agent is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Agent index.

AreaChange

AreaChange is used by Watch notifications Responses to describe change of single Area One of Added, Modified, Removed

Fields
added
AreaChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
AreaChange.Modified

Modified is returned when watched document is modified

removed
AreaChange.Removed

Removed is returned when Area is deleted or leaves Query view

AreaChange.Added

Area has been added to query view

Fields
area
Area
view_index
int32

Integer describing index of added Area in resulting query view.

AreaChange.Modified

Area changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Area

area
Area

New version of Area or masked difference, depending on mask_changes instrumentation of issued [WatchAreaRequest] or [WatchAreasRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Area. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Area new index in resulting query view.

AreaChange.Removed

Removed is returned when Area is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Area index.

BACNetEntity

Entity populated from BACNet system.

In order to retrieve property value (present or historical), query [monitoring][ntt.monitoring.v3.Monitoring] service with resource type workplace.edgelq.com/Property and metric type depending on [property type][ntt.workplace.v1alpha.BACNetEntity.property_type] and presence of [enum values][ntt.workplace.v1alpha.BACNetEntity.enum_values], either metric type:

  • workplace.edgelq.com/Property/value/enum
  • workplace.edgelq.com/Property/value/analog
  • workplace.edgelq.com/Property/value/binary
Fields
object_type
string

Object type, e.g.: DNET Analog Input

property_type
string

BACnet property_type, e.g. AI, AO, BI, BO, AV

name
string

Name, e.g. S1 - Heat Exchanger Liquid Temperature

uuid
string

UUID of this object

uri
string

Full URI (riptide format)

object_id
int64

BACNet object id

update_interval
.google.protobuf.Duration

Property update interval

proto_url
string

Proto URL provides details about backend location

enum_values
string

Enum value mappings: decimal integer of value to readable string value

string_tags
string

String tags (or key-value tags)

marker_tags
repeated string

Marker tags (denoting presence)

BBox

BBox descrbes rectangular geographical area by using two corners

Fields
south_west
.google.type.LatLng

SouthWest-most corner

north_east
.google.type.LatLng

NorthEast-most corner

BuildingChange

BuildingChange is used by Watch notifications Responses to describe change of single Building One of Added, Modified, Removed

Fields
added
BuildingChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
BuildingChange.Modified

Modified is returned when watched document is modified

removed
BuildingChange.Removed

Removed is returned when Building is deleted or leaves Query view

BuildingChange.Added

Building has been added to query view

Fields
building
Building
view_index
int32

Integer describing index of added Building in resulting query view.

BuildingChange.Modified

Building changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Building

building
Building

New version of Building or masked difference, depending on mask_changes instrumentation of issued [WatchBuildingRequest] or [WatchBuildingsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Building. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Building new index in resulting query view.

BuildingChange.Removed

Removed is returned when Building is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Building index.

DeviceChange

DeviceChange is used by Watch notifications Responses to describe change of single Device One of Added, Modified, Removed

Fields
added
DeviceChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
DeviceChange.Modified

Modified is returned when watched document is modified

removed
DeviceChange.Removed

Removed is returned when Device is deleted or leaves Query view

DeviceChange.Added

Device has been added to query view

Fields
device
Device
view_index
int32

Integer describing index of added Device in resulting query view.

DeviceChange.Modified

Device changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Device

device
Device

New version of Device or masked difference, depending on mask_changes instrumentation of issued [WatchDeviceRequest] or [WatchDevicesRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Device. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Device new index in resulting query view.

DeviceChange.Removed

Removed is returned when Device is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Device index.

DeviceGroupChange

DeviceGroupChange is used by Watch notifications Responses to describe change of single DeviceGroup One of Added, Modified, Removed

Fields
added
DeviceGroupChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
DeviceGroupChange.Modified

Modified is returned when watched document is modified

removed
DeviceGroupChange.Removed

Removed is returned when DeviceGroup is deleted or leaves Query view

DeviceGroupChange.Added

DeviceGroup has been added to query view

Fields
device_group
DeviceGroup
view_index
int32

Integer describing index of added DeviceGroup in resulting query view.

DeviceGroupChange.Modified

DeviceGroup changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified DeviceGroup

device_group
DeviceGroup

New version of DeviceGroup or masked difference, depending on mask_changes instrumentation of issued [WatchDeviceGroupRequest] or [WatchDeviceGroupsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified DeviceGroup. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying DeviceGroup new index in resulting query view.

DeviceGroupChange.Removed

Removed is returned when DeviceGroup is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed DeviceGroup index.

FloorChange

FloorChange is used by Watch notifications Responses to describe change of single Floor One of Added, Modified, Removed

Fields
added
FloorChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
FloorChange.Modified

Modified is returned when watched document is modified

removed
FloorChange.Removed

Removed is returned when Floor is deleted or leaves Query view

FloorChange.Added

Floor has been added to query view

Fields
floor
Floor
view_index
int32

Integer describing index of added Floor in resulting query view.

FloorChange.Modified

Floor changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Floor

floor
Floor

New version of Floor or masked difference, depending on mask_changes instrumentation of issued [WatchFloorRequest] or [WatchFloorsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Floor. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Floor new index in resulting query view.

FloorChange.Removed

Removed is returned when Floor is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Floor index.

Geometry

Geometry contains geo-information about place. It may contain just center, bounding box or polygon

Fields
center
.google.type.LatLng

Center point of place

bbox
BBox

Bounding Box of place (should contain polygon if present)

polygon
Polygon

Polygon contains detailed shape of place

Polygon

Polygon describes polygon shape with using geo-coordinates

Fields
coordinates
repeated .google.type.LatLng

List of coordinates. Each polygon vertice connects 2 consecutive points and last point connects with first.

PropertyChange

PropertyChange is used by Watch notifications Responses to describe change of single Property One of Added, Modified, Removed

Fields
added
PropertyChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
PropertyChange.Modified

Modified is returned when watched document is modified

removed
PropertyChange.Removed

Removed is returned when Property is deleted or leaves Query view

PropertyChange.Added

Property has been added to query view

Fields
property
Property
view_index
int32

Integer describing index of added Property in resulting query view.

PropertyChange.Modified

Property changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Property

property
Property

New version of Property or masked difference, depending on mask_changes instrumentation of issued [WatchPropertyRequest] or [WatchPropertiesRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Property. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Property new index in resulting query view.

PropertyChange.Removed

Removed is returned when Property is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Property index.

SiteChange

SiteChange is used by Watch notifications Responses to describe change of single Site One of Added, Modified, Removed

Fields
added
SiteChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
SiteChange.Modified

Modified is returned when watched document is modified

removed
SiteChange.Removed

Removed is returned when Site is deleted or leaves Query view

SiteChange.Added

Site has been added to query view

Fields
site
Site
view_index
int32

Integer describing index of added Site in resulting query view.

SiteChange.Modified

Site changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Site

site
Site

New version of Site or masked difference, depending on mask_changes instrumentation of issued [WatchSiteRequest] or [WatchSitesRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Site. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Site new index in resulting query view.

SiteChange.Removed

Removed is returned when Site is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Site index.

StreetLocation

StreetLocation contains street address and resolved coordinates

Fields
street_address
string

Street address in english

street_coordinates
.google.type.LatLng

Resolved street address coordinates