Package spectrum.sas.portal.v1alpha1

Index

Clients

Service gérant les clients SAS.

GetCustomer

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
ListCustomers

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
UpdateCustomer

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 gérant les appareils Citizens Broadband Radio Service.

CreateDeployment

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
CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Crée un device 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
CreateNode

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

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
DeleteDeployment

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
DeleteDevice

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
DeleteNode

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
GenerateSecret

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
GetDeployment

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
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Obtient des informations sur un 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
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Listes deployments

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Liste les devices 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
ListNodes

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Listes nodes

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Déplace un deployment sous 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
MoveDevice

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Déplace un device sous 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
MoveNode

rpc MoveNode(MoveNodeRequest) returns (Operation)

Déplace un node sous 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
SignDevice

rpc SignDevice(SignDeviceRequest) returns (Empty)

Signe un device.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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
UpdateDevice

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Met à jour un device.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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
UpdateSignedDevice

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)

Valide l'identité d'un installateur professionnel certifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

PolicyService

Service de contrôle des accès au gestionnaire de ressources de spectre.

GetPolicy

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
SetPolicy

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
TestPermissions

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é. Les valeurs suivantes sont possibles :

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

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

BillingMode

Mode de facturation d'un CBSD

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

ChannelType

Enums
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Demande de 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

Demande de 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

Demande de 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

Demande de 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. ID unique de l'installateur (ID 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 que représente l'entité client.
sas_user_ids[]

string

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

DeleteDeploymentRequest

Demande de DeleteDeployment.

Champs
name

string

Obligatoire. Nom du deployment.

DeleteDeviceRequest

Demande de DeleteDevice.

Champs
name

string

Obligatoire. Nom de l'appareil.

DeleteNodeRequest

Demande de DeleteNode.

Champs
name

string

Obligatoire. Nom du node.

Déploiement

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

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 qu'elle est spécifiée via l'API du portail SAS.
active_config

DeviceConfig

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

State

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

DeviceGrant

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

string

Nom à afficher de l'appareil.
device_metadata

DeviceMetadata

Paramètres de l'appareil pouvant être remplacés par le portail SAS et les demandes d'enregistrement SAS.

État

État de l'appareil.

Enums
DEVICE_STATE_UNSPECIFIED État non spécifié.
RESERVED L'appareil a été créé dans le portail SAS, mais n'a pas encore été enregistré auprès de SAS.
REGISTERED L'appareil est enregistré auprès du SAS.
DEREGISTERED L'appareil a été désenregistré auprès du SAS.

DeviceAirInterface

Informations sur l'interface radio de l'appareil.

Champs
radio_technology

RadioTechnology

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

string

Facultatif. Ce champ est lié à radioTechnology et fournit la spécification de l'interface radio à laquelle la CBSD est conforme au moment de l'enregistrement.

RadioTechnology

Types de technologies 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 par la section 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 radio de cet appareil.
installation_params

InstallationParams

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

MeasurementCapability

Capacités de l'appareil en termes de création de rapports sur les mesures.
user_id

StringValue

Identifiant d'un utilisateur de l'appareil.
call_sign

string

Indicatif 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. Date et heure de la dernière modification de la configuration de l'appareil.

État

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

Enums
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

Autorisation d'appareil. Il s'agit d'une autorisation fournie par le système d'accès au spectre à un appareil pour qu'il puisse transmettre des données à l'aide de paramètres de fonctionnement spécifiques après un signal de présence réussi de l'appareil.

Champs
max_eirp

DoubleValue

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

FrequencyRange

Plage de fréquences de transmission.
state

GrantState

État de l'octroi.
channel_type

ChannelType

Type de canal utilisé.
move_list[]

DpaMoveList

Liste des DPA sur lesquelles cette subvention apparaît.
expire_time

Timestamp

Heure d'expiration de l'autorisation.
suspension_reason[]

string

Motif(s) de la suspension si l'accès est suspendu.
grant_id

