Package spectrum.sas.portal.v1alpha1

Índice

Clientes

Administrar los clientes de SAS

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Devuelve un objeto customer solicitado.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Devuelve una lista de customers solicitados.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Actualiza un pedido (customer) existente.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

DeviceManager

Servicio que administra dispositivos de servicio de radio de banda ancha para ciudadanos.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Cree una deployment nueva

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Crea un device en un node o customer.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc CreateNode(CreateNodeRequest) returns (Node)

Cree una node nueva

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

Crea un device firmado en un node o customer.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Borra un deployment.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Borra un device.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Borra un node.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Genera un secreto para usar con ValidateInstaller.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Devuelve un objeto deployment solicitado.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc GetDevice(GetDeviceRequest) returns (Device)

Obtiene detalles sobre un device.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc GetNode(GetNodeRequest) returns (Node)

Devuelve un objeto node solicitado.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Listas deployments.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Enumera los devices en un node o customer.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Listas nodes.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Mueve un deployment debajo de otro node o customer.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Mueve un device debajo de otro node o customer.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc MoveNode(MoveNodeRequest) returns (Operation)

Mueve un node debajo de otro node o customer.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc SignDevice(SignDeviceRequest) returns (Empty)

Firma un device.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Actualiza un pedido (deployment) existente.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Actualiza un device.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Actualiza un pedido (node) existente.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Actualiza un device firmado.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Valida la identidad de un instalador profesional certificado (CPI).

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

PolicyService

Servicio de control de acceso al administrador de recursos de espectro.

GetPolicy

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Permite obtener la política de control de acceso de un recurso. Muestra una política vacía si el recurso existe y no cuenta con un conjunto de políticas.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Permite configurar la política de control de acceso en el recurso especificado. Reemplaza todas las políticas existentes.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Permite mostrar los permisos que tiene un emisor para un recurso específico.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Asignación

Asocia a los members con una role.

Campos
role

string

Es obligatorio. Función asignada a los members.

members[]

string

Son las identidades a las que se asigna el rol. Puede tener los siguientes valores:

  • {user_email}: Una dirección de correo electrónico que representa una Cuenta de Google específica. Por ejemplo: alice@gmail.com.

  • {group_email}: Una dirección de correo electrónico que representa a un grupo de Google. Por ejemplo, viewers@gmail.com

BillingMode

Modo de facturación de una CBSD

Enumeraciones
BILLING_MODE_UNSPECIFIED No se especificó el modo de facturación.
MOBILE El precio se basa en la categoría del CBSD: categoría A o categoría B registrada en el SAS.
FIXED_WIRELESS El precio se basa en el tipo de CBSD: estación base o CPE.

ChannelType

Enumeraciones
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Solicitud para CreateDeployment.

Campos
parent

string

Es obligatorio. Es el nombre del recurso principal en el que se creará la implementación.

deployment

Deployment

Es obligatorio. Son los detalles de la implementación. El name debe estar vacío. El servidor lo genera. Se debe establecer la implementación de display_name.

CreateDeviceRequest

Solicitud para CreateDevice.

Campos
parent

string

Es obligatorio. Es el nombre del recurso principal.

device

Device

Son los detalles del registro de device. El name debe estar vacío. El servidor lo genera. Se deben establecer los campos device, fcc_id y serial_number. Se debe establecer el campo user_id.

CreateNodeRequest

Solicitud para CreateNode.

Campos
parent

string

Es obligatorio. Es el nombre del recurso principal en el que se creará el nodo.

node

Node

Son los detalles del nodo. El name debe estar vacío. El servidor lo genera. Se debe establecer el nodo display_name.

CreateSignedDeviceRequest

Solicitud para CreateSignedDevice.

Campos
parent

string

Es obligatorio. Es el nombre del recurso principal.

encoded_device

bytes

Es obligatorio. Es un token web JSON firmado con una clave privada de CPI. La carga útil debe ser la codificación JSON de device. Se debe establecer el campo user_id.

installer_id

string

Es obligatorio. Es el ID único del instalador (ID de CPI) de la base de datos de instaladores profesionales certificados.

