Package spectrum.sas.portal.v1alpha1

Indice

Clienti

Servizio di gestione dei clienti SAS.

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Restituisce un customer richiesto.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Restituisce un elenco di customers richiesti.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Aggiorna un customer esistente.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

DeviceManager

Servizio di gestione dei dispositivi Citizens Broadband Radio Service.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Crea un nuovo deployment.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Crea un device in un node o in un customer.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc CreateNode(CreateNodeRequest) returns (Node)

Crea un nuovo node.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

Crea un device firmato in un node o un customer.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Elimina un deployment.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Elimina un device.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Elimina un node.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Genera un secret da utilizzare con ValidateInstaller.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Restituisce un deployment richiesto.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc GetDevice(GetDeviceRequest) returns (Device)

Recupera i dettagli di un device.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc GetNode(GetNodeRequest) returns (Node)

Restituisce un node richiesto.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Elenchi deployments.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Elenchi devices in node o customer.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Elenchi nodes.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Sposta un deployment sotto un altro node o customer.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Sposta un device sotto un altro node o customer.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc MoveNode(MoveNodeRequest) returns (Operation)

Sposta un node sotto un altro node o customer.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc SignDevice(SignDeviceRequest) returns (Empty)

Firma un device.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Aggiorna un deployment esistente.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Aggiorna un device.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Aggiorna un node esistente.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Aggiorna un device firmato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Convalida l'identità di un installatore professionale certificato (CPI).

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

PolicyService

Servizio di controllo dell'accesso a Spectrum Resource Manager.

GetPolicy

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Recupera il criterio di controllo dell'accesso per una risorsa. Restituisce una policy vuota se la risorsa esiste e non è stata impostata una policy.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Imposta il criterio di controllo dell'accesso sulla risorsa specificata. Sostituisce qualsiasi policy esistente.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Restituisce le autorizzazioni di cui dispone un chiamante per la risorsa specificata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Assignment

Associa members a un role.

Campi
role

string

Obbligatorio. Ruolo assegnato a members.

members[]

string

Le identità a cui è assegnato il ruolo. Può avere i seguenti valori:

  • {user_email}: Un indirizzo email che rappresenta un Account Google specifico. Ad esempio: alice@gmail.com.

  • {group_email}: Un indirizzo email che rappresenta un gruppo Google. Ad esempio, viewers@gmail.com.

BillingMode

Modalità di fatturazione di un CBSD

Enum
BILLING_MODE_UNSPECIFIED La modalità di fatturazione non è stata specificata.
MOBILE Il prezzo si basa sulla categoria di CBSD: categoria A, categoria B registrata con SAS.
FIXED_WIRELESS Il prezzo dipende dal tipo di CBSD: stazione base o CPE.

ChannelType

Enum
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Richiesta per CreateDeployment.

Campi
parent

string

Obbligatorio. Il nome della risorsa padre in cui creare il deployment.

deployment

Deployment

Obbligatorio. I dettagli del deployment. name deve essere vuoto. Viene generato dal server. È necessario impostare il deployment display_name.

CreateDeviceRequest

Richiesta per CreateDevice.

Campi
parent

string

Obbligatorio. Il nome della risorsa padre.

device

Device

I dettagli di registrazione di device. name deve essere vuoto. Viene generato dal server. I campi device fcc_id e serial_number devono essere impostati. Il campo user_id deve essere impostato.

CreateNodeRequest

Richiesta per CreateNode.

Campi
parent

string

Obbligatorio. Il nome della risorsa padre in cui creare il nodo.

node

Node

I dettagli del nodo. name deve essere vuoto. Viene generato dal server. È necessario impostare il nodo display_name.

CreateSignedDeviceRequest

Richiesta per CreateSignedDevice.

Campi
parent

string

Obbligatorio. Il nome della risorsa padre.

encoded_device

bytes

Obbligatorio. Token web JSON firmato utilizzando una chiave privata CPI. Il payload deve essere la codifica JSON di device. Il campo user_id deve essere impostato.

installer_id

string