string

ID d'autorisation.

DeviceMetadata

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

DeviceModel

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.

DpaMoveList

Entrée dans la liste des mouvements d'un DPA.

Champs
dpa_id

StringValue

ID du DPA.
frequency_range

FrequencyRange

Plage de fréquence affectée par la liste des mouvements.

FrequencyRange

Plage de fréquence de low_frequency à 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.

GenerateSecretRequest

Demande de GenerateSecret.

GenerateSecretResponse

Réponse pour GenerateSecret.

Champs
secret

string

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

GetCustomerRequest

Demande de GetCustomer .

Champs
name

string

Obligatoire. Nom du customer.

GetDeploymentRequest

Demande de GetDeployment.

Champs
name

string

Obligatoire. Nom du deployment.

GetDeviceRequest

Demande de GetDevice.

Champs
name

string

Obligatoire. Nom de l'appareil.

GetNodeRequest

Demande de 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 stratégie est demandée.

GrantState

État de l'autorisation.

Enums
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED L'accès a été accordé, mais l'appareil n'envoie pas de signal de présence.
GRANT_STATE_TERMINATED L'autorisation a été résiliée par le SAS.
GRANT_STATE_SUSPENDED La subvention a été suspendue par le SAS.
GRANT_STATE_AUTHORIZED L'appareil transmet actuellement des données.
GRANT_STATE_EXPIRED L'autorisation a expiré.

HeightType

Spécifie comment la hauteur est mesurée.

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

InstallationParams

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

Champs
latitude

DoubleValue

Latitude de l'emplacement de l'antenne de l'appareil en degrés par rapport au datum 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, et les valeurs négatives celles au sud de l'équateur.
longitude

DoubleValue

Longitude de l'emplacement de l'antenne de l'appareil en degrés par rapport au datum WGS 84. La plage autorisée est comprise entre -180,000000 et +180,000000. Les valeurs positives représentent les longitudes à l'est du premier méridien, et les valeurs négatives celles à l'ouest.
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 donnée par rapport au datum WGS84.
height_type

HeightType

Spécifie comment la hauteur est mesurée.
horizontal_accuracy

DoubleValue

Nombre positif en mètres indiquant la précision de l'emplacement horizontal de l'antenne de l'appareil. Ce paramètre facultatif ne doit être présent que si sa valeur est inférieure à la distance de 50 mètres requise par la FCC.
vertical_accuracy

DoubleValue

Nombre positif en mètres indiquant la précision de l'emplacement vertical de l'antenne de l'appareil. Ce paramètre facultatif ne doit être présent que si sa valeur est inférieure à la distance de 3 mètres requise par la FCC.
indoor_deployment

BoolValue

Indique si l'antenne de l'appareil est à l'intérieur ou non. true : indoor. false : extérieur.
antenna_azimuth

Int32Value

Direction de visée du plan horizontal 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é signifie le nord géographique, tandis qu'une valeur de 90 degrés signifie 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