Cliente

Es una entidad que representa a un cliente de SAS.

Campos
name

string

Solo salida. Es el nombre del recurso del cliente.

display_name

string

Es obligatorio. Nombre de la organización que representa la entidad del cliente.

sas_user_ids[]

string

Son los IDs de usuario que utilizan los dispositivos que pertenecen a este cliente.

DeleteDeploymentRequest

Solicitud para DeleteDeployment.

Campos
name

string

Obligatorio. El nombre de deployment.

DeleteDeviceRequest

Solicitud para DeleteDevice.

Campos
name

string

Es obligatorio. Es el nombre del dispositivo.

DeleteNodeRequest

Solicitud para DeleteNode.

Campos
name

string

Obligatorio. El nombre de node.

Implementación

Es el objeto Deployment.

Campos
name

string

Solo salida. Nombre del recurso.

display_name

string

Es el nombre visible de la implementación.

sas_user_ids[]

string

Es el ID de usuario que usan los dispositivos que pertenecen a esta implementación. Cada implementación debe estar asociada a un ID de usuario único.

default_billing_mode

BillingMode

Es el modo de facturación predeterminado para la implementación y los dispositivos que incluye.

allowed_billing_modes[]

BillingMode

Son los modos de facturación permitidos en esta implementación.

Dispositivo

Campos
name

string

Solo salida. Es el nombre de la ruta de acceso al recurso.

fcc_id

string

Es el identificador de la FCC del dispositivo.

serial_number

string

Es un número de serie que el fabricante del dispositivo le asigna a este.

preloaded_config

DeviceConfig

Es la configuración del dispositivo, como se especifica a través de la API del portal de SAS.

active_config

DeviceConfig

Solo salida. Es la configuración actual del dispositivo tal como se registró en el SAS.

state

State

Solo salida. Es el estado del dispositivo.

grants[]

DeviceGrant

Solo salida. Son los permisos que tiene el dispositivo.

display_name

string

Nombre visible del dispositivo.

device_metadata

DeviceMetadata

Son los parámetros del dispositivo que pueden anularse con las solicitudes de registro del SAS y del portal del SAS.

Estado

Es el estado del dispositivo.

Enumeraciones
DEVICE_STATE_UNSPECIFIED Estado sin especificar.
RESERVED El dispositivo se creó en el portal de SAS, pero aún no se registró en SAS.
REGISTERED El dispositivo se registró en el SAS.
DEREGISTERED El dispositivo se dio de baja en el SAS.

DeviceAirInterface

Es información sobre la interfaz de aire del dispositivo.

Campos
radio_technology

RadioTechnology

Condicional. Este campo especifica la tecnología de acceso por radio que se usa para la CBSD.

supported_spec

string

Opcional. Este campo se relaciona con el radioTechnology y proporciona la especificación de la interfaz de aire con la que cumple la CBSD en el momento del registro.

RadioTechnology

Son los tipos aprobados de tecnología de acceso por radio.

Enumeraciones
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

Es la categoría de FCC del dispositivo, según se define en el artículo 96.

Enumeraciones
DEVICE_CATEGORY_UNSPECIFIED Categoría de dispositivo sin especificar.
DEVICE_CATEGORY_A Categoría A.
DEVICE_CATEGORY_B Categoría B

DeviceConfig

Es información sobre la configuración del dispositivo.

Campos
category

DeviceCategory

Es la categoría de la FCC del dispositivo.

model

DeviceModel

Es información sobre este modelo de dispositivo.

air_interface

DeviceAirInterface

Es información sobre la interfaz de aire de este dispositivo.

installation_params

InstallationParams

Son los parámetros de instalación del dispositivo.

measurement_capabilities[]

MeasurementCapability

Son las capacidades de informes de medición del dispositivo.

user_id

StringValue

Es el identificador de un usuario del dispositivo.

call_sign

string

Es el distintivo de llamada del operador del dispositivo.

state

State

Es el estado de la configuración.

is_signed

BoolValue

Solo salida. Indica si un CPI firmó la configuración.