Obbligatorio. ID installatore univoco (ID CPI) dal database degli installatori professionali certificati.

Cliente

Entità che rappresenta un cliente SAS.

Campi
name

string

Solo output. Nome risorsa del cliente.

display_name

string

Obbligatorio. Nome dell'organizzazione che rappresenta la persona giuridica del cliente.

sas_user_ids[]

string

ID utente utilizzati dai dispositivi appartenenti a questo cliente.

DeleteDeploymentRequest

Richiesta per DeleteDeployment.

Campi
name

string

Obbligatorio. Il nome del deployment.

DeleteDeviceRequest

Richiesta per DeleteDevice.

Campi
name

string

Obbligatorio. Il nome del dispositivo.

DeleteNodeRequest

Richiesta per DeleteNode.

Campi
name

string

Obbligatorio. Il nome del node.

Deployment

Deployment.

Campi
name

string

Solo output. Nome della risorsa.

display_name

string

Il nome visualizzato del deployment.

sas_user_ids[]

string

ID utente utilizzato dai dispositivi appartenenti a questo deployment. Ogni deployment deve essere associato a un unico User ID.

default_billing_mode

BillingMode

Modalità di fatturazione predefinita per il deployment e i dispositivi al suo interno.

allowed_billing_modes[]

BillingMode

Le modalità di fatturazione consentite in questo deployment.

Dispositivo

Campi
name

string

Solo output. Il nome del percorso della risorsa.

fcc_id

string

L'identificatore FCC del dispositivo.

serial_number

string

Un numero di serie assegnato al dispositivo dal produttore.

preloaded_config

DeviceConfig

Configurazione del dispositivo, come specificato tramite l'API SAS Portal.

active_config

DeviceConfig

Solo output. Configurazione attuale del dispositivo registrata nel SAS.

state

State

Solo output. Stato del dispositivo.

grants[]

DeviceGrant

Solo output. Concessioni detenute dal dispositivo.

display_name

string

Nome visualizzato del dispositivo.

device_metadata

DeviceMetadata

Parametri del dispositivo che possono essere sostituiti sia dal portale SAS che dalle richieste di registrazione SAS.

Stato

Stato del dispositivo.

Enum
DEVICE_STATE_UNSPECIFIED Stato non specificato.
RESERVED Dispositivo creato nel portale SAS, ma non ancora registrato con SAS.
REGISTERED Dispositivo registrato con SAS.
DEREGISTERED Il dispositivo è stato deregistrato da SAS.

DeviceAirInterface

Informazioni sull'interfaccia aerea del dispositivo.

Campi
radio_technology

RadioTechnology

Condizionale. Questo campo specifica la tecnologia di accesso radio utilizzata per la CBSD.

supported_spec

string

(Facoltativo) Questo campo è correlato a radioTechnology e fornisce la specifica dell'interfaccia aerea a cui il CBSD è conforme al momento della registrazione.

RadioTechnology

I tipi approvati di tecnologia di accesso radio.

Enum
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

Categoria FCC del dispositivo, come definita dalla Parte 96.

Enum
DEVICE_CATEGORY_UNSPECIFIED Categoria del dispositivo non specificata.
DEVICE_CATEGORY_A Categoria A.
DEVICE_CATEGORY_B Categoria B.

DeviceConfig

Informazioni sulla configurazione del dispositivo.

Campi
category

DeviceCategory

Categoria FCC del dispositivo.

model

DeviceModel

Informazioni su questo modello di dispositivo.

air_interface

DeviceAirInterface

Informazioni sull'interfaccia aerea di questo dispositivo.

installation_params

InstallationParams

Parametri di installazione per il dispositivo.

measurement_capabilities[]

MeasurementCapability

Funzionalità di generazione di report sulla misurazione del dispositivo.

user_id

StringValue

L'identificatore di un utente del dispositivo.

call_sign

string

Il nominativo dell'operatore del dispositivo.

state

State

Stato della configurazione.

is_signed

BoolValue

Solo output. Indica se la configurazione è stata firmata da un CPI.

update_time

Timestamp

