en-US
en-US

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

Service Devices

Index

Resources

Project

Project Resource

Fields
name
string

Name of Project

Operations

GetProject
rpc GetProject(GetProjectRequest) returns (Project)

GetProject

BatchGetProjects
rpc BatchGetProjects(BatchGetProjectsRequest) returns (BatchGetProjectsResponse)

BatchGetProjects

ListProjects
rpc ListProjects(ListProjectsRequest) returns (ListProjectsResponse)

ListProjects

WatchProject
rpc WatchProject(WatchProjectRequest) returns (WatchProjectResponse)

WatchProject

WatchProjects
rpc WatchProjects(WatchProjectsRequest) returns (WatchProjectsResponse)

WatchProjects

CreateProject
rpc CreateProject(CreateProjectRequest) returns (Project)

CreateProject

UpdateProject
rpc UpdateProject(UpdateProjectRequest) returns (Project)

UpdateProject

DeleteProject
rpc DeleteProject(DeleteProjectRequest) returns (Empty)

DeleteProject

Messages

GetProjectRequest

Request message for method [GetProject][ntt.devices.v1alpha.GetProject]

Fields
name
string

Reference of ntt.devices.v1alpha.Project

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

BatchGetProjectsRequest

Request message for method [BatchGetProjects][ntt.devices.v1alpha.BatchGetProjects]

Fields
parent
string

Optional parent ntt.devices.v1alpha.Project

names
repeated string

Names of Projects

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

BatchGetProjectsResponse

BatchGetProjectsResponse

Fields
projects
repeated Project

found Projects

missing
repeated string

list of not found Projects

ListProjectsRequest

Request message for method [ListProjects][ntt.devices.v1alpha.ListProjects]

Fields
page_size
int32

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

ListProjectsResponse

Request message for method [ListProjects][ntt.devices.v1alpha.ListProjects]

Fields
projects
repeated Project

The list of Projects

prev_page_token
string

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

next_page_token
string

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

WatchProjectRequest

Request message for method [WatchProject][ntt.devices.v1alpha.WatchProject]

Fields
name
string

Reference to ntt.devices.v1alpha.Project

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

WatchProjectResponse

WatchProjectResponse

Fields
change
ProjectChange
WatchProjectsRequest

Request message for method [WatchProjects][ntt.devices.v1alpha.WatchProjects]

Fields
page_size
int32

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

WatchProjectsResponse

WatchProjectsResponse

Fields
project_changes
repeated ProjectChange

Changes of Projects

page_token_change
WatchProjectsResponse.PageTokenChange

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

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

CreateProjectRequest

Request message for method [CreateProject][ntt.devices.v1alpha.CreateProject]

Fields
project
Project

Project resource body

UpdateProjectRequest

Request message for method [UpdateProject][ntt.devices.v1alpha.UpdateProject]

Fields
project
Project

Project resource body

update_mask
.google.protobuf.FieldMask

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

DeleteProjectRequest

Request message for method [DeleteProject][ntt.devices.v1alpha.DeleteProject]

Fields
name
string

Reference of ntt.devices.v1alpha.Project

Device

Device Resource

Fields
name
string

Name of Device

metadata
.ntt.types.Meta

Metadata of Device

spec
Device.Spec

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

status
Device.Status

Status of the Device reported from the actual device.

public_listing_spec
Device.PublicListingSpec
display_name
string

Display name for the device

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

ProvisionServiceAccountToDevice
rpc ProvisionServiceAccountToDevice(ProvisionServiceAccountToDeviceRequest) returns (ProvisionServiceAccountToDeviceResponse)

ProvisionServiceAccountToDevice

RemoveServiceAccountFromDevice
rpc RemoveServiceAccountFromDevice(RemoveServiceAccountFromDeviceRequest) returns (RemoveServiceAccountFromDeviceResponse)

RemoveServiceAccountFromDevice

ListenForConnections
rpc ListenForConnections(ListenForConnectionsRequest) returns (ListenForConnectionsResponse)

ListenForConnections

OpenConnectionChannelSocket
rpc OpenConnectionChannelSocket(OpenConnectionChannelSocketRequest) returns (OpenConnectionChannelSocketResponse)

OpenConnectionChannelSocket

ConnectToDevice
rpc ConnectToDevice(ConnectToDeviceRequest) returns (ConnectToDeviceResponse)

ConnectToDevice

Messages

Device.Spec
Fields
service_account
string

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.

os_version
string

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.

net_config
Device.Spec.NetworkConfig
net_config_mode
string
os_image_url
string

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

ssh_config
Device.Spec.SSHConfig
Device.Spec.NetworkConfig

NetworkConfig defines the network configuration of the Device. These fields are subset of the netplan configuration.