update_time

Timestamp

Solo salida. Es la última vez que se editó la configuración del dispositivo.

Estado

Es el estado de la configuración del dispositivo. Solo se pueden usar los parámetros de configuración en el estado DEVICE_CONFIG_STATE_FINAL durante el registro de CBSD.

Enumeraciones
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

Es el otorgamiento de acceso al dispositivo. Es una autorización que proporciona el Sistema de acceso al espectro a un dispositivo para transmitir con parámetros operativos especificados después de que el dispositivo envía un latido correctamente.

Campos
max_eirp

DoubleValue

Potencia isotrópica radiada equivalente (PIRE) máxima permitida por el subsidio. La EIRP máxima se expresa en unidades de dBm/MHz. El valor de maxEirp representa la EIRP promedio (RMS) que se mediría con el procedimiento definido en la sección 96.41(e)(3) de la FCC.

frequency_range

FrequencyRange

Es el rango de frecuencia de transmisión.

state

GrantState

Estado del permiso.

channel_type

ChannelType

Es el tipo de canal que se usó.

move_list[]

DpaMoveList

Son las listas de traslado de la DPA en las que aparece esta concesión.

expire_time

Timestamp

Es la hora de vencimiento del permiso.

suspension_reason[]

string

Si el subsidio se suspendió, se indican los motivos de la suspensión.

grant_id

string

Es el ID del subsidio.

DeviceMetadata

Datos del dispositivo que pueden anularse tanto con el SAS Portal como con las solicitudes de registro.

DeviceModel

Es información sobre el modelo del dispositivo.

Campos
vendor

string

Es el nombre del proveedor del dispositivo.

name

string

Es el nombre del modelo del dispositivo.

software_version

string

Es la versión de software del dispositivo.

hardware_version

string

Es la versión de hardware del dispositivo.

firmware_version

string

Es la versión de firmware del dispositivo.

DpaMoveList

Es una entrada en la lista de movimientos de una DPA.

Campos
dpa_id

StringValue

Es el ID del DPA.

frequency_range

FrequencyRange

Es el rango de frecuencia que afecta la lista de movimientos.

FrequencyRange

El rango de frecuencia es de low_frequency a high_frequency.

Campos
low_frequency_mhz

DoubleValue

Es la frecuencia más baja del rango de frecuencia en MHz.

high_frequency_mhz

DoubleValue

Es la frecuencia más alta del rango de frecuencia en MHz.

GenerateSecretRequest

Solicitud para GenerateSecret.

GenerateSecretResponse

La respuesta para GenerateSecret.

Campos
secret

string

Es el secreto que genera la cadena y que usa ValidateInstaller.

GetCustomerRequest

Solicitud para GetCustomer .

Campos
name

string

Obligatorio. El nombre de customer.

GetDeploymentRequest

Solicitud para GetDeployment.

Campos
name

string

Obligatorio. El nombre de deployment.

GetDeviceRequest

Solicitud para GetDevice.

Campos
name

string

Es obligatorio. Es el nombre del dispositivo.

GetNodeRequest

Solicitud para GetNode.

Campos
name

string

Obligatorio. El nombre de node.

GetPolicyRequest

Mensaje de solicitud para el método GetPolicy.

Campos
resource

string

Es obligatorio. Es el recurso para el que se solicita la política.

GrantState

Es el estado del otorgamiento.

Enumeraciones
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Se otorgó el permiso, pero el dispositivo no envía latidos a través de él.
GRANT_STATE_TERMINATED La SAS canceló el otorgamiento.
GRANT_STATE_SUSPENDED La SAS suspendió el otorgamiento.
GRANT_STATE_AUTHORIZED El dispositivo está transmitiendo.
GRANT_STATE_EXPIRED Venció la concesión.

HeightType

Especifica cómo se mide la altura.

Enumeraciones
HEIGHT_TYPE_UNSPECIFIED Tipo de altura no especificado.
HEIGHT_TYPE_AGL La altura AGL se mide en relación con el nivel del suelo.
HEIGHT_TYPE_AMSL La altura AMSL se mide en relación con el nivel medio del mar.

