Package spectrum.sas.portal.v1alpha1

Index

Clients

Service de gestion des clients SAS.

Obtenir un client

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Renvoie un customer demandé.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Répertorier les clients

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Renvoie une liste des customers demandés.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Mettre à jour le client

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Met à jour une valeur customer existante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

DeviceManager

Service de gestion des appareils radioélectriques à citoyen haut débit.

Créer un déploiement

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

crée un objet deployment ;

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Créer un appareil

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Crée un device sous node ou customer.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Créer un nœud

rpc CreateNode(CreateNodeRequest) returns (Node)

crée un objet node ;

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
CreateSignedDevice (Créer un appareil signé)

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

Crée un device signé sous un node ou un customer.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Supprimer le déploiement

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Supprime un deployment.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Supprimer l'appareil

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Supprime un device.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Supprimer le nœud

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Supprime un node.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Générer un secret

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Génère un secret à utiliser avec ValidateInstaller.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Obtenir un déploiement

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Renvoie un deployment demandé.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Obtenir l'appareil

rpc GetDevice(GetDeviceRequest) returns (Device)

Récupère les détails d'une device.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc GetNode(GetNodeRequest) returns (Node)

Renvoie un node demandé.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Répertorier les déploiements

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Répertorie les deployments.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Répertorie devices sous node ou customer.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Répertorie les nodes.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Déplacer le déploiement

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Déplace un deployment vers un autre node ou customer.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Déplacer l'appareil

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Déplace un device vers un autre node ou customer.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Déplacer le nœud

rpc MoveNode(MoveNodeRequest) returns (Operation)

Déplace un node vers un autre node ou customer.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Appareil de signalisation

rpc SignDevice(SignDeviceRequest) returns (Empty)

Signe device.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Mise à jour du déploiement

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Met à jour une valeur deployment existante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Mettre à jour l'appareil

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Met à jour device.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Mettre à jour le nœud

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Met à jour une valeur node existante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Mettre à jour l'appareil signé

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Met à jour un device signé.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Vérifie l'identité d'un installateur professionnel certifié (CPI).

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Service Policy

Service de contrôle des accès à Spectrum Resource Manager

Obtenir la stratégie

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Récupère la stratégie de contrôle d'accès d'une ressource. Renvoie une stratégie vide si la ressource existe, mais qu'elle ne dispose d'aucune stratégie.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Définir la stratégie

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Définit la stratégie de contrôle d'accès de la ressource spécifiée. Remplace toute stratégie existante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/userinfo.email
Autorisations de test

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Renvoie les autorisations qu'un appelant a sur la ressource spécifiée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Assignment

Associe des membres members à un rôle role.

Champs
role

string

Obligatoire. Rôle attribué aux members.
members[]

string

Identités auxquelles le rôle est attribué Il peut avoir les valeurs suivantes:

  • {user_email}: adresse e-mail qui représente un compte Google spécifique. Par exemple : alice@gmail.com.

  • {group_email}: adresse e-mail qui représente un groupe Google. Exemple : viewers@gmail.com.

Mode de facturation

Mode de facturation d'une carte CBSD

Enums
BILLING_MODE_UNSPECIFIED Le mode de facturation n'a pas été spécifié.
MOBILE Le prix est basé sur la catégorie CBSD: catégorie A, catégorie B enregistrée auprès de SAS.
FIXED_WIRELESS Le prix est basé sur le type de carte CBSD: la station de base ou le CPE.

Type de canal

Enums
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Requête pour CreateDeployment.

Champs
parent

string

Obligatoire. Nom de la ressource parente dans laquelle le déploiement doit être créé.
deployment

Deployment

Obligatoire. Détails du déploiement. Le champ name doit être vide. Il est généré par le serveur. Le déploiement display_name doit être défini.

CreateDeviceRequest

Requête pour CreateDevice.

Champs
parent

string

Obligatoire. Nom de la ressource parente.
device

Device

Détails de l'enregistrement device. Le champ name doit être vide. Il est généré par le serveur. Les champs device fcc_id et serial_number doivent être définis. Le champ user_id doit être défini.

CreateNodeRequest

Requête pour CreateNode.

Champs
parent

string