Solo output. L'ultima volta che è stata modificata la configurazione del dispositivo.

Stato

Stato della configurazione del dispositivo. Durante la registrazione CBSD possono essere utilizzate solo le configurazioni con stato DEVICE_CONFIG_STATE_FINAL.

Enum
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

Concessione del dispositivo. Si tratta di un'autorizzazione fornita dal sistema di accesso allo spettro a un dispositivo per trasmettere utilizzando parametri operativi specificati dopo un heartbeat riuscito del dispositivo.

Campi
max_eirp

DoubleValue

Potenza isotropica irradiata equivalente (EIRP) massima consentita dalla concessione. L'EIRP massimo è espresso in unità di dBm/MHz. Il valore di maxEirp rappresenta l'EIRP medio (RMS) che verrebbe misurato dalla procedura definita nella parte 96.41(e)(3) della FCC.

frequency_range

FrequencyRange

L'intervallo di frequenza di trasmissione.

state

GrantState

Stato della concessione.

channel_type

ChannelType

Tipo di canale utilizzato.

move_list[]

DpaMoveList

Gli elenchi di spostamento del DPA in cui viene visualizzata questa concessione.

expire_time

Timestamp

Il tempo per la scadenza della concessione.

suspension_reason[]

string

Se la sovvenzione è sospesa, il motivo o i motivi della sospensione.

grant_id

string

ID concessione.

DeviceMetadata

Dati del dispositivo sostituibili sia dal Portale SAS sia dalle richieste di registrazione.

DeviceModel

Informazioni sul modello del dispositivo.

Campi
vendor

string

Il nome del fornitore del dispositivo.

name

string

Il nome del modello del dispositivo.

software_version

string

La versione software del dispositivo.

hardware_version

string

La versione hardware del dispositivo.

firmware_version

string

La versione firmware del dispositivo.

DpaMoveList

Una voce nell'elenco di trasferimento di un DPA.

Campi
dpa_id

StringValue

L'ID del DPA.

frequency_range

FrequencyRange

L'intervallo di frequenza interessato dall'elenco di spostamento.

FrequencyRange

Intervallo di frequenza da low_frequency a high_frequency.

Campi
low_frequency_mhz

DoubleValue

La frequenza più bassa dell'intervallo di frequenza in MHz.

high_frequency_mhz

DoubleValue

La frequenza più alta della gamma di frequenza in MHz.

GenerateSecretRequest

Richiesta per GenerateSecret.

GenerateSecretResponse

Risposta per GenerateSecret.

Campi
secret

string

Il secret generato dalla stringa e utilizzato da ValidateInstaller.

GetCustomerRequest

Richiesta per GetCustomer .

Campi
name

string

Obbligatorio. Il nome del customer.

GetDeploymentRequest

Richiesta per GetDeployment.

Campi
name

string

Obbligatorio. Il nome del deployment.

GetDeviceRequest

Richiesta per GetDevice.

Campi
name

string

Obbligatorio. Il nome del dispositivo.

GetNodeRequest

Richiesta per GetNode.

Campi
name

string

Obbligatorio. Il nome del node.

GetPolicyRequest

Messaggio di richiesta per il metodo GetPolicy.

Campi
resource

string

Obbligatorio. La risorsa per cui viene richiesta la policy.

GrantState

Lo stato della concessione.

Enum
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED La concessione è stata concessa, ma il dispositivo non invia heartbeat.
GRANT_STATE_TERMINATED La concessione è stata interrotta dal SAS.
GRANT_STATE_SUSPENDED La sovvenzione è stata sospesa dal SAS.
GRANT_STATE_AUTHORIZED Il dispositivo sta trasmettendo.
GRANT_STATE_EXPIRED La concessione è scaduta.

HeightType

Specifica come viene misurata l'altezza.

Enum
HEIGHT_TYPE_UNSPECIFIED Tipo di altezza non specificato.
HEIGHT_TYPE_AGL L'altezza AGL viene misurata rispetto al livello del suolo.
HEIGHT_TYPE_AMSL L'altezza AMSL viene misurata rispetto al livello medio del mare.