Fields
version
int32
ethernets
repeated Device.Spec.NetworkConfig.EthOpts
wifis
repeated Device.Spec.NetworkConfig.WifiOpts
bridges
repeated Device.Spec.NetworkConfig.BridgesOpts
bonds
repeated Device.Spec.NetworkConfig.BondsOpts
tunnels
repeated Device.Spec.NetworkConfig.TunnelsOpts
vlans
repeated Device.Spec.NetworkConfig.VlansOpts
Device.Spec.NetworkConfig.CommonOpts
Fields
renderer
string
dhcp4
bool
dhcp6
bool
ipv6_privacy
bool
link_local
repeated string
critical
bool
dhcp_identifier
string
dhcp4_overrides
Device.Spec.NetworkConfig.CommonOpts.DHCPOverrides
dhcp6_overrides
Device.Spec.NetworkConfig.CommonOpts.DHCPOverrides
accept_ra
bool
addresses
repeated string
gateway4
string
gateway6
string
nameservers
Device.Spec.NetworkConfig.CommonOpts.Nameservers
macaddress
string
mtu
int32
optional
bool
optional_addresses
repeated string
routes
repeated Device.Spec.NetworkConfig.CommonOpts.Routes
routing_policy
Device.Spec.NetworkConfig.CommonOpts.RoutingPolicy
auth
Device.Spec.NetworkConfig.CommonOpts.Auth
Device.Spec.NetworkConfig.CommonOpts.DHCPOverrides
Fields
use_dns
bool
use_ntp
bool
send_hostname
bool
use_hostname
bool
use_mtu
bool
hostname
string
use_routes
bool
route_metric
string
Device.Spec.NetworkConfig.CommonOpts.Nameservers
Fields
search
repeated string
addresses
repeated string
Device.Spec.NetworkConfig.CommonOpts.Routes
Fields
from
string
to
string
via
string
on_link
bool
metric
int32
type
string
scope
string
table
int32
Device.Spec.NetworkConfig.CommonOpts.RoutingPolicy
Fields
from
string
to
string
table
int32
priority
int32
mark
int32
type_of_service
int32
Device.Spec.NetworkConfig.CommonOpts.Auth
Fields
key
string
password
string
method
string
identity
string
anonymous_identity
string
ca_certificate
string
client_certificate
string
client_key
string
client_key_password
string
Device.Spec.NetworkConfig.EthOpts
Fields
match
Device.Spec.NetworkConfig.EthOpts.Match
set_name
string
wakeonlan
bool
opts
Device.Spec.NetworkConfig.CommonOpts
name
string
Device.Spec.NetworkConfig.EthOpts.Match
Fields
name
string
macaddress
string
driver
string
Device.Spec.NetworkConfig.WifiOpts
Fields
match
Device.Spec.NetworkConfig.WifiOpts.Match
set_name
string
wakeonlan
bool
opts
Device.Spec.NetworkConfig.CommonOpts
access_points
repeated Device.Spec.NetworkConfig.WifiOpts.AccessPoint
name
string
Device.Spec.NetworkConfig.WifiOpts.Match
Fields
name
string
macaddress
string
driver
string
Device.Spec.NetworkConfig.WifiOpts.AccessPoint
Fields
name
string
password
string
mode
string
Device.Spec.NetworkConfig.BridgesOpts
Fields
opts
Device.Spec.NetworkConfig.CommonOpts
interfaces
repeated string
parameters
Device.Spec.NetworkConfig.BridgesOpts.Parameters
name
string
Device.Spec.NetworkConfig.BridgesOpts.Parameters
Fields
ageing_time
int32
priority
int32
port_priority
int32
forward_delay
int32
hello_time
int32
max_age
int32
path_cost
int32
stp
bool
Device.Spec.NetworkConfig.BondsOpts
Fields
opts
Device.Spec.NetworkConfig.CommonOpts
interfaces
repeated string
parameters
Device.Spec.NetworkConfig.BondsOpts.Parameters
name
string
Device.Spec.NetworkConfig.BondsOpts.Parameters
Fields
mode
string
lacp_rate
int32
mii_monitor_interval
int32
min_links
int32
transmit_hash_policy
int32
ad_select
int32
all_slaves_active
int32
arp_ip_targets
bool
arp_validate
string
arp_all_targets
string
up_delay
string
fail_over_mac_policy
string
gratuitous_arp
int32
packets_per_slave
string
primary_reselect_policy
string
resend_igmp
string
learn_packet_interval
string
primary
string
Device.Spec.NetworkConfig.TunnelsOpts
Fields
opts
Device.Spec.NetworkConfig.CommonOpts
mode
string
local
string
remote
string
key
int32
name
string
Device.Spec.NetworkConfig.TunnelsOpts.Key
Fields
input
int32
output
int32
Device.Spec.NetworkConfig.VlansOpts
Fields
opts
Device.Spec.NetworkConfig.CommonOpts
id
int32
link
string
name
string
Device.Spec.SSHConfig

SSHConfig defines the ssh configuration for the Device.

Fields
disable_ssh_server
bool
disable_ssh_password
bool
ssh_authorized
repeated Device.Spec.SSHConfig.AuthKey
ip_allow_list
repeated string
ip_deny_list
repeated string
reject_period
.google.protobuf.Duration
disable_ssh_authkey
bool
Device.Spec.SSHConfig.AuthKey
Fields
ssha_key
string
cert_authority
bool
command
string
environment
string
from
string
no_agent_forwarding
bool
no_port_forwarding
bool
no_pty
bool
no_user_rc
bool
no_x11_forwarding
bool
permitopen
string
principals
string
tunnel
string
restrict
bool
Device.Status
Fields
addresses
repeated Device.Status.Address

List of network addresses.

conditions
repeated Device.Status.Condition

List of conditions of the Device.

device_info
Device.Status.DeviceInfo

