Package spectrum.sas.portal.v1alpha1

Índice

Clientes

Serviço que gerencia clientes do SAS.

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Retorna um customer solicitado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ListCustomers

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Retorna uma lista de customers solicitadas.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
UpdateCustomer

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Atualiza um customer existente.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email

DeviceManager

Serviço que gerencia dispositivos de serviço de rádio de banda larga dos cidadãos.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Crie um novo deployment.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Cria um device em um node ou customer.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
CreateNode

rpc CreateNode(CreateNodeRequest) returns (Node)

Crie um novo node.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
CreateSignedDevice

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

Cria um device assinado em um node ou customer.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Exclui um deployment.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Exclui um device.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
DeleteNode

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Exclui um node.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
GenerateSecret

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Gera um secret para ser usado com o ValidateInstaller.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Retorna um deployment solicitado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Recebe detalhes sobre um device.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
GetNode

rpc GetNode(GetNodeRequest) returns (Node)

Retorna um node solicitado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Lista deployments.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Lista devices em um node ou customer.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ListNodes

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Lista nodes.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
MoveDeployment

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Move um deployment para outro node ou customer.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
MoveDevice

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Move um device para outro node ou customer.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
MoveNode

rpc MoveNode(MoveNodeRequest) returns (Operation)

Move um node para outro node ou customer.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
SignDevice

rpc SignDevice(SignDeviceRequest) returns (Empty)

Assina um device.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Atualiza um deployment existente.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
UpdateDevice

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Atualiza um device.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
UpdateNode

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Atualiza um node existente.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
UpdateSignedDevice

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Atualiza um device assinado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ValidateInstaller

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Valida a identidade de um instalador profissional certificado (CPI, na sigla em inglês).

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email

PolicyService

Serviço de controle de acesso ao gerenciador de recursos de espectro.

GetPolicy

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Busca a política de controle de acesso de um recurso. Retornará uma política vazia se o recurso estiver presente e não tiver um conjunto de políticas.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
SetPolicy

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Define a política de controle de acesso no recurso especificado. Substitui qualquer política existente.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email
TestPermissions

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Retorna permissões do autor da chamada no recurso especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/userinfo.email

Atribuição

Associa members a um role.

Campos
role

string

Obrigatório. Papel atribuído aos members.
members[]

string

As identidades a que a função está atribuída. Pode ter os seguintes valores:

  • {user_email}: um endereço de e-mail que representa uma Conta do Google específica. Por exemplo, alice@gmail.com.

  • {group_email}: um endereço de e-mail que representa um grupo do Google. Por exemplo, viewers@gmail.com.

BillingMode

Modo de faturamento de um CBSD

Enums
BILLING_MODE_UNSPECIFIED O modo de faturamento não foi especificado.
MOBILE O preço é baseado na categoria do CBSD: categoria A, categoria B registrada com SAS.
FIXED_WIRELESS O preço é baseado no tipo de CBSD: estação base ou CPE.

ChannelType

Enums
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Solicitação de CreateDeployment.

Campos
parent

string

Obrigatório. O nome do recurso pai em que a implantação será criada.
deployment

Deployment

Obrigatório. Os detalhes da implantação. O name precisa estar vazio. Ele é gerado pelo servidor. A implantação display_name precisa ser definida.

CreateDeviceRequest

Solicitação de CreateDevice.

Campos
parent

string

Obrigatório. O nome do recurso pai.
device

Device

Os detalhes do registro device. O name precisa estar vazio. Ele é gerado pelo servidor. Os campos fcc_id e serial_number de device precisam ser definidos. O campo user_id precisa ser definido.

CreateNodeRequest

Solicitação de CreateNode.

Campos
parent

string

Obrigatório. O nome do recurso pai em que o nó será criado.
node

Node

Os detalhes do nó. O name precisa estar vazio. Ele é gerado pelo servidor. O nó display_name precisa ser definido.

CreateSignedDeviceRequest