InstallationParams

Informazioni sui parametri di installazione del dispositivo.

Campi
latitude

DoubleValue

Latitudine della posizione dell'antenna del dispositivo in gradi rispetto al datum WGS 84. L'intervallo consentito è compreso tra -90.000000 e +90.000000. I valori positivi rappresentano le latitudini a nord dell'equatore, i valori negativi quelle a sud.

longitude

DoubleValue

Longitudine della posizione dell'antenna del dispositivo in gradi rispetto al sistema di riferimento WGS 84. L'intervallo consentito è compreso tra -180.000000 e +180.000000. I valori positivi rappresentano le longitudini a est del meridiano zero, i valori negativi quelle a ovest.

height

DoubleValue

Altezza dell'antenna del dispositivo in metri. Quando il valore del parametro heightType è "AGL", l'altezza dell'antenna deve essere indicata rispetto al livello del suolo. Quando il valore del parametro heightType è "AMSL", viene fornito rispetto al datum WGS84.

height_type

HeightType

Specifica come viene misurata l'altezza.

horizontal_accuracy

DoubleValue

Un numero positivo in metri che indica la precisione della posizione orizzontale dell'antenna del dispositivo. Questo parametro facoltativo deve essere presente solo se il suo valore è inferiore al requisito della FCC di 50 metri.

vertical_accuracy

DoubleValue

Un numero positivo in metri che indica la precisione della posizione verticale dell'antenna del dispositivo. Questo parametro facoltativo deve essere presente solo se il suo valore è inferiore al requisito FCC di 3 metri.

indoor_deployment

BoolValue

Indica se l'antenna del dispositivo è interna o meno. true: interno. false: esterno.

antenna_azimuth

Int32Value

Direzione di puntamento del piano orizzontale dell'antenna in gradi rispetto al nord geografico. Il valore di questo parametro è un numero intero compreso tra 0 e 359 inclusi. Un valore di 0 gradi indica il nord geografico, mentre un valore di 90 gradi indica l'est. Questo parametro è facoltativo per i dispositivi di categoria A e condizionale per i dispositivi di categoria B.

antenna_downtilt

Int32Value