Obligatoire. Nom de la ressource parente dans laquelle le nœud doit être créé.
node

Node

Détails du nœud. Le champ name doit être vide. Il est généré par le serveur. Le nœud display_name doit être défini.

CreateSignedDeviceRequest

Requête pour CreateSignedDevice.

Champs
parent

string

Obligatoire. Nom de la ressource parente.
encoded_device

bytes

Obligatoire. Jeton Web JSON signé à l'aide d'une clé privée CPI. La charge utile doit être l'encodage JSON de device. Le champ user_id doit être défini.
installer_id

string

Obligatoire. Identifiant unique du installateur (CPI) provenant de la base de données des installateurs professionnels certifiés.

Client

Entité représentant un client SAS.

Champs
name

string

Uniquement en sortie. Nom de ressource du client.
display_name

string

Obligatoire. Nom de l'organisation représentée par l'entité client.
sas_user_ids[]

string

ID utilisateur utilisés par les appareils appartenant à ce client.

DeleteDeploymentRequest

Requête pour DeleteDeployment.

Champs
name

string

Obligatoire. Nom du deployment.

DeleteDeviceRequest

Requête pour DeleteDevice.

Champs
name

string

Obligatoire. Nom de l'appareil.

DeleteNodeRequest

Requête pour DeleteNode.

Champs
name

string

Obligatoire. Nom du node.

Deployment

Déploiement.

Champs
name

string

Uniquement en sortie. Nom de la ressource.
display_name

string

Nom à afficher du déploiement.
sas_user_ids[]

string

ID utilisateur utilisé par les appareils appartenant à ce déploiement. Chaque déploiement doit être associé à un ID utilisateur unique.
default_billing_mode

BillingMode

Mode de facturation par défaut pour le déploiement et les appareils qui en dépendent.
allowed_billing_modes[]

BillingMode

Modes de facturation autorisés pour ce déploiement.

Type d'appareil

Champs
name

string

Uniquement en sortie. Nom du chemin d'accès à la ressource.
fcc_id

string

Identifiant FCC de l'appareil.
serial_number

string

Numéro de série attribué à l'appareil par le fabricant.
preloaded_config

DeviceConfig

Configuration de l'appareil, telle que spécifiée via l'API SAS Portal.
active_config

DeviceConfig

Uniquement en sortie. Configuration actuelle de l'appareil tel qu'enregistré auprès de SAS.
state

State

Uniquement en sortie. État de l'appareil.
grants[]

DeviceGrant

Uniquement en sortie. Licences détenues par l'appareil.
display_name

string

Nom à afficher de l'appareil.
device_metadata

DeviceMetadata

Paramètres d'appareil pouvant être remplacés par des demandes d'enregistrement SAS Portal et SAS.

State

État de l'appareil.

Enums
DEVICE_STATE_UNSPECIFIED État non spécifié.
RESERVED Appareil créé dans le portail SAS, mais pas encore enregistré auprès de SAS.
REGISTERED Appareil enregistré auprès de SAS.
DEREGISTERED Appareil désinscrit auprès de SAS.

Interface Appareil

Informations sur l'interface atmosphérique de l'appareil.

Champs
radio_technology

RadioTechnology

Conditionnel. Ce champ spécifie la technologie d'accès radio utilisée pour la carte CBSD.
supported_spec

string

Facultatif. Ce champ est lié à radioTechnology et fournit la spécification d'interface aérienne que la CBSD respecte au moment de l'enregistrement.

Radiotechnologie

Types de technologie d'accès radio approuvés.

Enums
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

Catégorie FCC de l'appareil, telle que définie dans la partie 96.

Enums
DEVICE_CATEGORY_UNSPECIFIED Catégorie d'appareil non spécifiée.
DEVICE_CATEGORY_A Catégorie A.
DEVICE_CATEGORY_B Catégorie B.

DeviceConfig

Informations sur la configuration de l'appareil.

Champs
category

DeviceCategory

Catégorie FCC de l'appareil.
model

DeviceModel

Informations sur ce modèle d'appareil.
air_interface

DeviceAirInterface

Informations sur l'interface aérienne de cet appareil.
installation_params

InstallationParams

Paramètres d'installation de l'appareil.
measurement_capabilities[]