Solicitação de CreateSignedDevice.

Campos
parent

string

Obrigatório. O nome do recurso pai.
encoded_device

bytes

Obrigatório. JSON Web Token assinado usando uma chave privada de CPI. O payload precisa ser a codificação JSON do device. O campo user_id precisa ser definido.
installer_id

string

Obrigatório. ID exclusivo do instalador (ID da CPI) do banco de dados de instaladores profissionais certificados.

Cliente

Entidade que representa um cliente do SAS.

Campos
name

string

Apenas saída. Nome do recurso do cliente.
display_name

string

Obrigatório. Nome da organização que a entidade do cliente representa.
sas_user_ids[]

string

IDs de usuário usados pelos dispositivos pertencentes a esse cliente.

DeleteDeploymentRequest

Solicitação de DeleteDeployment.

Campos
name

string

Obrigatório. O nome do deployment.

DeleteDeviceRequest

Solicitação de DeleteDevice.

Campos
name

string

Obrigatório. O nome do dispositivo.

DeleteNodeRequest

Solicitação de DeleteNode.

Campos
name

string

Obrigatório. O nome do node.

Implantação

A implantação.

Campos
name

string

Apenas saída. Nome do recurso.
display_name

string

O nome de exibição da implantação.
sas_user_ids[]

string

ID do usuário usado pelos dispositivos pertencentes a essa implantação. Cada implantação precisa estar associada a um User ID exclusivo.
default_billing_mode

BillingMode

Modo de faturamento padrão para a implantação e os dispositivos nela.
allowed_billing_modes[]

BillingMode

Os modos de faturamento permitidos nesta implantação.

Dispositivo

Campos
name

string

Apenas saída. O nome do caminho do recurso.
fcc_id

string

O identificador da FCC do dispositivo.
serial_number

string

Um número de série atribuído ao dispositivo pelo fabricante.
preloaded_config

DeviceConfig

Configuração do dispositivo, conforme especificado pela API do portal do SAS.
active_config

DeviceConfig

Apenas saída. Configuração atual do dispositivo conforme registrado no SAS.
state

State

Apenas saída. Estado do dispositivo.
grants[]

DeviceGrant

Apenas saída. Concessões mantidas pelo dispositivo.
display_name

string

Nome de exibição do dispositivo.
device_metadata

DeviceMetadata

Parâmetros do dispositivo que podem ser substituídos pelo portal do SAS e pelas solicitações de registro do SAS.

Estado

Estado do dispositivo.

Enums
DEVICE_STATE_UNSPECIFIED Estado não especificado.
RESERVED O dispositivo foi criado no portal da SAS, mas ainda não foi registrado na SAS.
REGISTERED O dispositivo foi registrado com o SAS.
DEREGISTERED O dispositivo foi cancelado do registro com o SAS.

DeviceAirInterface

Informações sobre a interface aérea do dispositivo.

Campos
radio_technology

RadioTechnology

Condicional. Este campo especifica a tecnologia de acesso de rádio usada para o CBSD.
supported_spec

string

Opcional. Esse campo está relacionado ao radioTechnology e fornece a especificação da interface aérea com que o CBSD está em conformidade no momento do registro.

RadioTechnology

Os tipos aprovados de tecnologia de acesso por rádio.

Enums
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

Categoria da FCC do dispositivo, conforme definido na Parte 96.

Enums
DEVICE_CATEGORY_UNSPECIFIED Categoria de dispositivo não especificada.
DEVICE_CATEGORY_A Categoria A.
DEVICE_CATEGORY_B Categoria B.

DeviceConfig

Informações sobre a configuração do dispositivo.

Campos
category

DeviceCategory

Categoria do dispositivo de acordo com a FCC.
model

DeviceModel

Informações sobre este modelo de dispositivo.
air_interface

DeviceAirInterface

Informações sobre a interface aérea deste dispositivo.
installation_params

InstallationParams

Parâmetros de instalação do dispositivo.
measurement_capabilities[]