InstallationParams

Es información sobre los parámetros de instalación del dispositivo.

Campos
latitude

DoubleValue

Latitud de la ubicación de la antena del dispositivo en grados en relación con el datum WGS 84. El rango permitido es de -90.000000 a +90.000000. Los valores positivos representan latitudes al norte del ecuador, y los valores negativos, al sur del ecuador.

longitude

DoubleValue

Es la longitud de la ubicación de la antena del dispositivo en grados en relación con el datum WGS 84. El rango permitido es de -180.000000 a +180.000000. Los valores positivos representan longitudes al este del primer meridiano, y los valores negativos, al oeste.

height

DoubleValue

Altura de la antena del dispositivo en metros. Cuando el valor del parámetro heightType es "AGL", la altura de la antena debe indicarse en relación con el nivel del suelo. Cuando el valor del parámetro heightType es "AMSL", se proporciona con respecto al datum WGS84.

height_type

HeightType

Especifica cómo se mide la altura.

horizontal_accuracy

DoubleValue

Es un número positivo en metros que indica la precisión de la ubicación horizontal de la antena del dispositivo. Este parámetro opcional solo debe estar presente si su valor es inferior al requisito de la FCC de 50 metros.

vertical_accuracy

DoubleValue

Es un número positivo en metros que indica la precisión de la ubicación vertical de la antena del dispositivo. Este parámetro opcional solo debe estar presente si su valor es inferior al requisito de la FCC de 3 metros.

indoor_deployment

BoolValue

Indica si la antena del dispositivo es para interiores o no. true: indoor. false: Exterior.

antenna_azimuth

Int32Value

Dirección de la línea de visión del plano horizontal de la antena en grados con respecto al norte verdadero. El valor de este parámetro es un número entero con un valor entre 0 y 359, inclusive. Un valor de 0 grados significa norte verdadero, y un valor de 90 grados significa este. Este parámetro es opcional para los dispositivos de categoría A y condicional para los dispositivos de categoría B.

antenna_downtilt

Int32Value

Es la inclinación descendente de la antena en grados y es un número entero con un valor entre -90 y +90 inclusive. Un valor negativo significa que la antena está inclinada hacia arriba (por encima de la horizontal). Este parámetro es opcional para los dispositivos de categoría A y condicional para los dispositivos de categoría B.

antenna_gain

Int32Value

Es la ganancia máxima de la antena en dBi. Este parámetro es un número entero con un valor entre -127 y +128 (dBi) inclusive.

eirp_capability

Int32Value

Este parámetro es la PIRE máxima del dispositivo en unidades de dBm/10 MHz y es un número entero con un valor entre -127 y +47 (dBm/10 MHz) inclusive. Si no se incluye, el SAS lo interpreta como la PIRE máxima permitida en unidades de dBm/10 MHz para la categoría del dispositivo.

antenna_beamwidth

Int32Value

Ancho del haz de la antena de 3 dB en el plano horizontal, en grados. Este parámetro es un número entero sin signo que tiene un valor entre 0 y 360 (grados) inclusive; es opcional para los dispositivos de categoría A y condicional para los dispositivos de categoría B.

antenna_model

string

Si se usa una antena externa, el modelo de la antena se proporciona de forma opcional en este campo. La cadena tiene una longitud máxima de 128 octetos.

cpe_cbsd_indication

BoolValue

Si está presente, este parámetro especifica si la CBSD es una CPE-CBSD o no.

ListCustomersRequest

Solicitud para ListCustomers.

Campos
page_size

int32

Es la cantidad máxima de customers que se devolverán en la respuesta.

page_token

string

Un token de paginación que dio como resultado una llamada anterior a ListCustomers y que indica desde dónde debería continuar esta enumeración.

ListCustomersResponse

La respuesta para ListCustomers.

Campos
customers[]

Customer

Es la lista de customers que coinciden con la solicitud.

next_page_token

string

Es un token de paginación que se muestra a partir de una llamada anterior a ListCustomers y que indica desde dónde debería continuar la enumeración. Si el campo falta o está vacío, significa que no hay más clientes.