MeasurementCapability

Fonctionnalités de création de rapports de l'appareil.
user_id

StringValue

Identifiant de l'utilisateur d'un appareil.
call_sign

string

Indicatif téléphonique de l'opérateur de l'appareil.
state

State

État de la configuration.
is_signed

BoolValue

Uniquement en sortie. Indique si la configuration a été signée par un CPI.
update_time

Timestamp

Uniquement en sortie. Dernière fois que la configuration de l'appareil a été modifiée.

State

État de la configuration de l'appareil. Seules les configurations dont l'état est DEVICE_CONFIG_STATE_FINAL peuvent être utilisées lors de l'enregistrement CBSD.

Enums
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

Octroi de l'appareil. Il s'agit d'une autorisation accordée par le système d'accès au spectre à un appareil de communiquer à l'aide des paramètres de fonctionnement spécifiés après une pulsation réussie.

Champs
max_eirp

DoubleValue

Puissance maximale équivalente en isolement par rayonnement isotrope rayonné (EIRP) autorisée par la subvention. La valeur EIRP maximale est exprimée en unités de dBm/MHz. La valeur de maxEirp représente la PIRE moyenne (RMS) qui serait mesurée selon la procédure définie dans la partie 96,41(e)(3) de la FCC.
frequency_range

FrequencyRange

Plage de fréquence de transmission.
state

GrantState

État de la subvention.
channel_type

ChannelType

Type de canal utilisé.
move_list[]

DpaMoveList

Listes de déplacements du DPA sur lesquelles cette subvention apparaît.
expire_time

Timestamp

Date d'expiration de la subvention.
suspension_reason[]

string

Si la subvention est suspendue, le ou les motifs de la suspension.
grant_id

string

ID de l'attribution.

Métadonnées de l'appareil

Données de l'appareil pouvant être remplacées par le portail SAS et les demandes d'enregistrement.

Modèle de l'appareil

Informations sur le modèle de l'appareil.

Champs
vendor

string

Nom du fournisseur de l'appareil.
name

string

Nom du modèle de l'appareil.
software_version

string

Version logicielle de l'appareil.
hardware_version

string

Version matérielle de l'appareil.
firmware_version

string

Version du micrologiciel de l'appareil.

Liste DPaMove

Entrée de la liste de déplacement d'un APD.

Champs
dpa_id

StringValue

ID du DPA.
frequency_range

FrequencyRange

Plage de fréquences concernée par la liste des déplacements.

Plage de fréquences

Plage de fréquence comprise entre low_frequency et high_frequency.

Champs
low_frequency_mhz

DoubleValue

Fréquence la plus basse de la plage de fréquences en MHz.
high_frequency_mhz

DoubleValue

Fréquence la plus élevée de la plage de fréquences en MHz.

Génération de la demande secrète

Requête pour GenerateSecret.

Générer une réponse secrète

Réponse pour GenerateSecret

Champs
secret

string

Secret généré par la chaîne et utilisé par ValidateInstaller.

GetCustomerRequest

Requête pour GetCustomer .

Champs
name

string

Obligatoire. Nom du customer.

GetDeploymentRequest

Requête pour GetDeployment.

Champs
name

string

Obligatoire. Nom du deployment.

GetDeviceRequest

Requête pour GetDevice.

Champs
name

string

Obligatoire. Nom de l'appareil.

GetNodeRequest

Requête pour GetNode.

Champs
name

string

Obligatoire. Nom du node.

GetPolicyRequest

Message de requête pour la méthode GetPolicy.

Champs
resource

string

Obligatoire. Ressource pour laquelle la règle est demandée.

GrantState

État de la subvention.

Enums
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED L'octroi a été accordé, mais l'appareil n'est pas assez rapide.
GRANT_STATE_TERMINATED L'octroi a été résilié par la SAS.
GRANT_STATE_SUSPENDED La subvention a été suspendue par la SAS.
GRANT_STATE_AUTHORIZED L'appareil est en train d'émettre un message.
GRANT_STATE_EXPIRED L'attribution a expiré.

Type de hauteur

Indique comment la hauteur est mesurée.