Inclinaison de l'antenne en degrés. Il s'agit d'un nombre entier compris entre -90 et +90 inclus. Une valeur négative signifie que l'antenne est inclinée vers le haut (au-dessus de l'horizontale). 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 maximal de l'antenne 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 PIRE maximale de l'appareil en dBm/10 MHz. Il s'agit d'un nombre entier compris entre -127 et +47 (dBm/10 MHz) inclus. Si elle n'est pas incluse, le SAS l'interprète comme la puissance isotrope rayonnée équivalente maximale autorisée en dBm/10 MHz pour la catégorie d'appareil.
antenna_beamwidth

Int32Value

Largeur du faisceau d'antenne à 3 dB dans le plan horizontal, en degrés. 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 conditionnel pour les appareils de catégorie B.
antenna_model

string

Si une antenne externe est utilisée, le modèle d'antenne peut être indiqué dans ce champ. La chaîne ne doit pas comporter plus de 128 octets.
cpe_cbsd_indication

BoolValue

Si ce paramètre est présent, il indique si le CBSD est un CPE-CBSD ou non.

ListCustomersRequest

Demande de ListCustomers.

Champs
page_size

int32

Nombre maximal de customers à renvoyer 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 des 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 le champ est manquant ou vide, cela signifie qu'il n'y a plus de clients.

ListDeploymentsRequest

Demande de ListDeployments.

Champs
parent

string

Obligatoire. Nom de la ressource parente, par exemple "nodes/1" ou 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 "DIRECT_CHILDREN" ou "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

Les deployments qui correspondent à la demande.
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

Demande de ListDevices.

Champs
parent

string

Obligatoire. Nom de la ressource parente.
page_size

int32

Nombre maximal d'appareils à renvoyer dans la réponse. Si la valeur est vide ou nulle, tous les appareils sont listés. Doit être compris entre 0 et 1 000.
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 avoir 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

Les devices qui correspondent à la demande.
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 le champ est manquant ou vide, cela signifie qu'il n'y a plus d'appareils.

ListNodesRequest

Demande de ListNodes.

Champs
parent

string

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

int32

Nombre maximal de nœuds à renvoyer 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 "DIRECT_CHILDREN" ou "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

Les nodes qui correspondent à la demande.
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 le champ est manquant ou vide, cela signifie qu'il n'y a plus de nœuds.

MeasurementCapability

Capacité de mesure de l'appareil. 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

Demande de MoveDeployment.

Champs
name

string

Obligatoire. Nom du deployment à déplacer.
destination

string

Obligatoire. Nom de la nouvelle ressource parente node ou customer sous laquelle réattribuer le déploiement.

MoveDeviceRequest

Demande de 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 réattribuer l'appareil.

MoveNodeRequest

Demande de MoveNode.

Champs
name

string

Obligatoire. Nom du node à déplacer.
destination

string

Obligatoire. Nom de la nouvelle ressource parente node ou customer sous laquelle réattribuer 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

L'etag permet d'effectuer un contrôle de simultanéité positive, pour éviter que les mises à jour simultanées d'une stratégie ne s'écrasent les unes les autres. Il est fortement suggéré aux systèmes d'utiliser l'etag dans le cycle lecture-modification-écriture pour effectuer des mises à jour de règles afin d'éviter les conditions de course. Un etag est renvoyé dans la réponse à GetPolicy, et les systèmes sont censés placer cet etag dans la requête à SetPolicy pour s'assurer que leur modification sera appliquée à la même version de la règle.

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 stratégie est spécifiée. Cette règle remplace toute règle existante.
policy

Policy

Obligatoire. Règle à appliquer au paramètre resource.

SignDeviceRequest

Demande de SignDevice.

Champs
device

Device

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

TestPermissionsRequest

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.

TestPermissionsResponse

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

Champs
permissions[]

string

Ensemble d'autorisations dont dispose l'appelant.

UpdateCustomerRequest

Demande de UpdateCustomer.

Champs
customer

Customer

Obligatoire. Nouvelles valeurs pour customer. Le client doit avoir défini name et display_name.
update_mask

FieldMask

Champs à mettre à jour.

UpdateDeploymentRequest

Demande de UpdateDeployment.

Champs
deployment

Deployment

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

FieldMask

Champs à mettre à jour.

UpdateDeviceRequest

Demande de UpdateDevice.

Champs
device

Device

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

FieldMask

Champs à mettre à jour.

UpdateNodeRequest

Demande de UpdateNode.

Champs
node

Node

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

FieldMask

Champs à mettre à jour.

UpdateSignedDeviceRequest

Demande de 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 unique de l'installateur (ID CPI) provenant de la base de données des installateurs professionnels certifiés.

ValidateInstallerRequest

Demande de ValidateInstaller.

Champs
installer_id

string

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

string

Obligatoire. Code 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.