MeasurementCapability

Recursos de relatórios de medição do dispositivo.
user_id

StringValue

O identificador de um usuário do dispositivo.
call_sign

string

O indicativo de chamada do operador do dispositivo.
state

State

Estado da configuração.
is_signed

BoolValue

Apenas saída. Indica se a configuração foi assinada por um CPI.
update_time

Timestamp

Apenas saída. A última vez que a configuração do dispositivo foi editada.

Estado

Estado da configuração do dispositivo. Somente as configurações no estado DEVICE_CONFIG_STATE_FINAL podem ser usadas durante o registro do CBSD.

Enums
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

Concessão de dispositivo. É uma autorização fornecida pelo Sistema de acesso ao espectro a um dispositivo para transmitir usando parâmetros operacionais especificados após um sinal de pulso bem-sucedido do dispositivo.

Campos
max_eirp

DoubleValue

Potência isotrópica irradiada equivalente (EIRP) máxima permitida pela concessão. O EIRP máximo está em unidades de dBm/MHz. O valor de maxEirp representa o EIRP médio (RMS) que seria medido pelo procedimento definido na parte 96.41(e)(3) da FCC.
frequency_range

FrequencyRange

O intervalo de frequência de transmissão.
state

GrantState

Estado da concessão.
channel_type

ChannelType

Tipo de canal usado.
move_list[]

DpaMoveList

As listas de movimentação de DPA em que essa concessão aparece.
expire_time

Timestamp

O prazo de validade da concessão.
suspension_reason[]

string

Se a concessão for suspensa, os motivos da suspensão.
grant_id

string

ID da concessão.

DeviceMetadata

Dados do dispositivo substituíveis pelo Portal do SAS e por solicitações de registro.

DeviceModel

Informações sobre o modelo do dispositivo.

Campos
vendor

string

O nome do fornecedor do dispositivo.
name

string

O nome do modelo do dispositivo.
software_version

string

A versão do software do dispositivo.
hardware_version

string

A versão do hardware do dispositivo.
firmware_version

string

A versão do firmware do dispositivo.

DpaMoveList

Uma entrada na lista de movimentação de um DPA.

Campos
dpa_id

StringValue

O ID da DPA.
frequency_range

FrequencyRange

O intervalo de frequência afetado pela lista de movimentos.

FrequencyRange

Intervalo de frequência de low_frequency a high_frequency.

Campos
low_frequency_mhz

DoubleValue

A menor frequência do intervalo em MHz.
high_frequency_mhz

DoubleValue

A maior frequência do intervalo de frequência em MHz.

GenerateSecretRequest

Solicitação de GenerateSecret.

GenerateSecretResponse

Resposta para GenerateSecret.

Campos
secret

string

O secret gerado pela string e usado por ValidateInstaller.

GetCustomerRequest

Solicitação de GetCustomer .

Campos
name

string

Obrigatório. O nome do customer.

GetDeploymentRequest

Solicitação de GetDeployment.

Campos
name

string

Obrigatório. O nome do deployment.

GetDeviceRequest

Solicitação de GetDevice.

Campos
name

string

Obrigatório. O nome do dispositivo.

GetNodeRequest

Solicitação de GetNode.

Campos
name

string

Obrigatório. O nome do node.

GetPolicyRequest

Solicite uma mensagem para o método GetPolicy.

Campos
resource

string

Obrigatório. O recurso para o qual a política está sendo solicitada.

GrantState

O estado da concessão.

Enums
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED A concessão foi feita, mas o dispositivo não está enviando pulsações nela.
GRANT_STATE_TERMINATED A concessão foi encerrada pelo SAS.
GRANT_STATE_SUSPENDED A concessão foi suspensa pelo SAS.
GRANT_STATE_AUTHORIZED O dispositivo está transmitindo no momento.
GRANT_STATE_EXPIRED A concessão expirou.

HeightType

Especifica como a altura é medida.