Device detailed information

Device.Status.Address

Interface addresses of the Device.

Fields
address
string

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

type
string

Always InternalIP

Device.Status.Condition

Condition holds status of each sub component or module of the device.

Fields
message
string

The message describes the status.

reason
string

The reason for the status.

status
string

The status name.

type
string

Type name of the status.

last_heart_beat_time
.google.protobuf.Timestamp

When the status has been updated last time.

last_transition_time
.google.protobuf.Timestamp

When the status has tuned into the current value.

Device.Status.DeviceInfo

Device Information

Fields
architecture
string

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

operating_system
string

Base OS name (e.g. Linux)

kernel_version
string

OS kernel version

os_image
string

OS base Image name

container_runtime_version
string

Not used

os_version
string

Liquid OS version currently used.

driver
string

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

hardware_information
Device.Status.DeviceInfo.HardwareInformation
Device.Status.DeviceInfo.HardwareInformation
Fields
os
Device.Status.DeviceInfo.HardwareInformation.OS
bios
Device.Status.DeviceInfo.HardwareInformation.BIOS
system
Device.Status.DeviceInfo.HardwareInformation.System
cpu
Device.Status.DeviceInfo.HardwareInformation.CPU
block
Device.Status.DeviceInfo.HardwareInformation.Block
network
Device.Status.DeviceInfo.HardwareInformation.Network
gpu
Device.Status.DeviceInfo.HardwareInformation.GPU
memory_info
Device.Status.DeviceInfo.HardwareInformation.MemoryInfo
Device.Status.DeviceInfo.HardwareInformation.Capability
Fields
name
string
description
string
Device.Status.DeviceInfo.HardwareInformation.OS
Fields
operating_system
string
kernel_version
string
os_image
string
container_runtime_version
string
Device.Status.DeviceInfo.HardwareInformation.BIOS

TODO: Add capabilities and size

Fields
vendor
string
bios_version
string
release_date
string
Device.Status.DeviceInfo.HardwareInformation.System
Fields
manufacturer
string
product_name
string
version
string
serial_number
string
configuration
Device.Status.DeviceInfo.HardwareInformation.System.Configuration
Device.Status.DeviceInfo.HardwareInformation.System.Configuration
Fields
chassis
string
uuid
string
sku_number
string
family
string
Device.Status.DeviceInfo.HardwareInformation.CPU
Fields
processors
repeated Device.Status.DeviceInfo.HardwareInformation.CPU.Processor
Device.Status.DeviceInfo.HardwareInformation.CPU.Processor
Fields
vendor
string
model
string
capabilities
repeated Device.Status.DeviceInfo.HardwareInformation.Capability
num_threads
uint32s
num_cores
uint32s
num_enabled_cores
uint32s
name
string
serial
string
frequency_mhz
int64
max_frequency_mhz
int64
cache_info
repeated Device.Status.DeviceInfo.HardwareInformation.CPU.Processor.Cache
Device.Status.DeviceInfo.HardwareInformation.CPU.Processor.Cache
Fields
type
string
size_bytes
int64
Device.Status.DeviceInfo.HardwareInformation.Block
Fields
disks
repeated Device.Status.DeviceInfo.HardwareInformation.Block.Disk
Device.Status.DeviceInfo.HardwareInformation.Block.Disk
Fields
name
string
size_bytes
int64
drive_type
string
vendor
string
model
string
serial_number
string
wwn
string
partitions
repeated Device.Status.DeviceInfo.HardwareInformation.Block.Disk.Partition
Device.Status.DeviceInfo.HardwareInformation.Block.Disk.Partition
Fields
name
string
size_bytes
int64
mount_point
string
type
string
Device.Status.DeviceInfo.HardwareInformation.Network
Fields
nics
repeated Device.Status.DeviceInfo.HardwareInformation.Network.NIC
Device.Status.DeviceInfo.HardwareInformation.Network.NIC
Fields
name
string
mac_address
string
virtual
bool
description
string
product_name
string
vendor
string
subvendor
string
setting
string
Device.Status.DeviceInfo.HardwareInformation.GPU
Fields
graphic_cards
repeated Device.Status.DeviceInfo.HardwareInformation.GPU.GraphicCard
Device.Status.DeviceInfo.HardwareInformation.GPU.GraphicCard
Fields
index
int64
device
Device.Status.DeviceInfo.HardwareInformation.PCIDevice
Device.Status.DeviceInfo.HardwareInformation.PCIDevice

Revisit: May be just device ??

Fields
address
string
vendor
string
product
string
name
string
subvendor
string
Device.Status.DeviceInfo.HardwareInformation.MemoryInfo
Fields
memory
repeated Device.Status.DeviceInfo.HardwareInformation.MemoryInfo.Memory
Device.Status.DeviceInfo.HardwareInformation.MemoryInfo.Memory
Fields
description
string
size_bytes
int64
memory_banks
repeated Device.Status.DeviceInfo.HardwareInformation.MemoryInfo.Memory.MemoryBank
Device.Status.DeviceInfo.HardwareInformation.MemoryInfo.Memory.MemoryBank
Fields
description
string
product
string
vendor
string
serial
string
slot
string
size_bytes
int64
frequency_hz
int64
width_bits
int32
Device.PublicListingSpec
Fields
enabled
bool
field_mask
Device.PublicListingSpec.TmpFieldMask
Device.PublicListingSpec.TmpFieldMask
Fields
paths
repeated string
GetDeviceRequest

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