Enums
HEIGHT_TYPE_UNSPECIFIED Type de hauteur non spécifié.
HEIGHT_TYPE_AGL La hauteur de l'AGL est mesurée par rapport au niveau du sol.
HEIGHT_TYPE_AMSL La hauteur de l'AMSL est mesurée par rapport au niveau moyen de la mer.

Paramètres d'installation

Informations sur les paramètres d'installation de l'appareil.

Champs
latitude

DoubleValue

Latitude de l'antenne de l'appareil en degrés par rapport au plan de référence du WGS 84. La plage autorisée est comprise entre -90,000000 et +90,000000. Les valeurs positives représentent les latitudes au nord de l'équateur ; les valeurs négatives au sud de l'équateur.
longitude

DoubleValue

Longitude de l'antenne de l'appareil en degrés par rapport au plan de référence du WGS 84. La plage autorisée est comprise entre -180,000000 et +180,000000. Les valeurs positives représentent les longitudes à l'est du méridien d'origine et les valeurs négatives à l'ouest du méridien d'origine.
height

DoubleValue

Hauteur de l'antenne de l'appareil en mètres. Lorsque la valeur du paramètre heightType est"AGL", la hauteur de l'antenne doit être indiquée par rapport au niveau du sol. Lorsque la valeur du paramètre heightType est "AMSL", elle est indiquée par rapport au plan de référence WGS84.
height_type

HeightType

Indique comment la hauteur est mesurée.
horizontal_accuracy

DoubleValue

Nombre positif en mètres pour indiquer la précision de l'antenne horizontale de l'appareil. Ce paramètre facultatif ne doit être présent que si sa valeur est inférieure à l'exigence de la FCC de 50 mètres.
vertical_accuracy

DoubleValue

Nombre positif en mètres pour indiquer la précision de la position verticale de l'antenne de l'appareil. Ce paramètre facultatif ne doit être présent que si sa valeur est inférieure à l'exigence de la FCC de 3 mètres.
indoor_deployment

BoolValue

Si l'antenne de l'appareil est à l'intérieur ou non. true : intérieur. false : en extérieur.
antenna_azimuth

Int32Value

Direction de l'orientation horizontale de l'antenne en degrés par rapport au nord géographique. La valeur de ce paramètre est un entier compris entre 0 et 359 inclus. Une valeur de 0 degré correspond au nord géographique et une valeur de 90 degrés à l'est. Ce paramètre est facultatif pour les appareils de catégorie A et conditionnel pour les appareils de catégorie B.
antenna_downtilt

Int32Value