ListDeploymentsRequest

Solicitud para ListDeployments.

Campos
parent

string

Es obligatorio. Es el nombre del recurso principal, por ejemplo, "nodos/1" o cliente/1/nodos/2.

page_size

int32

Es la cantidad máxima de implementaciones que se devolverán en la respuesta.

page_token

string

Un token de paginación que dio como resultado una llamada anterior a ListDeployments y que indica desde dónde debería continuar esta enumeración.

filter

string

Es la expresión de filtro. El filtro debe tener el siguiente formato: "DIRECT_CHILDREN" o "direct_children". El filtro no distingue mayúsculas de minúsculas. Si está vacío, no se filtran las implementaciones.

ListDeploymentsResponse

La respuesta para ListDeployments.

Campos
deployments[]

Deployment

Son los deployments que coinciden con la solicitud.

next_page_token

string

Es un token de paginación que se muestra a partir de una llamada anterior a ListDeployments y que indica desde dónde debería continuar la enumeración. Si el campo falta o está vacío, significa que no hay más implementaciones.

ListDevicesRequest

Solicitud para ListDevices.

Campos
parent

string

Es obligatorio. Es el nombre del recurso principal.

page_size

int32

Es la cantidad máxima de dispositivos que se devolverán en la respuesta. Si está vacío o es cero, se mostrarán todos los dispositivos. Debe estar en el rango [0, 1000].

page_token

string

Un token de paginación que dio como resultado una llamada anterior a ListDevices y que indica desde dónde debería continuar esta enumeración.

filter

string

Es la expresión de filtro. El filtro debe tener uno de los siguientes formatos: "sn=123454" o "display_name=MyDevice". sn corresponde al número de serie del dispositivo. El filtro no distingue mayúsculas de minúsculas.

ListDevicesResponse

La respuesta para ListDevices.

Campos
devices[]

Device

Son los devices que coinciden con la solicitud.

next_page_token

string

Es un token de paginación que se muestra a partir de una llamada anterior a ListDevices y que indica desde dónde debería continuar la enumeración. Si el campo falta o está vacío, significa que no hay más dispositivos.

ListNodesRequest

Solicitud para ListNodes.

Campos
parent

string

Es obligatorio. Es el nombre del recurso principal, por ejemplo, "nodos/1".

page_size

int32

Es la cantidad máxima de nodos que se devolverán en la respuesta.

page_token

string

Un token de paginación que dio como resultado una llamada anterior a ListNodes y que indica desde dónde debería continuar esta enumeración.

filter

string

Es la expresión de filtro. El filtro debe tener el siguiente formato: "DIRECT_CHILDREN" o "direct_children". El filtro no distingue mayúsculas de minúsculas. Si está vacío, no se filtran nodos.

ListNodesResponse

La respuesta para ListNodes.

Campos
nodes[]

Node

Son los nodes que coinciden con la solicitud.

next_page_token

string

Es un token de paginación que se muestra a partir de una llamada anterior a ListNodes y que indica desde dónde debería continuar la enumeración. Si el campo falta o está vacío, significa que no hay más nodos.

MeasurementCapability

Es la capacidad de medición del dispositivo. Los valores se definen en WINNF-SSC-0002.

Enumeraciones
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

Solicitud para MoveDeployment.

Campos
name

string

Es obligatorio. Es el nombre del deployment que se moverá.

destination

string

Es obligatorio. Nombre del nuevo recurso principal node o customer en el que se cambiará el elemento superior de la implementación.

MoveDeviceRequest

Solicitud para MoveDevice.

Campos
name

string

Es obligatorio. Es el nombre del dispositivo que se moverá.

destination

string

Es obligatorio. Nombre del nuevo recurso principal node o customer bajo el que se cambiará el dispositivo.

MoveNodeRequest

Solicitud para MoveNode.

Campos
name

string

Es obligatorio. Es el nombre del node que se moverá.

destination

string

Es obligatorio. Nombre del nuevo recurso principal node o customer en el que se cambiará el elemento superior del nodo.

