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

Name of Site

Display Name

Site location

Site geometry. May include multiple buildings.

Reference of ntt.workplace.v1alpha.Site

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

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

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

Optional parent ntt.workplace.v1alpha.Site

Names of Sites

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

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

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

found Sites

list of not found Sites

Parent name of ntt.workplace.v1alpha.Site

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

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 - 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 - 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")'

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

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

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

The list of Sites

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

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

Reference to ntt.workplace.v1alpha.Site

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

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

Parent reference of ntt.workplace.v1alpha.Site

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

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

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

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")'

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 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.

Changes of Sites

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

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.workplace.v1alpha.Site

Site resource body

Site resource body

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

Reference of ntt.workplace.v1alpha.Site

Name of Building

Display Name

Street location of building

Building geometry

Reference of ntt.workplace.v1alpha.Building

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

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

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

Optional parent ntt.workplace.v1alpha.Building

Names of Buildings

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

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

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

found Buildings

list of not found Buildings

Parent name of ntt.workplace.v1alpha.Building

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

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 - 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 - 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")'

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

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

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

The list of Buildings

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

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

Reference to ntt.workplace.v1alpha.Building

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

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

Parent reference of ntt.workplace.v1alpha.Building

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

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

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

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")'

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 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.

Changes of Buildings

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

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.workplace.v1alpha.Building

Building resource body

Building resource body

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

Reference of ntt.workplace.v1alpha.Building

Name of Floor

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

Ordering number describes sorting order, usually:

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

Floor geometry, usually same as parent Building.

Reference of ntt.workplace.v1alpha.Floor

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

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

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

Optional parent ntt.workplace.v1alpha.Floor

Names of Floors

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

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

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

found Floors

list of not found Floors

Parent name of ntt.workplace.v1alpha.Floor

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

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 - 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 - 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")'

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

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

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

The list of Floors

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

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

Reference to ntt.workplace.v1alpha.Floor

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

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

Parent reference of ntt.workplace.v1alpha.Floor

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

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

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

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")'

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 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.

Changes of Floors

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

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.workplace.v1alpha.Floor

Floor resource body

Floor resource body

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

Reference of ntt.workplace.v1alpha.Floor

Name of Area

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

Type of this area

Geometry of this area

Reference of ntt.workplace.v1alpha.Area

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

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

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

Optional parent ntt.workplace.v1alpha.Area

Names of Areas

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

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

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

found Areas

list of not found Areas

Parent name of ntt.workplace.v1alpha.Area

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

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 - 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 - 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")'

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

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

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

The list of Areas

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

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

Reference to ntt.workplace.v1alpha.Area

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

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

Parent reference of ntt.workplace.v1alpha.Area

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

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

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

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")'

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 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.

Changes of Areas

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

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.workplace.v1alpha.Area

Area resource body

Area resource body

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

Reference of ntt.workplace.v1alpha.Area

Name of Agent

Reference of ntt.workplace.v1alpha.Agent

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

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

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

Optional parent ntt.workplace.v1alpha.Agent

Names of Agents

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

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

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

found Agents

list of not found Agents

Parent name of ntt.workplace.v1alpha.Agent

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

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 - 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 - 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")'

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

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

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

The list of Agents

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

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

Reference to ntt.workplace.v1alpha.Agent

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

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

Parent reference of ntt.workplace.v1alpha.Agent

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

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

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

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")'

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 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.

Changes of Agents

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

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.workplace.v1alpha.Agent

Agent resource body

Agent resource body

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

Reference of ntt.workplace.v1alpha.Agent

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

ACK message is required to complete onboarding process

Token - either individual or shared

Random cookie string generated by client to identify its session

Optional agent data (required when using shared token).

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

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

Onboarded Probe resource

ServiceAccountKey to use with PrivateKeyData

Name of DeviceGroup

Display Name

Reference of ntt.workplace.v1alpha.DeviceGroup

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

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

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

Optional parent ntt.workplace.v1alpha.DeviceGroup

Names of DeviceGroups

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

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

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

found DeviceGroups

list of not found DeviceGroups

Parent name of ntt.workplace.v1alpha.DeviceGroup

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

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 - 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 - 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")'

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

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

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

The list of DeviceGroups

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

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

Reference to ntt.workplace.v1alpha.DeviceGroup

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

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