Enums
HEIGHT_TYPE_UNSPECIFIED Tipo de altura não especificado.
HEIGHT_TYPE_AGL A altura AGL é medida em relação ao nível do solo.
HEIGHT_TYPE_AMSL A altura AMSL é medida em relação ao nível médio do mar.

InstallationParams

Informações sobre os parâmetros de instalação do dispositivo.

Campos
latitude

DoubleValue

Latitude do local da antena do dispositivo em graus em relação ao datum WGS 84. O intervalo permitido é de -90.000000 a +90.000000. Valores positivos representam latitudes ao norte do equador, e valores negativos representam latitudes ao sul.
longitude

DoubleValue

Longitude do local da antena do dispositivo em graus em relação ao datum WGS 84. O intervalo permitido é de -180.000000 a +180.000000. Valores positivos representam longitudes a leste do meridiano principal, e valores negativos a oeste.
height

DoubleValue

Altura da antena do dispositivo em metros. Quando o valor do parâmetro heightType é "AGL", a altura da antena precisa ser informada em relação ao nível do solo. Quando o valor do parâmetro heightType é "AMSL", ele é fornecido em relação ao datum WGS84.
height_type

HeightType

Especifica como a altura é medida.
horizontal_accuracy

DoubleValue

Um número positivo em metros para indicar a precisão da localização horizontal da antena do dispositivo. Esse parâmetro opcional só deve estar presente se o valor dele for menor que a exigência da FCC de 50 metros.
vertical_accuracy

DoubleValue

Um número positivo em metros para indicar a precisão da localização vertical da antena do dispositivo. Esse parâmetro opcional só deve estar presente se o valor dele for menor que o requisito da FCC de 3 metros.
indoor_deployment

BoolValue

Se a antena do dispositivo está em um ambiente interno ou não. true: indoor. false: outdoor.
antenna_azimuth

Int32Value

Direção de mira do plano horizontal da antena em graus em relação ao norte verdadeiro. O valor desse parâmetro é um número inteiro entre 0 e 359, inclusive. Um valor de 0 grau significa norte verdadeiro, e um valor de 90 graus significa leste. Esse parâmetro é opcional para dispositivos da categoria A e condicional para dispositivos da categoria B.
antenna_downtilt

Int32Value

Inclinação vertical da antena em graus, um número inteiro com um valor entre -90 e +90, inclusive. Um valor negativo significa que a antena está inclinada para cima (acima da horizontal). Esse parâmetro é opcional para dispositivos da categoria A e condicional para dispositivos da categoria B.
antenna_gain

Int32Value

Ganho máximo da antena em dBi. Esse parâmetro é um número inteiro com um valor entre -127 e +128 (dBi), inclusive.
eirp_capability

Int32Value

Esse parâmetro é o EIRP máximo do dispositivo em unidades de dBm/10MHz e é um número inteiro com um valor entre -127 e +47 (dBm/10 MHz), inclusive. Se não for incluído, o SAS vai interpretar como a potência isotrópica radiada equivalente máxima permitida em unidades de dBm/10MHz para a categoria do dispositivo.
antenna_beamwidth

Int32Value

Largura do feixe de antena de 3 dB da antena no plano horizontal em graus. Esse parâmetro é um número inteiro sem sinal com um valor entre 0 e 360 (graus), inclusive. Ele é opcional para dispositivos da categoria A e condicional para dispositivos da categoria B.
antenna_model

string

Se uma antena externa for usada, o modelo dela poderá ser informado neste campo. A string tem um comprimento máximo de 128 octetos.
cpe_cbsd_indication

BoolValue

Se presente, esse parâmetro especifica se o CBSD é um CPE-CBSD ou não.

ListCustomersRequest

Solicitação de ListCustomers.

Campos
page_size

int32

O número máximo de customers a serem retornados na resposta.
page_token

string

Um token de paginação retornou de uma chamada anterior para ListCustomers que indica de onde essa listagem continuará.

ListCustomersResponse