Fields
name
string

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

Fields
parent
string

Optional parent ntt.devices.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.devices.v1alpha.ListDevices]

Fields
parent
string

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

WatchDeviceRequest

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

Fields
name
string

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

Fields
parent
string

Parent reference of ntt.devices.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.devices.v1alpha.CreateDevice]

Fields
parent
string

Parent reference of ntt.devices.v1alpha.Device

device
Device

Device resource body

UpdateDeviceRequest

Request message for method [UpdateDevice][ntt.devices.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.devices.v1alpha.DeleteDevice]

Fields
name
string

Reference of ntt.devices.v1alpha.Device

ProvisionServiceAccountToDeviceRequest

Request message for method [ProvisionServiceAccountToDevice][ntt.devices.v1alpha.ProvisionServiceAccountToDevice]

Fields
name
string

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

ProvisionServiceAccountToDeviceResponse

Response message for method [ProvisionServiceAccountToDevice][ntt.devices.v1alpha.ProvisionServiceAccountToDevice]

Fields
service_account
.ntt.api.ServiceAccount

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

RemoveServiceAccountFromDeviceRequest

Request message for method [RemoveServiceAccountFromDevice][ntt.devices.v1alpha.RemoveServiceAccountFromDevice]

Fields
name
string

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.

RemoveServiceAccountFromDeviceResponse

Response message for method [RemoveServiceAccountFromDevice][ntt.devices.v1alpha.RemoveServiceAccountFromDevice]

Fields
none
ListenForConnectionsRequest

Request message for method [ListenForConnectionsRequest][ntt.devices.v1alpha.ListenForConnectionsRequest] Registers a new session listener (agent) to the endpoint. This method is used by agents on the device and not meant for use of users.

Fields
register_listener
ListenForConnectionsRequest.RegisterListener

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

channel_open_error
ListenForConnectionsRequest.ChannelOpenError

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

keep_alive
ListenForConnectionsRequest.KeepAlive

KeepAlive.

ListenForConnectionsRequest.RegisterListener
Fields
device
string

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

ListenForConnectionsRequest.ChannelOpenError
Fields
channel
string

ID of the channel failed to open.

message
string

Error message.

ListenForConnectionsRequest.KeepAlive
Fields
none
ListenForConnectionsResponse

Request message for method [ListenForConnectionsResponse][ntt.devices.v1alpha.ListenForConnectionsResponse] Responses from the endpoint to session agents.

Fields
channel_requested
ListenForConnectionsResponse.ChannelRequested

Notifies a new channel has been requested by a client.

ListenForConnectionsResponse.ChannelRequested
Fields
channel
string

Channel ID

service
BrokerService

Device service;

arg
string

Initial argument (optional)

OpenConnectionChannelSocketRequest

Request message for method [OpenConnectionChannelSocketRequest][ntt.devices.v1alpha.OpenConnectionChannelSocketRequest] Opens a new socket for a session by agent at an endpoint. This session is usually initiated by the agent who received a ChannelRequested message on a ListenForConnection session. The session is used for data plane to transfer data for a channel between the endpoint and the agent.

Fields
register_socket
OpenConnectionChannelSocketRequest.RegisterSocket

Registers a new socket on the endpoint.

data
bytes

Data from the agent to the endpoint (client).

OpenConnectionChannelSocketRequest.RegisterSocket
Fields
device
string

Device name, to be authenticated/authorized.

channel
string

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

OpenConnectionChannelSocketResponse

Request message for method [OpenConnectionChannelSocketResponse][ntt.devices.v1alpha.OpenConnectionChannelSocketResponse]

Fields
data
bytes

Data from the endpoint (client) to the agent.

ConnectToDeviceRequest

Response message for method [ConnectToDeviceRequest][ntt.devices.v1alpha.ConnectToDeviceRequest] ConnectToDevice connects a local service provided by a Device.

Fields
open_request
ConnectToDeviceRequest.OpenRequest

The initiation message to open a channel to a device.

data
bytes

Any data sent to the device through the endpoint.

ConnectToDeviceRequest.OpenRequest
Fields
device
string

Device name to connect.

service
BrokerService

Device service

arg
string

Initial argument (optional)

ConnectToDeviceResponse

Response message for method [ConnectToDeviceResponse][ntt.devices.v1alpha.ConnectToDeviceResponse]

Fields
open_response
ConnectToDeviceResponse.OpenResponse

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

data
bytes

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

ConnectToDeviceResponse.OpenResponse
Fields
none

ProvisioningPolicy

ProvisioningPolicy defines how new physical devices create Device resources.

Fields
name
string

Name of ProvisioningPolicy

spec
ProvisioningPolicy.Spec
status
ProvisioningPolicy.Status

Operations

GetProvisioningPolicy
rpc GetProvisioningPolicy(GetProvisioningPolicyRequest) returns (ProvisioningPolicy)

GetProvisioningPolicy

BatchGetProvisioningPolicys
rpc BatchGetProvisioningPolicys(BatchGetProvisioningPolicysRequest) returns (BatchGetProvisioningPolicysResponse)