Parent reference of ntt.workplace.v1alpha.DeviceGroup

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

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

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

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")'

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 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.

Changes of DeviceGroups

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

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.workplace.v1alpha.DeviceGroup

DeviceGroup resource body

DeviceGroup resource body

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

Reference of ntt.workplace.v1alpha.DeviceGroup

Name of Device

Site geometry

Owner agent

Site Placement

Bacnet Entity descriptor

Site references a site

Building in which the device is placed.

Floor on which the device is placed.

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

Reference of ntt.workplace.v1alpha.Device

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

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

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

Optional parent ntt.workplace.v1alpha.Device

Names of Devices

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

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

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

found Devices

list of not found Devices

Parent name of ntt.workplace.v1alpha.Device

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

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 - 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 - 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")'

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

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

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

The list of Devices

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

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

Reference to ntt.workplace.v1alpha.Device

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

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

Parent reference of ntt.workplace.v1alpha.Device

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

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

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

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")'

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 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.

Changes of Devices

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

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.workplace.v1alpha.Device

Device resource body

Device resource body

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

Reference of ntt.workplace.v1alpha.Device

EDGELQ_DEVICE = 1;

Name of Property

Display Name

Property placement

BACNet Entity descriptor

Reference of ntt.workplace.v1alpha.Property

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

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

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

Optional parent ntt.workplace.v1alpha.Property

Names of Properties

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

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

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

found Properties

list of not found Properties

Parent name of ntt.workplace.v1alpha.Property

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

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 - 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 - 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")'

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

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

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

The list of Properties

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

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

Reference to ntt.workplace.v1alpha.Property

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

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

Parent reference of ntt.workplace.v1alpha.Property

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

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

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

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")'

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 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.

Changes of Properties

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

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.workplace.v1alpha.Property

Property resource body

Property resource body

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

Reference of ntt.workplace.v1alpha.Property

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

Modified is returned when watched document is modified

Removed is returned when Agent is deleted or leaves Query view

Integer describing index of added Agent in resulting query view.

Name of modified Agent

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

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

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

Integer specifying Agent new index in resulting query view.

Integer specifying removed Agent index.

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

Modified is returned when watched document is modified

Removed is returned when Area is deleted or leaves Query view

Integer describing index of added Area in resulting query view.

Name of modified Area

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

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

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

Integer specifying Area new index in resulting query view.

Integer specifying removed Area index.

Object type, e.g.: DNET Analog Input

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

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

UUID of this object

Full URI (riptide format)

BACNet object id

Property update interval

Proto URL provides details about backend location

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

String tags (or key-value tags)

Marker tags (denoting presence)

SouthWest-most corner

NorthEast-most corner

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

Modified is returned when watched document is modified

Removed is returned when Building is deleted or leaves Query view

Integer describing index of added Building in resulting query view.

Name of modified Building

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

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

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

Integer specifying Building new index in resulting query view.

Integer specifying removed Building index.

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

Modified is returned when watched document is modified

Removed is returned when Device is deleted or leaves Query view

Integer describing index of added Device in resulting query view.

Name of modified Device

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

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

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

Integer specifying Device new index in resulting query view.

Integer specifying removed Device index.

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

Modified is returned when watched document is modified

Removed is returned when DeviceGroup is deleted or leaves Query view

Integer describing index of added DeviceGroup in resulting query view.

Name of modified DeviceGroup

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

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

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

Integer specifying DeviceGroup new index in resulting query view.

Integer specifying removed DeviceGroup index.

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

Modified is returned when watched document is modified

Removed is returned when Floor is deleted or leaves Query view

Integer describing index of added Floor in resulting query view.

Name of modified Floor

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

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

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

Integer specifying Floor new index in resulting query view.

Integer specifying removed Floor index.

Center point of place

Bounding Box of place (should contain polygon if present)

Polygon contains detailed shape of place

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

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

Modified is returned when watched document is modified

Removed is returned when Property is deleted or leaves Query view

Integer describing index of added Property in resulting query view.

Name of modified Property

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

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

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

Integer specifying Property new index in resulting query view.

Integer specifying removed Property index.

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

Modified is returned when watched document is modified

Removed is returned when Site is deleted or leaves Query view

Integer describing index of added Site in resulting query view.

Name of modified Site

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

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

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

Integer specifying Site new index in resulting query view.

Integer specifying removed Site index.

Street address in english

Resolved street address coordinates