Nodo

Es el nodo.

Campos
name

string

Solo salida. Nombre del recurso.

display_name

string

Es el nombre visible del nodo.

sas_user_ids[]

string

Son los IDs de usuario que usan los dispositivos que pertenecen a este nodo.

Política

Define una política de control de acceso para los recursos.

Campos
assignments[]

Assignment

Lista de assignments

etag

bytes

El ETag se usa para el control de simultaneidad optimista, como una forma de evitar que las actualizaciones simultáneas de una política se reemplacen entre sí. Se recomienda que los sistemas usen el ETag en el ciclo de lectura, modificación y escritura para realizar actualizaciones de políticas y evitar condiciones de carrera: Se devuelve un ETag en la respuesta a GetPolicy, y se espera que los sistemas coloquen ese ETag en la solicitud a SetPolicy para garantizar que su cambio se aplique a la misma versión de la política.

Si no se proporciona una ETag en la llamada a GetPolicy, la política existente se reemplazará sin consultar.

SetPolicyRequest

Mensaje de solicitud para el método SetPolicy.

Campos
resource

string

Es obligatorio. Es el recurso para el que se especifica la política. Esta política reemplaza cualquier política existente.

policy

Policy

Es obligatorio. Es la política que se aplicará al resource.

SignDeviceRequest

Solicitud para SignDevice.

Campos
device

Device

Es obligatorio. Es el device que se firmará. Se deben establecer los campos device name, fcc_id y serial_number. Se debe establecer el campo user_id.

TestPermissionsRequest

Mensaje de solicitud para el método TestPermissions.

Campos
resource

string

Es obligatorio. Es el recurso para el que se solicitan los permisos.

permissions[]

string

Corresponde al conjunto de permisos que se debe comprobar para el resource.

TestPermissionsResponse

Mensaje de respuesta para el método TestPermissions.

Campos
permissions[]

string

Es un conjunto de permisos que tiene el emisor.

UpdateCustomerRequest

Solicitud para UpdateCustomer.

Campos
customer

Customer

Es obligatorio. Son los valores nuevos de customer. El cliente debe tener configurados los parámetros name y display_name.

update_mask

FieldMask

Campos que se actualizarán.

UpdateDeploymentRequest

Solicitud para UpdateDeployment.

Campos
deployment

Deployment

Es obligatorio. Son los valores nuevos de deployment. Se deben establecer name y display_name.

update_mask

FieldMask

Campos que se actualizarán.

UpdateDeviceRequest

Solicitud para UpdateDevice.

Campos
device

Device

Es obligatorio. Es el device que se actualizará. Se deben establecer los campos device name, fcc_id y serial_number. Se debe establecer el campo user_id.

update_mask

FieldMask

Campos que se actualizarán.

UpdateNodeRequest

Solicitud para UpdateNode.

Campos
node

Node

Es obligatorio. Son los valores nuevos de node. Se deben establecer name y display_name.

update_mask

FieldMask

Campos que se actualizarán.

UpdateSignedDeviceRequest

Solicitud para UpdateSignedDevice.

Campos
name

string

Es obligatorio. Es el nombre del dispositivo que se actualizará.

encoded_device

bytes

Es obligatorio. Es el token web JSON firmado con una clave privada de la CPI. La carga útil debe ser la codificación JSON de device. Se debe establecer el campo user_id.

installer_id

string

Es obligatorio. Es el ID único del instalador (ID de CPI) de la base de datos de instaladores profesionales certificados.

ValidateInstallerRequest

Solicitud para ValidateInstaller.

Campos
installer_id

string

Es obligatorio. Es el ID único del instalador (ID de CPI) de la base de datos de instaladores profesionales certificados.

secret

string

Es obligatorio. Es el secreto que devuelve GenerateSecret.

encoded_secret

string

Es obligatorio. Es un token web JSON firmado con una clave privada de CPI. La carga útil debe incluir un reclamo "secreto" cuyo valor sea el secreto.

ValidateInstallerResponse

La respuesta para ValidateInstaller.