Service: Devices (ntt.devices.v1alpha - v1alpha)

Name of Project

Reference of ntt.devices.v1alpha.Project

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.devices.v1alpha.Project

Names of Projects

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 Projects

list of not found Projects

Requested page size. Server may return fewer Projects 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 [ListProjectsResponse.next_page_token][ntt.devices.v1alpha.ListProjectsResponse.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 Projects

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

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

Reference to ntt.devices.v1alpha.Project

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

Requested page size. Server may return fewer Projects 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 Project 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 Project that don't affect any of masked fields won't be sent back.

Changes of Projects

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.

Project resource body

Project resource body

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

Reference of ntt.devices.v1alpha.Project

Name of Device

Metadata of Device

Spec holds the expected state of the Device, meaning configurations.

Status of the Device reported from the actual device.

Display name for the device

The associated service account to the Device. The agents in the device uses a key from this service account when they issue any requests to our endpoints for authoroization and authentication. ProvisionServiceAccountToDevice creates a new service account and a key for the Device and asign the account to this fileld. If you change the value of this field, the existing device would lose the access to the resources in our services, that means you can revoke the permissions from the device. You can manually set an empty value to do so, or call RemoveServiceAccountFromDevice.

The expected OS version in string (e.g. 1.0.2). The device will automatically download the OS image and upgrade itself with it. You can stack the OS upgrade progress in the Condition named OSReady in Status.Conditions.

The URL is dynamically constructed once the device is created or updated. The URL will be based on the device hardware information URL format: base_url/dedicated_path/iso_version/architecture/os_type

List of network addresses.

List of conditions of the Device.

Device detailed information

IPv4 or IPv6 address such as 203.0.113.5 (no suffix for subnet)

Always InternalIP

The message describes the status.

The reason for the status.

The status name.

Type name of the status.

When the status has been updated last time.

When the status has tuned into the current value.

The architecture of the CPU (and the software compilied for) (e.g. arm64)

Base OS name (e.g. Linux)

OS kernel version

OS base Image name

Not used

Liquid OS version currently used.

Container driver name (e.g. /var/lib/droplet/compose)

Reference of ntt.devices.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.devices.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.devices.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.devices.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.devices.v1alpha.ListDevicesRequest.page_token]

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

Reference to ntt.devices.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.devices.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.devices.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.devices.v1alpha.Device

Name of Device to provision service account. This method automatically generates a service account and a key for the device and assign the key to .Spec.ServiceAccount

The service account generated by the endpoint. Save the private key included.

Name of the Device to remove its service account The service account and the key will be automatically deleted as well when they have been generated automatically by ProvisionServiceAccountToDevice action. Otherwise, the service account will be kept intact. The device will lost the access to the resources in the project.

This is a hello message from the agent with its name.

When the agent failed to open a requested channel, this message will be sent from the agent to the endpoint.

KeepAlive.

The self-declared device name, used for authentication/authorization.

ID of the channel failed to open.

Error message.

Notifies a new channel has been requested by a client.

Channel ID

Device service;

Initial argument (optional)

Registers a new socket on the endpoint.

Data from the agent to the endpoint (client).

Device name, to be authenticated/authorized.

Channel ID, requested by the endpoint in the ChannelRequested message.

Data from the endpoint (client) to the agent.

The initiation message to open a channel to a device.

Any data sent to the device through the endpoint.

Device name to connect.

Device service

Initial argument (optional)

Notification from the agent (endpoint) to the channel has been opened.

Any data from the device (endpoint) to the client.

Name of ProvisioningPolicy

Provisioning mode.

The service account associated with the policy. Devices have to have a key of this service account to conduct self-provisioning.

Template for device name.

Deprecated: Use template instead. labels that provisioned Device resources will have.

Template for Devices to be generated. Used only on Device resource creation, changing the value won't affect existing Device resources.

Device hardware identity paths (fields) to use for matching pre-existing device resources when provisioning.

service_account will be ignored.

Reference of ntt.devices.v1alpha.ProvisioningPolicy

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.devices.v1alpha.ProvisioningPolicy

Names of ProvisioningPolicys

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 ProvisioningPolicys

list of not found ProvisioningPolicys

Parent name of ntt.devices.v1alpha.ProvisioningPolicy