Resposta para ListCustomers.

Campos
customers[]

Customer

A lista de customers que correspondem à solicitação.
next_page_token

string

Um token de paginação retornado de uma chamada anterior para ListCustomers que indica de onde a listagem deve continuar. Se o campo estiver faltando ou vazio, isso significa que não há mais clientes.

ListDeploymentsRequest

Solicitação de ListDeployments.

Campos
parent

string

Obrigatório. O nome do recurso pai, por exemplo, "nodes/1", customer/1/nodes/2.
page_size

int32

O número máximo de implantações a serem retornadas na resposta.
page_token

string

Um token de paginação retornou de uma chamada anterior para ListDeployments que indica de onde essa listagem continuará.
filter

string

A expressão do filtro. O filtro precisa ter o seguinte formato: "DIRECT_CHILDREN" ou "direct_children". O filtro não diferencia maiúsculas de minúsculas. Se estiver vazio, nenhuma implantação será filtrada.

ListDeploymentsResponse

Resposta para ListDeployments.

Campos
deployments[]

Deployment

As deployments que correspondem à solicitação.
next_page_token

string

Um token de paginação retornado de uma chamada anterior para ListDeployments que indica de onde a listagem deve continuar. Se o campo estiver ausente ou vazio, significa que não há mais implantações.

ListDevicesRequest

Solicitação de ListDevices.

Campos
parent

string

Obrigatório. O nome do recurso pai.
page_size

int32

O número máximo de dispositivos a serem retornados na resposta. Se estiver vazio ou for zero, todos os dispositivos serão listados. Precisa estar no intervalo [0, 1000].
page_token

string

Um token de paginação retornou de uma chamada anterior para ListDevices que indica de onde essa listagem continuará.
filter

string

A expressão do filtro. O filtro precisa ter um dos seguintes formatos: "sn=123454" ou "display_name=MyDevice". "sn" corresponde ao número de série do dispositivo. O filtro não diferencia maiúsculas de minúsculas.

ListDevicesResponse

Resposta para ListDevices.

Campos
devices[]

Device

As devices que correspondem à solicitação.
next_page_token

string

Um token de paginação retornado de uma chamada anterior para ListDevices que indica de onde a listagem deve continuar. Se o campo estiver ausente ou vazio, significa que não há mais dispositivos.

ListNodesRequest

Solicitação de ListNodes.

Campos
parent

string

Obrigatório. O nome do recurso pai, por exemplo, "nodes/1".
page_size

int32

O número máximo de nós a serem retornados na resposta.
page_token

string

Um token de paginação retornou de uma chamada anterior para ListNodes que indica de onde essa listagem continuará.
filter

string

A expressão do filtro. O filtro precisa ter o seguinte formato: "DIRECT_CHILDREN" ou "direct_children". O filtro não diferencia maiúsculas de minúsculas. Se estiver vazio, nenhum nó será filtrado.

ListNodesResponse

Resposta para ListNodes.

Campos
nodes[]

Node

As nodes que correspondem à solicitação.
next_page_token

string

Um token de paginação retornado de uma chamada anterior para ListNodes que indica de onde a listagem deve continuar. Se o campo estiver ausente ou vazio, isso significa que não há mais nós.

MeasurementCapability

Capacidade de medição do dispositivo. Os valores são definidos por WINNF-SSC-0002.

Enums
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

Solicitação de MoveDeployment.

Campos
name

string

Obrigatório. O nome do deployment a ser movido.
destination

string

Obrigatório. O nome do novo recurso pai node ou customer para redefinir o pai da implantação.

MoveDeviceRequest

Solicitação de MoveDevice.

Campos
name

string

Obrigatório. O nome do dispositivo a ser movido.
destination

string

Obrigatório. O nome do novo recurso pai node ou customer para redefinir o dispositivo.

MoveNodeRequest

Solicitação de MoveNode.

Campos
name

string

Obrigatório. O nome do node a ser movido.
destination

string