L'inclinazione verso il basso dell'antenna in gradi è un numero intero con un valore compreso tra -90 e +90 inclusi; un valore negativo indica che l'antenna è inclinata verso l'alto (sopra l'orizzontale). Questo parametro è facoltativo per i dispositivi di categoria A e condizionale per i dispositivi di categoria B.

antenna_gain

Int32Value

Guadagno massimo dell'antenna in dBi. Questo parametro è un numero intero con un valore compreso tra -127 e +128 (dBi) inclusi.

eirp_capability

Int32Value

Questo parametro è l'EIRP massimo del dispositivo in unità di dBm/10 MHz ed è un numero intero con un valore compreso tra -127 e +47 (dBm/10 MHz) inclusi. Se non è incluso, SAS lo interpreta come EIRP massimo consentito in unità di dBm/10 MHz per la categoria di dispositivo.

antenna_beamwidth

Int32Value

Larghezza del fascio dell'antenna a 3 dB nel piano orizzontale in gradi. Questo parametro è un numero intero senza segno con un valore compreso tra 0 e 360 (gradi) inclusi; è facoltativo per i dispositivi di categoria A e condizionale per i dispositivi di categoria B.

antenna_model

string

Se viene utilizzata un'antenna esterna, il modello di antenna viene fornito facoltativamente in questo campo. La stringa ha una lunghezza massima di 128 ottetti.

cpe_cbsd_indication

BoolValue

Se presente, questo parametro specifica se la CBSD è una CPE-CBSD o meno.

ListCustomersRequest

Richiesta per ListCustomers.

Campi
page_size

int32

Il numero massimo di customers da restituire nella risposta.

page_token

string

Un token di paginazione restituito da una precedente chiamata a ListCustomers che indica da dove deve continuare questo elenco.

ListCustomersResponse

Risposta per ListCustomers.

Campi
customers[]

Customer

L'elenco di customers che corrispondono alla richiesta.

next_page_token

string

Un token di impaginazione restituito da una precedente chiamata a ListCustomers che indica da dove deve continuare l'elenco. Se il campo è mancante o vuoto, significa che non ci sono altri clienti.

ListDeploymentsRequest

Richiesta per ListDeployments.

Campi
parent

string

Obbligatorio. Il nome della risorsa padre, ad esempio "nodes/1", customer/1/nodes/2.

page_size

int32

Il numero massimo di deployment da restituire nella risposta.

page_token

string

Un token di paginazione restituito da una precedente chiamata a ListDeployments che indica da dove deve continuare questo elenco.

filter

string

L'espressione di filtro. Il filtro deve avere il seguente formato: "DIRECT_CHILDREN" o "direct_children". Il filtro non è sensibile alle maiuscole. Se è vuoto, non vengono filtrati deployment.

ListDeploymentsResponse

Risposta per ListDeployments.

Campi
deployments[]

Deployment

I deployments che soddisfano la richiesta.

next_page_token

string

Un token di impaginazione restituito da una precedente chiamata a ListDeployments che indica da dove deve continuare l'elenco. Se il campo è mancante o vuoto, significa che non sono presenti altri deployment.

ListDevicesRequest

Richiesta per ListDevices.

Campi
parent

string

Obbligatorio. Il nome della risorsa padre.

page_size

int32

Il numero massimo di dispositivi da restituire nella risposta. Se è vuoto o zero, verranno elencati tutti i dispositivi. Deve essere compreso nell'intervallo [0, 1000].

page_token

string

Un token di paginazione restituito da una precedente chiamata a ListDevices che indica da dove deve continuare questo elenco.

filter

string

L'espressione di filtro. Il filtro deve avere uno dei seguenti formati: "sn=123454" o "display_name=MyDevice". sn corrisponde al numero di serie del dispositivo. Il filtro non è sensibile alle maiuscole.

ListDevicesResponse

Risposta per ListDevices.

Campi
devices[]

Device

I devices che soddisfano la richiesta.

next_page_token

string

Un token di impaginazione restituito da una precedente chiamata a ListDevices che indica da dove deve continuare l'elenco. Se il campo è mancante o vuoto, significa che non sono presenti altri dispositivi.

ListNodesRequest

Richiesta per ListNodes.

Campi
parent

string

Obbligatorio. Il nome della risorsa padre, ad esempio "nodes/1".

page_size

int32

Il numero massimo di nodi da restituire nella risposta.

page_token

string

Un token di paginazione restituito da una precedente chiamata a ListNodes che indica da dove deve continuare questo elenco.

filter

string

L'espressione di filtro. Il filtro deve avere il seguente formato: "DIRECT_CHILDREN" o "direct_children". Il filtro non è sensibile alle maiuscole. Se è vuoto, non viene filtrato alcun nodo.

ListNodesResponse

Risposta per ListNodes.

Campi
nodes[]

Node

I nodes che soddisfano la richiesta.

next_page_token

string

Un token di impaginazione restituito da una precedente chiamata a ListNodes che indica da dove deve continuare l'elenco. Se il campo è mancante o vuoto, significa che non ci sono altri nodi.

MeasurementCapability

Funzionalità di misurazione del dispositivo. I valori sono definiti da WINNF-SSC-0002.

Enum
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

Richiesta per MoveDeployment.

Campi
name

string

Obbligatorio. Il nome del deployment da spostare.

destination

string

Obbligatorio. Il nome della nuova risorsa principale node o customer in cui riassegnare il deployment.

MoveDeviceRequest

Richiesta per MoveDevice.

Campi
name

string

Obbligatorio. Il nome del dispositivo da spostare.

destination

string

Obbligatorio. Il nome della nuova risorsa genitore node o customer a cui riassegnare il dispositivo.

MoveNodeRequest

Richiesta per MoveNode.

Campi
name

string

Obbligatorio. Il nome del node da spostare.

destination

string

Obbligatorio. Il nome della nuova risorsa padre node o customer sotto cui riassegnare il nodo.

Nodo

The Node.

Campi
name

string

Solo output. Nome della risorsa.

display_name

string

Il nome visualizzato del nodo.

sas_user_ids[]

string

ID utente utilizzati dai dispositivi appartenenti a questo nodo.

Norme

Definisce un criterio di controllo dell'accesso alle risorse.

Campi
assignments[]

Assignment

Elenco di assignments

etag

bytes

L'etag viene utilizzato per il controllo della concorrenza ottimistico come modo per impedire che gli aggiornamenti simultanei di un criterio si sovrascrivano a vicenda. È consigliabile che i sistemi utilizzino l'etag nel ciclo di lettura-modifica-scrittura per eseguire gli aggiornamenti dei criteri al fine di evitare race condition: un'etag viene restituita nella risposta a GetPolicy e i sistemi devono inserire l'etag nella richiesta a SetPolicy per garantire che la modifica venga applicata alla stessa versione dei criteri.

Se nella chiamata a GetPolicy non viene fornito alcun ETag, il criterio esistente viene sovrascritto ciecamente.

SetPolicyRequest

Messaggio di richiesta per il metodo SetPolicy.

Campi
resource

string

Obbligatorio. La risorsa per cui vengono specificati i criteri. Questa policy sostituisce qualsiasi policy esistente.

policy

Policy

Obbligatorio. Il criterio da applicare a resource.

SignDeviceRequest

Richiesta per SignDevice.

Campi
device

Device

Obbligatorio. device da firmare. I campi device name, fcc_id e serial_number devono essere impostati. Il campo user_id deve essere impostato.

TestPermissionsRequest

Messaggio di richiesta per il metodo TestPermissions.

Campi
resource

string

Obbligatorio. La risorsa per cui vengono richieste le autorizzazioni.

permissions[]

string

Il set di autorizzazioni da controllare per resource.

TestPermissionsResponse

Messaggio di risposta per il metodo TestPermissions.

Campi
permissions[]

string

Un insieme di autorizzazioni consentite al chiamante.

UpdateCustomerRequest

Richiesta per UpdateCustomer.

Campi
customer

Customer

Obbligatorio. I nuovi valori per customer. Il cliente deve aver impostato name e display_name.

update_mask

FieldMask

Campi da aggiornare.

UpdateDeploymentRequest

Richiesta per UpdateDeployment.

Campi
deployment

Deployment

Obbligatorio. I nuovi valori per deployment. È necessario impostare name e display_name.

update_mask

FieldMask

Campi da aggiornare.

UpdateDeviceRequest

Richiesta per UpdateDevice.

Campi
device

Device

Obbligatorio. device da aggiornare. I campi device name, fcc_id e serial_number devono essere impostati. Il campo user_id deve essere impostato.

update_mask

FieldMask

Campi da aggiornare.

UpdateNodeRequest

Richiesta per UpdateNode.

Campi
node

Node

Obbligatorio. I nuovi valori per node. È necessario impostare name e display_name.

update_mask

FieldMask

Campi da aggiornare.

UpdateSignedDeviceRequest

Richiesta per UpdateSignedDevice.

Campi
name

string

Obbligatorio. Il nome del dispositivo da aggiornare.

encoded_device

bytes

Obbligatorio. Il token web JSON firmato utilizzando una chiave privata CPI. Il payload deve essere la codifica JSON di device. Il campo user_id deve essere impostato.

installer_id

string

Obbligatorio. ID installatore univoco (ID CPI) dal database Certified Professional Installers.

ValidateInstallerRequest

Richiesta per ValidateInstaller.

Campi
installer_id

string

Obbligatorio. ID installatore univoco (ID CPI) dal database degli installatori professionali certificati.

secret

string

Obbligatorio. Secret restituito da GenerateSecret.

encoded_secret

string

Obbligatorio. Token web JSON firmato utilizzando una chiave privata CPI. Il payload deve includere un'attestazione "secret" il cui valore è il secret.

ValidateInstallerResponse

Risposta per ValidateInstaller.