Requested page size. Server may return fewer ProvisioningPolicys 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 [ListProvisioningPolicysResponse.next_page_token][ntt.devices.v1alpha.ListProvisioningPolicysResponse.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 ProvisioningPolicys

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

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

Reference to ntt.devices.v1alpha.ProvisioningPolicy

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.devices.v1alpha.ProvisioningPolicy

Requested page size. Server may return fewer ProvisioningPolicys 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 ProvisioningPolicy 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 ProvisioningPolicy that don't affect any of masked fields won't be sent back.

Changes of ProvisioningPolicys

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.devices.v1alpha.ProvisioningPolicy

ProvisioningPolicy resource body

ProvisioningPolicy resource body

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

Reference of ntt.devices.v1alpha.ProvisioningPolicy

Name of ProvisioningPolicy_Reference

Name of ProvisioningPolicy_Reference

Name of ProvisioningPolicy_Reference

Name of ProvisioningPolicy_Reference

Mode is not defined, devices will do nothing when the policy is configured in this mode.

Devices will create Device resources automatically without any human interaction.

Devices will create ProvisioningApprovalRequests so that users can approve.

Name of ProvisioningApprovalRequest

The verdicit for the approval, approved or revoked.

System managed, this service account will be used by the Device resource once it's approved. A device finds its pending request using this field.

Reference of ntt.devices.v1alpha.ProvisioningApprovalRequest

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.devices.v1alpha.ProvisioningApprovalRequest

Names of ProvisioningApprovalRequests

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 ProvisioningApprovalRequests

list of not found ProvisioningApprovalRequests

Parent name of ntt.devices.v1alpha.ProvisioningApprovalRequest

Requested page size. Server may return fewer ProvisioningApprovalRequests 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 [ListProvisioningApprovalRequestsResponse.next_page_token][ntt.devices.v1alpha.ListProvisioningApprovalRequestsResponse.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 ProvisioningApprovalRequests

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

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

Reference to ntt.devices.v1alpha.ProvisioningApprovalRequest

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.devices.v1alpha.ProvisioningApprovalRequest

Requested page size. Server may return fewer ProvisioningApprovalRequests 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 ProvisioningApprovalRequest 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 ProvisioningApprovalRequest that don't affect any of masked fields won't be sent back.

Changes of ProvisioningApprovalRequests

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.devices.v1alpha.ProvisioningApprovalRequest

ProvisioningApprovalRequest resource body

ProvisioningApprovalRequest resource body

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

Reference of ntt.devices.v1alpha.ProvisioningApprovalRequest

Name of ProvisioningApprovalRequest_Reference

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.

Name of Project_Reference

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.devices.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 requested on top of those 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

The list of Devices

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

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

Logs data

Live follow the logs service

Number of lines to get from the logs service

Source of the logs service (e.g. docker container ID)

Pod state command

Pod to execute the command on

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 Project is deleted or leaves Query view

Integer describing index of added Project in resulting query view.

Name of modified Project

New version of Project or masked difference, depending on mask_changes instrumentation of issued [WatchProjectRequest] or [WatchProjectsRequest]

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

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

Integer specifying Project new index in resulting query view.

Integer specifying removed Project 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 ProvisioningApprovalRequest is deleted or leaves Query view

Integer describing index of added ProvisioningApprovalRequest in resulting query view.

Name of modified ProvisioningApprovalRequest

New version of ProvisioningApprovalRequest or masked difference, depending on mask_changes instrumentation of issued [WatchProvisioningApprovalRequestRequest] or [WatchProvisioningApprovalRequestsRequest]

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

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

Integer specifying ProvisioningApprovalRequest new index in resulting query view.

Integer specifying removed ProvisioningApprovalRequest 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 ProvisioningPolicy is deleted or leaves Query view

Integer describing index of added ProvisioningPolicy in resulting query view.

Name of modified ProvisioningPolicy

New version of ProvisioningPolicy or masked difference, depending on mask_changes instrumentation of issued [WatchProvisioningPolicyRequest] or [WatchProvisioningPolicysRequest]

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

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

Integer specifying ProvisioningPolicy new index in resulting query view.

Integer specifying removed ProvisioningPolicy index.

Request to create a directory

Request to create a file

Request to end SCP transfer

Request SCP configuration

Request file initialization

Request file data

Request to end file transfer

Service type not specified

SSH service

TCP port forward service

Reboot service

Shutdown service

SCP service

System Logs service

Application (Container) Logs service

Pod State Management service

Unspecified pod state

Start the pod

Stop the pod

Restart the pod

Unspecified system state

Shutdown the system

Reboot the system