BatchGetProvisioningPolicys

ListProvisioningPolicys
rpc ListProvisioningPolicys(ListProvisioningPolicysRequest) returns (ListProvisioningPolicysResponse)

ListProvisioningPolicys

WatchProvisioningPolicy
rpc WatchProvisioningPolicy(WatchProvisioningPolicyRequest) returns (WatchProvisioningPolicyResponse)

WatchProvisioningPolicy

WatchProvisioningPolicys
rpc WatchProvisioningPolicys(WatchProvisioningPolicysRequest) returns (WatchProvisioningPolicysResponse)

WatchProvisioningPolicys

CreateProvisioningPolicy
rpc CreateProvisioningPolicy(CreateProvisioningPolicyRequest) returns (ProvisioningPolicy)

CreateProvisioningPolicy

UpdateProvisioningPolicy
rpc UpdateProvisioningPolicy(UpdateProvisioningPolicyRequest) returns (ProvisioningPolicy)

UpdateProvisioningPolicy

DeleteProvisioningPolicy
rpc DeleteProvisioningPolicy(DeleteProvisioningPolicyRequest) returns (Empty)

DeleteProvisioningPolicy

ProvisionServiceAccountToProvisioningPolicy
rpc ProvisionServiceAccountToProvisioningPolicy(ProvisionServiceAccountToProvisioningPolicyRequest) returns (ProvisionServiceAccountToProvisioningPolicyResponse)

ProvisionServiceAccountToProvisioningPolicy

RemoveServiceAccountFromProvisioningPolicy
rpc RemoveServiceAccountFromProvisioningPolicy(RemoveServiceAccountFromProvisioningPolicyRequest) returns (RemoveServiceAccountFromProvisioningPolicyResponse)

RemoveServiceAccountFromProvisioningPolicy

ProvisionDeviceViaPolicy
rpc ProvisionDeviceViaPolicy(ProvisionDeviceViaPolicyRequest) returns (ProvisionDeviceViaPolicyResponse)

ProvisionDeviceViaPolicy

RequestProvisioningApproval
rpc RequestProvisioningApproval(RequestProvisioningApprovalRequest) returns (RequestProvisioningApprovalResponse)

RequestProvisioningApproval

Messages

ProvisioningPolicy.Spec
Fields
mode
ProvisioningPolicy.Mode

Provisioning mode.

service_account
string

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

device_name_format
string

Template for device name.

labels
string

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

template
ProvisioningPolicy.Spec.Template

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

identity_field_paths
repeated string

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

ProvisioningPolicy.Spec.Template
Fields
metadata
.ntt.types.Meta
spec
Device.Spec

service_account will be ignored.

public_listing_spec
Device.PublicListingSpec
ProvisioningPolicy.Status
Fields
none
GetProvisioningPolicyRequest

Request message for method [GetProvisioningPolicy][ntt.devices.v1alpha.GetProvisioningPolicy]

Fields
name
string

Reference of ntt.devices.v1alpha.ProvisioningPolicy

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

BatchGetProvisioningPolicysRequest

Request message for method [BatchGetProvisioningPolicys][ntt.devices.v1alpha.BatchGetProvisioningPolicys]

Fields
parent
string

Optional parent ntt.devices.v1alpha.ProvisioningPolicy

names
repeated string

Names of ProvisioningPolicys

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

BatchGetProvisioningPolicysResponse

BatchGetProvisioningPolicysResponse

Fields
provisioning_policys
repeated ProvisioningPolicy

found ProvisioningPolicys

missing
repeated string

list of not found ProvisioningPolicys

ListProvisioningPolicysRequest

Request message for method [ListProvisioningPolicys][ntt.devices.v1alpha.ListProvisioningPolicys]

Fields
parent
string

Parent name of ntt.devices.v1alpha.ProvisioningPolicy

page_size
int32

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

ListProvisioningPolicysResponse

Request message for method [ListProvisioningPolicys][ntt.devices.v1alpha.ListProvisioningPolicys]

Fields
provisioning_policys
repeated ProvisioningPolicy

The list of ProvisioningPolicys

prev_page_token
string

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

next_page_token
string

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

WatchProvisioningPolicyRequest

Request message for method [WatchProvisioningPolicy][ntt.devices.v1alpha.WatchProvisioningPolicy]

Fields
name
string

Reference to ntt.devices.v1alpha.ProvisioningPolicy

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

WatchProvisioningPolicyResponse

WatchProvisioningPolicyResponse

Fields
change
ProvisioningPolicyChange
WatchProvisioningPolicysRequest

Request message for method [WatchProvisioningPolicys][ntt.devices.v1alpha.WatchProvisioningPolicys]

Fields
parent
string

Parent reference of ntt.devices.v1alpha.ProvisioningPolicy

page_size
int32

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

WatchProvisioningPolicysResponse

WatchProvisioningPolicysResponse

Fields
provisioning_policy_changes
repeated ProvisioningPolicyChange

Changes of ProvisioningPolicys

page_token_change
WatchProvisioningPolicysResponse.PageTokenChange

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

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

CreateProvisioningPolicyRequest

Request message for method [CreateProvisioningPolicy][ntt.devices.v1alpha.CreateProvisioningPolicy]

Fields
parent
string

Parent reference of ntt.devices.v1alpha.ProvisioningPolicy