L'antenne est inclinée en degrés et est un entier dont la valeur est comprise entre -90 et +90 inclus. Une valeur négative signifie que l'antenne est inclinée vers le haut (au-dessus de l'axe horizontal). Ce paramètre est facultatif pour les appareils de catégorie A et conditionnel pour les appareils de catégorie B.
antenna_gain

Int32Value

Gain d'antenne maximal en dBi. Ce paramètre est un entier dont la valeur est comprise entre -127 et +128 (dBi) inclus.
eirp_capability

Int32Value

Ce paramètre correspond à la valeur PIRE maximale de l'appareil, exprimée en unités de dBm/10 MHz. Il s'agit d'un nombre entier compris entre -127 et +47 (dBm/10 MHz) inclus. S'il n'est pas inclus, SAS l'interprète comme la PIRE maximale autorisée en unités de dBm/10 MHz pour la catégorie d'appareils.
antenna_beamwidth

Int32Value

Largeur de faisceau d'antenne de 3 dB en degrés dans l'horizontale. Ce paramètre est un entier non signé dont la valeur est comprise entre 0 et 360 (degrés) inclus. Il est facultatif pour les appareils de catégorie A et facultatif pour les appareils de catégorie B.
antenna_model

string

Si une antenne externe est utilisée, le modèle d'antenne est éventuellement fourni dans ce champ. La chaîne ne doit pas dépasser 128 octets.
cpe_cbsd_indication

BoolValue

S'il est présent, ce paramètre indique si la CBSD est un CPE-CBSD.

ListCustomersRequest

Requête pour ListCustomers.

Champs
page_size

int32

Nombre maximal de customers à afficher dans la réponse.
page_token

string

Jeton de pagination renvoyé par un appel précédent à ListCustomers qui indique à partir de quel endroit cette liste doit continuer.

ListCustomersResponse

Réponse pour ListCustomers

Champs
customers[]

Customer

Liste de customers correspondant à la requête.
next_page_token

string

Jeton de pagination renvoyé par un appel précédent à ListCustomers, qui indique à partir de quel endroit la liste doit continuer. Si ce champ est manquant ou vide, cela signifie qu'il n'y a plus de clients.

ListDeploymentsRequest

Requête pour ListDeployments.

Champs
parent

string

Obligatoire. Nom de la ressource parente, par exemple "nodes/1", customer/1/nodes/2.
page_size

int32

Nombre maximal de déploiements à renvoyer dans la réponse.
page_token

string

Jeton de pagination renvoyé par un appel précédent à ListDeployments qui indique à partir de quel endroit cette liste doit continuer.
filter

string

Expression du filtre. Le filtre doit être au format suivant: "DIRECT_CHILDREN" ou au format: "direct_children". Le filtre n'est pas sensible à la casse. Si ce champ est vide, aucun déploiement n'est filtré.

ListDeploymentsResponse

Réponse pour ListDeployments

Champs
deployments[]

Deployment

deployments correspondant à la requête.
next_page_token

string

Jeton de pagination renvoyé par un appel précédent à ListDeployments, qui indique à partir de quel endroit la liste doit continuer. Si le champ est manquant ou vide, cela signifie qu'il n'y a plus de déploiements.

ListDevicesRequest

Requête pour ListDevices.

Champs
parent

string

Obligatoire. Nom de la ressource parente.
page_size

int32

Nombre maximal d'appareils à afficher dans la réponse. Si ce champ est vide ou nul, tous les appareils sont répertoriés. Doit être compris dans la plage [0, 1000].
page_token

string

Jeton de pagination renvoyé par un appel précédent à ListDevices qui indique à partir de quel endroit cette liste doit continuer.
filter

string

Expression du filtre. Le filtre doit être dans l'un des formats suivants: "sn=123454" ou "display_name=MyDevice". sn correspond au numéro de série de l'appareil. Le filtre n'est pas sensible à la casse.

ListDevicesResponse

Réponse pour ListDevices

Champs
devices[]

Device

devices correspondant à la requête.
next_page_token

string

Jeton de pagination renvoyé par un appel précédent à ListDevices, qui indique à partir de quel endroit la liste doit continuer. Si ce champ est manquant ou vide, cela signifie qu'il n'y a plus d'appareils.

ListNodesRequest

Requête pour ListNodes.

Champs
parent

string

Obligatoire. Nom de la ressource parente, par exemple "nodes/1".
page_size

int32

Nombre maximal de nœuds à afficher dans la réponse.
page_token

string

Jeton de pagination renvoyé par un appel précédent à ListNodes qui indique à partir de quel endroit cette liste doit continuer.
filter

string

Expression du filtre. Le filtre doit être au format suivant: "DIRECT_CHILDREN" ou au format: "direct_children". Le filtre n'est pas sensible à la casse. Si ce champ est vide, aucun nœud n'est filtré.

ListNodesResponse

Réponse pour ListNodes

Champs
nodes[]

Node

nodes correspondant à la requête.
next_page_token

string

Jeton de pagination renvoyé par un appel précédent à ListNodes, qui indique à partir de quel endroit la liste doit continuer. Si ce champ est manquant ou vide, cela signifie qu'il n'y a plus de nœuds.

Capacité de mesure

Capacité de mesure des appareils. Les valeurs sont définies par WINNF-SSC-0002.

Enums
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

Requête pour MoveDeployment.

Champs
name

string

Obligatoire. Nom du deployment à déplacer.
destination

string

Obligatoire. Nom de la nouvelle ressource parente node ou customer pour reparenter le déploiement.

Requête de transfert d'appareil

Requête pour MoveDevice.

Champs
name

string

Obligatoire. Nom de l'appareil à déplacer.
destination

string

Obligatoire. Nom de la nouvelle ressource parente node ou customer sous laquelle renvoyer l'appareil.

MoveNodeRequest

Requête pour MoveNode.

Champs
name

string

Obligatoire. Nom du node à déplacer.
destination

string

Obligatoire. Nom de la nouvelle ressource parente node ou customer sous laquelle renvoyer le nœud.

Nœud

Le nœud.

Champs
name

string

Uniquement en sortie. Nom de la ressource.
display_name

string

Nom à afficher du nœud.
sas_user_ids[]

string

ID utilisateur utilisés par les appareils appartenant à ce nœud.

Règle

Définit une stratégie de contrôle d'accès aux ressources.

Champs
assignments[]

Assignment

Liste de assignments
etag

bytes

Le champ "ETag" permet un contrôle de simultanéité optimiste pour éviter que les mises à jour simultanées d'une stratégie ne s'écrasent les unes les autres. Nous recommandons vivement aux systèmes d'utiliser l'ETag au cours du cycle lecture-modification-écriture pour effectuer des mises à jour de stratégie afin d'éviter les conditions de concurrence: un ETag est renvoyé en réponse à GetPolicy, et les systèmes doivent placer cet ETag dans la requête SetPolicy pour s'assurer que leur modification sera appliquée à la même version de la stratégie.

Si aucun ETag n'est fourni dans l'appel de GetPolicy, la stratégie existante est écrasée à l'aveugle.

SetPolicyRequest

Message de requête pour la méthode SetPolicy.

Champs
resource

string

Obligatoire. Ressource pour laquelle la règle est spécifiée. Cette règle remplace toute règle existante.
policy

Policy

Obligatoire. Règle à appliquer à resource.

SignDeviceRequest

Requête pour SignDevice.

Champs
device

Device

Obligatoire. device à signer. Les champs device name, fcc_id et serial_number doivent être définis. Le champ user_id doit être défini.

TestAutorisationsRequest

Message de requête pour la méthode TestPermissions.

Champs
resource

string

Obligatoire. Ressource pour laquelle les autorisations sont demandées.
permissions[]

string

Ensemble des autorisations à vérifier pour la ressource resource.

Réponse des autorisations de test

Message de réponse pour la méthode TestPermissions.

Champs
permissions[]

string

Ensemble d'autorisations dont dispose l'appelant.

UpdateCustomerRequest

Requête pour UpdateCustomer.

Champs
customer

Customer

Obligatoire. Nouvelles valeurs pour customer. Les champs name et display_name doivent être définis pour le client.
update_mask

FieldMask

Champs à mettre à jour.

UpdateDeploymentRequest

Requête pour UpdateDeployment.

Champs
deployment

Deployment

Obligatoire. Nouvelles valeurs pour deployment. name et display_name doivent être définis.
update_mask

FieldMask

Champs à mettre à jour.

UpdateDeviceRequest

Requête pour UpdateDevice.

Champs
device

Device

Obligatoire. device à mettre à jour. Les champs device name, fcc_id et serial_number doivent être définis. Le champ user_id doit être défini.
update_mask

FieldMask

Champs à mettre à jour.

UpdateNodeRequest

Requête pour UpdateNode.

Champs
node

Node

Obligatoire. Nouvelles valeurs pour node. name et display_name doivent être définis.
update_mask

FieldMask

Champs à mettre à jour.

UpdateSignDeviceRequest

Requête pour UpdateSignedDevice.

Champs
name

string

Obligatoire. Nom de l'appareil à mettre à jour.
encoded_device

bytes

Obligatoire. Jeton Web JSON signé à l'aide d'une clé privée CPI. La charge utile doit être l'encodage JSON de device. Le champ user_id doit être défini.
installer_id

string

Obligatoire. ID d'installateur unique (CPI) de la base de données des installateurs professionnels certifiés.

ValidateInstallerRequest

Requête pour ValidateInstaller.

Champs
installer_id

string

Obligatoire. Identifiant unique du installateur (CPI) provenant de la base de données des installateurs professionnels certifiés.
secret

string

Obligatoire. Secret renvoyé par GenerateSecret.
encoded_secret

string

Obligatoire. Jeton Web JSON signé à l'aide d'une clé privée CPI. La charge utile doit inclure une revendication &secret dont la valeur est le secret.

ValidateInstallerResponse

Réponse pour ValidateInstaller