Obrigatório. O nome do novo recurso pai node ou customer em que o nó será redefinido.

Nó

O nó.

Campos
name

string

Apenas saída. Nome do recurso.
display_name

string

O nome de exibição do nó.
sas_user_ids[]

string

IDs de usuário usados pelos dispositivos pertencentes a este nó.

Política

Define uma política de controle de acesso aos recursos.

Campos
assignments[]

Assignment

Lista de assignments
etag

bytes

A ETag é usada para controle de simultaneidade otimista como uma maneira de evitar que atualizações simultâneas de uma política substituam umas às outras. É altamente recomendável que os sistemas usem a ETag no ciclo de leitura-modificação-gravação para realizar atualizações de política e evitar disputas. Uma ETag é retornada na resposta a GetPolicy, e os sistemas precisam colocar essa ETag na solicitação para SetPolicy e garantir que a mudança seja aplicada à mesma versão da política.

Se nenhuma etag for fornecida na chamada a GetPolicy, a política atual será substituída sem verificação.

SetPolicyRequest

Solicite uma mensagem para o método SetPolicy.

Campos
resource

string

Obrigatório. O recurso para que a política está sendo especificada. Essa política substitui qualquer política atual.
policy

Policy

Obrigatório. A política a ser aplicada ao resource.

SignDeviceRequest

Solicitação de SignDevice.

Campos
device

Device

Obrigatório. O device a ser assinado. Os campos device name, fcc_id e serial_number precisam ser definidos. O campo user_id precisa ser definido.

TestPermissionsRequest

Solicite uma mensagem para o método TestPermissions.

Campos
resource

string

Obrigatório. O recurso para o qual as permissões estão sendo solicitadas.
permissions[]

string

O conjunto de permissões a serem verificadas para o resource.

TestPermissionsResponse

Mensagem de resposta para o método TestPermissions.

Campos
permissions[]

string

Um conjunto de permissões que o autor da chamada tem.

UpdateCustomerRequest

Solicitação de UpdateCustomer.

Campos
customer

Customer

Obrigatório. Os novos valores para o customer. O cliente precisa ter name e display_name definidos.
update_mask

FieldMask

Campos a serem atualizados.

UpdateDeploymentRequest

Solicitação de UpdateDeployment.

Campos
deployment

Deployment

Obrigatório. Os novos valores para o deployment. É necessário definir name e display_name.
update_mask

FieldMask

Campos a serem atualizados.

UpdateDeviceRequest

Solicitação de UpdateDevice.

Campos
device

Device

Obrigatório. O device a ser atualizado. Os campos device name, fcc_id e serial_number precisam ser definidos. O campo user_id precisa ser definido.
update_mask

FieldMask

Campos a serem atualizados.

UpdateNodeRequest

Solicitação de UpdateNode.

Campos
node

Node

Obrigatório. Os novos valores para o node. É necessário definir name e display_name.
update_mask

FieldMask

Campos a serem atualizados.

UpdateSignedDeviceRequest

Solicitação de UpdateSignedDevice.

Campos
name

string

Obrigatório. O nome do dispositivo a ser atualizado.
encoded_device

bytes

Obrigatório. O JSON Web Token assinado usando uma chave privada da CPI. O payload precisa ser a codificação JSON do device. O campo user_id precisa ser definido.
installer_id

string

Obrigatório. ID exclusivo do instalador (ID da CPI) do banco de dados de instaladores profissionais certificados.

ValidateInstallerRequest

Solicitação de ValidateInstaller.

Campos
installer_id

string

Obrigatório. ID exclusivo do instalador (ID da CPI) do banco de dados de instaladores profissionais certificados.
secret

string

Obrigatório. Secret retornado pelo GenerateSecret.
encoded_secret

string

Obrigatório. JSON Web Token assinado usando uma chave privada de CPI. O payload precisa incluir uma declaração "secret" cujo valor seja o secret.

ValidateInstallerResponse

Resposta para ValidateInstaller.