provisioning_policy
ProvisioningPolicy

ProvisioningPolicy resource body

UpdateProvisioningPolicyRequest

Request message for method [UpdateProvisioningPolicy][ntt.devices.v1alpha.UpdateProvisioningPolicy]

Fields
provisioning_policy
ProvisioningPolicy

ProvisioningPolicy resource body

update_mask
.google.protobuf.FieldMask

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

DeleteProvisioningPolicyRequest

Request message for method [DeleteProvisioningPolicy][ntt.devices.v1alpha.DeleteProvisioningPolicy]

Fields
name
string

Reference of ntt.devices.v1alpha.ProvisioningPolicy

ProvisionServiceAccountToProvisioningPolicyRequest

Request message for method [ProvisionServiceAccountToProvisioningPolicy][ntt.devices.v1alpha.ProvisionServiceAccountToProvisioningPolicy]

Fields
name
string

Name of ProvisioningPolicy_Reference

ProvisionServiceAccountToProvisioningPolicyResponse

Response message for method [ProvisionServiceAccountToProvisioningPolicy][ntt.devices.v1alpha.ProvisionServiceAccountToProvisioningPolicy]

Fields
service_account
.ntt.api.ServiceAccount
RemoveServiceAccountFromProvisioningPolicyRequest

Request message for method [RemoveServiceAccountFromProvisioningPolicyRequest][ntt.devices.v1alpha.RemoveServiceAccountFromProvisioningPolicyRequest]

Fields
name
string

Name of ProvisioningPolicy_Reference

RemoveServiceAccountFromProvisioningPolicyResponse

Response message for method [RemoveServiceAccountFromProvisioningPolicyRequest][ntt.devices.v1alpha.RemoveServiceAccountFromProvisioningPolicyRequest]

Fields
removed
bool
ProvisionDeviceViaPolicyRequest

Request message for method [ProvisionDeviceViapolicy][ntt.devices.v1alpha.ProvisionDeviceViaPolicy]

Fields
name
string

Name of ProvisioningPolicy_Reference

device_status
Device.Status
ProvisionDeviceViaPolicyResponse

Response message for method [ProvisionDeviceViaPolicy][ntt.devices.v1alpha.ProvisionDeviceViaPolicy]

Fields
device
Device
service_account
.ntt.api.ServiceAccount
RequestProvisioningApprovalRequest

Request message for method [RequestProvisioningApproval][ntt.devices.v1alpha.RequestProvisioningApproval]

Fields
name
string

Name of ProvisioningPolicy_Reference

RequestProvisioningApprovalResponse

Response message for method [RequestProvisioningApproval][ntt.devices.v1alpha.RequestProvisioningApproval]

Fields
request
ProvisioningApprovalRequest
service_account
.ntt.api.ServiceAccount

Enums

ProvisioningPolicy.Mode
Values
MODE_UNSPECIFIED

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

UNATTENDED

Devices will create Device resources automatically without any human interaction.

MANUAL_APPROVAL

Devices will create ProvisioningApprovalRequests so that users can approve.

ProvisioningApprovalRequest

ProvisioningApprovalRequest is created when a device tries self-provisioning with a ProvisioningPolicy in the manual-approval mode.

Fields
name
string

Name of ProvisioningApprovalRequest

spec
ProvisioningApprovalRequest.Spec
status
ProvisioningApprovalRequest.Status

Operations

GetProvisioningApprovalRequest
rpc GetProvisioningApprovalRequest(GetProvisioningApprovalRequestRequest) returns (ProvisioningApprovalRequest)

GetProvisioningApprovalRequest

BatchGetProvisioningApprovalRequests
rpc BatchGetProvisioningApprovalRequests(BatchGetProvisioningApprovalRequestsRequest) returns (BatchGetProvisioningApprovalRequestsResponse)

BatchGetProvisioningApprovalRequests

ListProvisioningApprovalRequests
rpc ListProvisioningApprovalRequests(ListProvisioningApprovalRequestsRequest) returns (ListProvisioningApprovalRequestsResponse)

ListProvisioningApprovalRequests

WatchProvisioningApprovalRequest
rpc WatchProvisioningApprovalRequest(WatchProvisioningApprovalRequestRequest) returns (WatchProvisioningApprovalRequestResponse)

WatchProvisioningApprovalRequest

WatchProvisioningApprovalRequests
rpc WatchProvisioningApprovalRequests(WatchProvisioningApprovalRequestsRequest) returns (WatchProvisioningApprovalRequestsResponse)

WatchProvisioningApprovalRequests

CreateProvisioningApprovalRequest
rpc CreateProvisioningApprovalRequest(CreateProvisioningApprovalRequestRequest) returns (ProvisioningApprovalRequest)

CreateProvisioningApprovalRequest

UpdateProvisioningApprovalRequest
rpc UpdateProvisioningApprovalRequest(UpdateProvisioningApprovalRequestRequest) returns (ProvisioningApprovalRequest)

UpdateProvisioningApprovalRequest

DeleteProvisioningApprovalRequest
rpc DeleteProvisioningApprovalRequest(DeleteProvisioningApprovalRequestRequest) returns (Empty)

DeleteProvisioningApprovalRequest

ProvisionDeviceForApprovedRequest
rpc ProvisionDeviceForApprovedRequest(ProvisionDeviceForApprovedRequestRequest) returns (ProvisionDeviceForApprovedRequestResponse)

ProvisionDeviceForApprovedRequest

Messages

ProvisioningApprovalRequest.Spec
Fields
conclusion
ProvisioningApprovalRequest.Spec.Conclusion

The verdicit for the approval, approved or revoked.

service_account
string

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.

ProvisioningApprovalRequest.Status
Fields
none
GetProvisioningApprovalRequestRequest

Request message for method [GetProvisioningApprovalRequest][ntt.devices.v1alpha.GetProvisioningApprovalRequest]

Fields
name
string

Reference of ntt.devices.v1alpha.ProvisioningApprovalRequest

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

BatchGetProvisioningApprovalRequestsRequest

Request message for method [BatchGetProvisioningApprovalRequests][ntt.devices.v1alpha.BatchGetProvisioningApprovalRequests]

Fields
parent
string

Optional parent ntt.devices.v1alpha.ProvisioningApprovalRequest

names
repeated string

Names of ProvisioningApprovalRequests

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

BatchGetProvisioningApprovalRequestsResponse

BatchGetProvisioningApprovalRequestsResponse

Fields
provisioning_approval_requests
repeated ProvisioningApprovalRequest

found ProvisioningApprovalRequests

missing
repeated string

list of not found ProvisioningApprovalRequests

ListProvisioningApprovalRequestsRequest

Request message for method [ListProvisioningApprovalRequests][ntt.devices.v1alpha.ListProvisioningApprovalRequests]

Fields
parent
string

Parent name of ntt.devices.v1alpha.ProvisioningApprovalRequest

page_size
int32

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

ListProvisioningApprovalRequestsResponse

Request message for method [ListProvisioningApprovalRequests][ntt.devices.v1alpha.ListProvisioningApprovalRequests]

Fields
provisioning_approval_requests
repeated ProvisioningApprovalRequest

The list of ProvisioningApprovalRequests

prev_page_token
string

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

next_page_token
string

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

WatchProvisioningApprovalRequestRequest

Request message for method [WatchProvisioningApprovalRequest][ntt.devices.v1alpha.WatchProvisioningApprovalRequest]

Fields
name
string

Reference to ntt.devices.v1alpha.ProvisioningApprovalRequest

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

WatchProvisioningApprovalRequestResponse

WatchProvisioningApprovalRequestResponse

Fields
change
ProvisioningApprovalRequestChange
WatchProvisioningApprovalRequestsRequest

Request message for method [WatchProvisioningApprovalRequests][ntt.devices.v1alpha.WatchProvisioningApprovalRequests]

Fields
parent
string

Parent reference of ntt.devices.v1alpha.ProvisioningApprovalRequest

page_size
int32

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

WatchProvisioningApprovalRequestsResponse

WatchProvisioningApprovalRequestsResponse

Fields
provisioning_approval_request_changes
repeated ProvisioningApprovalRequestChange

Changes of ProvisioningApprovalRequests

page_token_change
WatchProvisioningApprovalRequestsResponse.PageTokenChange

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

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

CreateProvisioningApprovalRequestRequest

Request message for method [CreateProvisioningApprovalRequest][ntt.devices.v1alpha.CreateProvisioningApprovalRequest]

Fields
parent
string

Parent reference of ntt.devices.v1alpha.ProvisioningApprovalRequest

provisioning_approval_request
ProvisioningApprovalRequest

ProvisioningApprovalRequest resource body

UpdateProvisioningApprovalRequestRequest

Request message for method [UpdateProvisioningApprovalRequest][ntt.devices.v1alpha.UpdateProvisioningApprovalRequest]

Fields
provisioning_approval_request
ProvisioningApprovalRequest

ProvisioningApprovalRequest resource body

update_mask
.google.protobuf.FieldMask

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

DeleteProvisioningApprovalRequestRequest

Request message for method [DeleteProvisioningApprovalRequest][ntt.devices.v1alpha.DeleteProvisioningApprovalRequest]

Fields
name
string

Reference of ntt.devices.v1alpha.ProvisioningApprovalRequest

ProvisionDeviceForApprovedRequestRequest

Request message for method [ProvisionDeviceForApprovedRequest][ntt.devices.v1alpha.ProvisionDeviceForApprovedRequest]

Fields
name
string

Name of ProvisioningApprovalRequest_Reference

device_status
Device.Status
ProvisionDeviceForApprovedRequestResponse

Response message for method [ProvisionDeviceForApprovedRequest][ntt.devices.v1alpha.ProvisionDeviceForApprovedRequest]

Fields
device
Device

Enums

ProvisioningApprovalRequest.Spec.Conclusion
Values
CONCLUSION_NOT_SPECIFIED
APPROVED
REVOKED

Shared Resources

Operations
ListPublicDevices
rpc ListPublicDevices(ListPublicDevicesRequest) returns (ListPublicDevicesResponse)

ListPublicDevices

Messages
Config
Fields
common_config
.ntt.environment.server.ServerEnvironment
redis_endpoint
string
os_releases_location
Config.OSReleasesLocation
Config.OSReleasesLocation
Fields
base_url
string
dedicated_path
string
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.

ListPublicDevicesRequest

Request message for method [ListPublicDevices][ntt.devices.v1alpha.ListPublicDevices]

Fields
parent
string

Name of Project_Reference

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

ListPublicDevicesResponse

Response message for method [ListPublicDevices][ntt.devices.v1alpha.ListPublicDevices]

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

LogsService
Fields
none
LogsService.ToClient

Messages sent only to a client

Fields
data
bytes

Logs data

LogsService.ToDevice

Messages sent only to a device

Fields
follow
bool

Live follow the logs service

lines
uint32s

Number of lines to get from the logs service

source
string

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

PodManagementService
Fields
command
PodManagementService.PodState

Pod state command

pod
string

Pod to execute the command on

ProjectChange

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

Fields
added
ProjectChange.Added

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

modified
ProjectChange.Modified

Modified is returned when watched document is modified

removed
ProjectChange.Removed

Removed is returned when Project is deleted or leaves Query view

ProjectChange.Added

Project has been added to query view

Fields
project
Project
view_index
int32

Integer describing index of added Project in resulting query view.

ProjectChange.Modified

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

Fields
name
string

Name of modified Project

project
Project

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

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 Project. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Project new index in resulting query view.

ProjectChange.Removed

Removed is returned when Project is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Project index.

ProvisioningApprovalRequestChange

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

Fields
added
ProvisioningApprovalRequestChange.Added

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

modified
ProvisioningApprovalRequestChange.Modified

Modified is returned when watched document is modified

removed
ProvisioningApprovalRequestChange.Removed

Removed is returned when ProvisioningApprovalRequest is deleted or leaves Query view

ProvisioningApprovalRequestChange.Added

ProvisioningApprovalRequest has been added to query view

Fields
provisioning_approval_request
ProvisioningApprovalRequest
view_index
int32

Integer describing index of added ProvisioningApprovalRequest in resulting query view.

ProvisioningApprovalRequestChange.Modified

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

Fields
name
string

Name of modified ProvisioningApprovalRequest

provisioning_approval_request
ProvisioningApprovalRequest

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

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 ProvisioningApprovalRequest. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying ProvisioningApprovalRequest new index in resulting query view.

ProvisioningApprovalRequestChange.Removed

Removed is returned when ProvisioningApprovalRequest is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed ProvisioningApprovalRequest index.

ProvisioningPolicyChange

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

Fields
added
ProvisioningPolicyChange.Added

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

modified
ProvisioningPolicyChange.Modified

Modified is returned when watched document is modified

removed
ProvisioningPolicyChange.Removed

Removed is returned when ProvisioningPolicy is deleted or leaves Query view

ProvisioningPolicyChange.Added

ProvisioningPolicy has been added to query view

Fields
provisioning_policy
ProvisioningPolicy
view_index
int32

Integer describing index of added ProvisioningPolicy in resulting query view.

ProvisioningPolicyChange.Modified

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

Fields
name
string

Name of modified ProvisioningPolicy

provisioning_policy
ProvisioningPolicy

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

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 ProvisioningPolicy. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying ProvisioningPolicy new index in resulting query view.

ProvisioningPolicyChange.Removed

Removed is returned when ProvisioningPolicy is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed ProvisioningPolicy index.

SCPService
Fields
dir
SCPService.CreateDirectory

Request to create a directory

file
SCPService.CreateFile

Request to create a file

eot
bool

Request to end SCP transfer

config
SCPService.Configure

Request SCP configuration

SCPService.Configure
Fields
recursive
bool
direction
SCPService.Configure.Direction
path
string
SCPService.CreateDirectory
Fields
path
string
mode
uint32s
SCPService.CreateFile
Fields
init
SCPService.CreateFile.Initialize

Request file initialization

data
bytes

Request file data

eof
bool

Request to end file transfer

SCPService.CreateFile.Initialize
Fields
path
string
mode
uint32s
size
uint64
SSHService
Fields
none
SSHService.ClientIn
Fields
data
bytes
SSHService.ClientOut
Fields
data
bytes
ssh_hello
SSHService.Hello
ssh_resize_terminal
SSHService.TerminalSize
SSHService.Hello
Fields
user
string
command
repeated string
SSHService.TerminalSize
Fields
width
uint32s
height
uint32s
SystemStateService
Fields
none

Enums

BrokerService

Broker dedicated messages

Values
BROKER_SERVICE_UNSPECIFIED

Service type not specified

BROKER_SERVICE_SSH_LEGACY

SSH service

BROKER_SERVICE_SSH
BROKER_SERVICE_TCP_FORWARD_PORT

TCP port forward service

BROKER_SERVICE_REBOOT

Reboot service

BROKER_SERVICE_SHUTDOWN

Shutdown service

BROKER_SERVICE_SCP

SCP service

BROKER_SERVICE_SCP_LEGACY
BROKER_SYS_LOGS

System Logs service

BROKER_APP_LOGS

Application (Container) Logs service

BROKER_POD_MANAGEMENT

Pod State Management service

PodManagementService.PodState

Commands for pod state management

Values
UNSPECIFIED

Unspecified pod state

START

Start the pod

STOP

Stop the pod

RESTART

Restart the pod

SCPService.Configure.Direction
Values
DOWNLOAD
UPLOAD
SystemStateService.SystemState

Commands for system state management

Values