Package spectrum.sas.portal.v1alpha1

Indeks

Klienci

Usługa zarządzająca klientami SAS.

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Zwraca żądany element customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Zwraca listę żądanych customers.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Aktualizuje istniejący customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

DeviceManager

Usługa zarządzająca urządzeniami Citizens Broadband Radio Service.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Tworzy nowy deployment.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Tworzy device pod node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc CreateNode(CreateNodeRequest) returns (Node)

Tworzy nowy node.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

Tworzy podpisany device w ramach node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Usuwa deployment.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Usuwa device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Usuwa node.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Generuje obiekt tajny do użycia z ValidateInstaller.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Zwraca żądany element deployment.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc GetDevice(GetDeviceRequest) returns (Device)

Pobiera szczegóły device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc GetNode(GetNodeRequest) returns (Node)

Zwraca żądany element node.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Listy deployments.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Wyświetla listę devices w sekcji node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Listy nodes.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Przenosi deployment pod inny symbol node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Przenosi device pod inny symbol node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc MoveNode(MoveNodeRequest) returns (Operation)

Przenosi node pod inny symbol node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc SignDevice(SignDeviceRequest) returns (Empty)

Podpisuje device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Aktualizuje istniejący deployment.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Aktualizuje device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Aktualizuje istniejący node.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Aktualizuje podpisany plik device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Weryfikuje tożsamość certyfikowanego profesjonalnego instalatora (CPI).

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

PolicyService

Usługa kontroli dostępu do Menedżera zasobów spektrum.

GetPolicy

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Pobiera zasady kontroli dostępu do zasobu. Zwraca pustą zasadę, jeśli zasób istnieje i nie ma ustawionej zasady.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Ustawia zasady kontroli dostępu w przypadku określonego zasobu. Zastępuje wszystkie dotychczasowe zasady.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Zwraca uprawnienia, które wywołujący ma w odniesieniu do określonego zasobu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Projekt

Powiąż members z role.

Pola
role

string

Wymagany. Rola przypisana do użytkownika members.
members[]

string

Tożsamości, do których przypisana jest rola. Może mieć te wartości:

  • {user_email}: adres e-mail, który reprezentuje konkretne konto Google. Przykład: alice@gmail.com.

  • {group_email}: adres e-mail reprezentujący grupę dyskusyjną Google. Na przykład: viewers@gmail.com.

BillingMode

Tryb płatności CBSD

Wartości w polu enum
BILLING_MODE_UNSPECIFIED Nie określono trybu rozliczeń.
MOBILE Cena zależy od kategorii CBSD: kategoria A, kategoria B zarejestrowana w SAS.
FIXED_WIRELESS Cena zależy od typu urządzenia CBSD: stacja bazowa lub CPE.

ChannelType

Wartości w polu enum
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Prośba o CreateDeployment.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego, w którym ma zostać utworzone wdrożenie.
deployment

Deployment

Wymagany. Szczegóły wdrożenia. Pole name musi być puste. Jest on generowany przez serwer. Musisz ustawić wdrożenie display_name.

CreateDeviceRequest

Prośba o CreateDevice.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego.
device

Device

Szczegóły rejestracji device. Pole name musi być puste. Jest on generowany przez serwer. Pola device fcc_id i serial_number muszą być ustawione. Pole user_id musi być ustawione.

CreateNodeRequest

Prośba o CreateNode.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego, w którym ma zostać utworzony węzeł.
node

Node

Szczegóły węzła. Pole name musi być puste. Jest on generowany przez serwer. Węzeł display_name musi być ustawiony.

CreateSignedDeviceRequest

Prośba o CreateSignedDevice.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego.
encoded_device

bytes

Wymagany. Token sieciowy JSON podpisany kluczem prywatnym platformy CPI. Ładunek musi być kodowaniem JSON obiektu device. Pole user_id musi być ustawione.
installer_id

string

Wymagany. Unikalny identyfikator instalatora (CPI ID) z bazy danych certyfikowanych profesjonalnych instalatorów.

Klient

Podmiot reprezentujący klienta SAS.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu klienta.
display_name

string

Wymagany. Nazwa organizacji, którą reprezentuje podmiot klienta.
sas_user_ids[]

string

Identyfikatory użytkowników używane przez urządzenia należące do tego klienta.

DeleteDeploymentRequest

Prośba o DeleteDeployment.

Pola
name

string

Wymagany. Nazwa deployment.

DeleteDeviceRequest

Prośba o DeleteDevice.

Pola
name

string

Wymagany. Nazwa urządzenia.

DeleteNodeRequest

Prośba o DeleteNode.

Pola
name

string

Wymagany. Nazwa node.

Wdrożenie

Wdrożenie.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu.
display_name

string

Wyświetlana nazwa wdrożenia.
sas_user_ids[]

string

Identyfikator użytkownika używany przez urządzenia należące do tego wdrożenia. Każde wdrożenie powinno być powiązane z jednym unikalnym identyfikatorem użytkownika.
default_billing_mode

BillingMode

Domyślny tryb rozliczeń wdrożenia i urządzeń w nim.
allowed_billing_modes[]

BillingMode

Dozwolone tryby rozliczeniowe w ramach tego wdrożenia.

Urządzenie

Pola
name

string

Tylko dane wyjściowe. Nazwa ścieżki zasobu.
fcc_id

string

Identyfikator FCC urządzenia.
serial_number

string

Numer seryjny przypisany do urządzenia przez producenta.
preloaded_config

DeviceConfig

Konfiguracja urządzenia określona za pomocą interfejsu SAS Portal API.
active_config

DeviceConfig

Tylko dane wyjściowe. Bieżąca konfiguracja urządzenia zarejestrowanego w SAS.
state

State

Tylko dane wyjściowe. Stan urządzenia.
grants[]

DeviceGrant

Tylko dane wyjściowe. Uprawnienia przyznane urządzeniu.
display_name

string

Wyświetlana nazwa urządzenia.
device_metadata

DeviceMetadata

Parametry urządzenia, które mogą zostać zastąpione zarówno przez portal SAS, jak i przez żądania rejestracji SAS.

Stan

Stan urządzenia.

Wartości w polu enum
DEVICE_STATE_UNSPECIFIED Nieokreślony stan.
RESERVED Urządzenie zostało utworzone w SAS Portal, ale nie zostało jeszcze zarejestrowane w SAS.
REGISTERED Urządzenie zarejestrowane w SAS.
DEREGISTERED Urządzenie zostało wyrejestrowane z SAS.

DeviceAirInterface

Informacje o interfejsie radiowym urządzenia.

Pola
radio_technology

RadioTechnology

Warunkowe. To pole określa technologię dostępu radiowego używaną w przypadku urządzenia CBSD.
supported_spec

string

Opcjonalnie. To pole jest powiązane ze specyfikacją radioTechnology i zawiera specyfikację interfejsu radiowego, z którą urządzenie CBSD jest zgodne w momencie rejestracji.

RadioTechnology

Zatwierdzone rodzaje technologii dostępu radiowego.

Wartości w polu enum
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

Kategoria urządzenia według FCC, zgodnie z definicją w części 96.

Wartości w polu enum
DEVICE_CATEGORY_UNSPECIFIED Nieokreślona kategoria urządzenia.
DEVICE_CATEGORY_A Kategoria A.
DEVICE_CATEGORY_B Kategoria B.

DeviceConfig

Informacje o konfiguracji urządzenia.

Pola
category

DeviceCategory

Kategoria urządzenia według FCC.
model

DeviceModel

Informacje o tym modelu urządzenia.
air_interface

DeviceAirInterface

Informacje o interfejsie radiowym tego urządzenia.
installation_params

InstallationParams

Parametry instalacji urządzenia.
measurement_capabilities[]

MeasurementCapability

Możliwości raportowania pomiarów przez urządzenie.
user_id

StringValue

Identyfikator użytkownika urządzenia.
call_sign

string

Znak wywoławczy operatora urządzenia.
state

State

Stan konfiguracji.
is_signed

BoolValue

Tylko dane wyjściowe. Czy konfiguracja została podpisana przez certyfikowanego instalatora.
update_time

Timestamp

Tylko dane wyjściowe. Ostatnia edycja konfiguracji urządzenia.

Stan

Stan konfiguracji urządzenia. Podczas rejestracji CBSD można używać tylko konfiguracji w stanie DEVICE_CONFIG_STATE_FINAL.

Wartości w polu enum
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

Przyznanie urządzenia. Jest to autoryzacja przyznawana przez system Spectrum Access System urządzeniu, które po wysłaniu sygnału o stanie gotowości może transmitować dane przy użyciu określonych parametrów operacyjnych.

Pola
max_eirp

DoubleValue

Maksymalna efektywna moc wypromieniowana izotropowo (EIRP) dozwolona w ramach grantu. Maksymalna moc EIRP jest podawana w jednostkach dBm/MHz. Wartość maxEirp reprezentuje średnią (RMS) moc EIRP, która zostałaby zmierzona zgodnie z procedurą określoną w części 96.41(e)(3) przepisów FCC.
frequency_range

FrequencyRange

Zakres częstotliwości transmisji.
state

GrantState

Stan uwierzytelnienia.
channel_type

ChannelType

Rodzaj użytego kanału.
move_list[]

DpaMoveList

Na liście przeniesień DPA pojawia się ta dotacja.
expire_time

Timestamp

Okres ważności uwierzytelnienia.
suspension_reason[]

string

Jeśli grant został zawieszony, podaj powody zawieszenia.
grant_id

string

Identyfikator zezwolenia.

DeviceMetadata

Dane urządzenia, które można zastąpić zarówno w SAS Portal, jak i w żądaniach rejestracji.

DeviceModel

Informacje o modelu urządzenia.

Pola
vendor

string

Nazwa dostawcy urządzenia.
name

string

Nazwa modelu urządzenia.
software_version

string

Wersja oprogramowania urządzenia.
hardware_version

string

Wersja sprzętowa urządzenia.
firmware_version

string

Wersja oprogramowania układowego urządzenia.

DpaMoveList

Wpis na liście przeniesień organu ochrony danych.

Pola
dpa_id

StringValue

Identyfikator DPA.
frequency_range

FrequencyRange

Zakres częstotliwości, na który wpływa lista ruchów.

FrequencyRange

Zakres częstotliwości od low_frequency do high_frequency.

Pola
low_frequency_mhz

DoubleValue

Najniższa częstotliwość z zakresu częstotliwości w MHz.
high_frequency_mhz

DoubleValue

Najwyższa częstotliwość w zakresie częstotliwości w MHz.

GenerateSecretRequest

Prośba o GenerateSecret.

GenerateSecretResponse

Odpowiedź na zapytanie GenerateSecret.

Pola
secret

string

Obiekt tajny wygenerowany przez ciąg znaków i używany przez ValidateInstaller.

GetCustomerRequest

Prośba o GetCustomer .

Pola
name

string

Wymagany. Nazwa customer.

GetDeploymentRequest

Prośba o GetDeployment.

Pola
name

string

Wymagany. Nazwa deployment.

GetDeviceRequest

Prośba o GetDevice.

Pola
name

string

Wymagany. Nazwa urządzenia.

GetNodeRequest

Prośba o GetNode.

Pola
name

string

Wymagany. Nazwa node.

GetPolicyRequest

Wiadomość z prośbą o metodę GetPolicy.

Pola
resource

string

Wymagany. Zasób, dla którego żądana jest zasada.

GrantState

Stan przyznania.

Wartości w polu enum
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Grant został przyznany, ale urządzenie nie wysyła sygnału o jego stanie.
GRANT_STATE_TERMINATED Zezwolenie zostało anulowane przez SAS.
GRANT_STATE_SUSPENDED Grant został zawieszony przez SAS.
GRANT_STATE_AUTHORIZED Urządzenie obecnie transmituje.
GRANT_STATE_EXPIRED Zezwolenie wygasło.

HeightType

Określa sposób pomiaru wysokości.

Wartości w polu enum
HEIGHT_TYPE_UNSPECIFIED Nieokreślony typ wysokości.
HEIGHT_TYPE_AGL Wysokość AGL jest mierzona względem poziomu gruntu.
HEIGHT_TYPE_AMSL Wysokość AMSL jest mierzona względem średniego poziomu morza.

InstallationParams

Informacje o parametrach instalacji urządzenia.

Pola
latitude

DoubleValue

Szerokość geograficzna lokalizacji anteny urządzenia w stopniach względem układu WGS 84. Dozwolony zakres to od -90,000000 do +90,000000. Wartości dodatnie oznaczają szerokość geograficzną na północ od równika, a ujemne – na południe od niego.
longitude

DoubleValue

Długość geograficzna lokalizacji anteny urządzenia w stopniach względem układu odniesienia WGS 84. Dozwolony zakres to od -180,000000 do +180,000000. Wartości dodatnie oznaczają długości geograficzne na wschód od południka zerowego, a ujemne – na zachód od niego.
height

DoubleValue

Wysokość anteny urządzenia w metrach. Gdy wartość parametru heightType to „AGL”, wysokość anteny powinna być podana względem poziomu gruntu. Gdy wartość parametru heightType to „AMSL”, jest ona podawana w odniesieniu do układu WGS84.
height_type

HeightType

Określa sposób pomiaru wysokości.
horizontal_accuracy

DoubleValue

Liczba dodatnia w metrach wskazująca dokładność poziomego położenia anteny urządzenia. Ten opcjonalny parametr powinien być obecny tylko wtedy, gdy jego wartość jest mniejsza niż wymagane przez FCC 50 metrów.
vertical_accuracy

DoubleValue

Liczba dodatnia w metrach wskazująca dokładność pionowego położenia anteny urządzenia. Ten opcjonalny parametr powinien być obecny tylko wtedy, gdy jego wartość jest mniejsza niż wymagane przez FCC 3 metry.
indoor_deployment

BoolValue

Określa, czy antena urządzenia jest wewnątrz budynku. true: w pomieszczeniu. false: na zewnątrz.
antenna_azimuth

Int32Value

Kierunek osi głównej anteny w płaszczyźnie poziomej w stopniach względem północy geograficznej. Wartość tego parametru to liczba całkowita z zakresu od 0 do 359 włącznie. Wartość 0 stopni oznacza północ geograficzną, a 90 stopni – wschód. W przypadku urządzeń kategorii A ten parametr jest opcjonalny, a w przypadku urządzeń kategorii B – warunkowy.
antenna_downtilt

Int32Value

Pochylenie anteny w stopniach. Jest to liczba całkowita z zakresu od -90 do +90 włącznie. Wartość ujemna oznacza, że antena jest pochylona w górę (powyżej poziomu). W przypadku urządzeń kategorii A ten parametr jest opcjonalny, a w przypadku urządzeń kategorii B – warunkowy.
antenna_gain

Int32Value

Szczytowe wzmocnienie anteny w dBi. Ten parametr to liczba całkowita z zakresu od -127 do +128 dBi włącznie.
eirp_capability

Int32Value

Ten parametr to maksymalna moc EIRP urządzenia w jednostkach dBm/10 MHz. Jest to liczba całkowita z zakresu od –127 do +47 dBm/10 MHz włącznie. Jeśli nie jest uwzględniona, SAS interpretuje ją jako maksymalną dopuszczalną moc EIRP w jednostkach dBm/10 MHz dla kategorii urządzenia.
antenna_beamwidth

Int32Value

Szerokość wiązki anteny 3 dB w płaszczyźnie poziomej w stopniach. Ten parametr to liczba całkowita bez znaku o wartości z zakresu od 0 do 360 (stopni) włącznie. Jest on opcjonalny w przypadku urządzeń kategorii A i warunkowy w przypadku urządzeń kategorii B.
antenna_model

string

Jeśli używana jest antena zewnętrzna, w tym polu można podać jej model. Ciąg znaków może mieć maksymalnie 128 oktetów.
cpe_cbsd_indication

BoolValue

Jeśli ten parametr jest obecny, określa, czy urządzenie CBSD jest urządzeniem CPE-CBSD.

ListCustomersRequest

Prośba o ListCustomers.

Pola
page_size

int32

Maksymalna liczba customers do zwrócenia w odpowiedzi.
page_token

string

Token stronicowania zwrócony z poprzedniego wywołania funkcji ListCustomers, który wskazuje, od którego miejsca należy kontynuować wyświetlanie tej listy.

ListCustomersResponse

Odpowiedź na zapytanie ListCustomers.

Pola
customers[]

Customer

Lista customers, które pasują do żądania.
next_page_token

string

Token stronicowania zwrócony z poprzedniego wywołania funkcji ListCustomers, który wskazuje, od którego miejsca należy kontynuować wyświetlanie listy. Jeśli pole jest puste lub go brakuje, oznacza to, że nie ma już więcej klientów.

ListDeploymentsRequest

Prośba o ListDeployments.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego, np. „nodes/1”, customer/1/nodes/2.
page_size

int32

Maksymalna liczba wdrożeń do zwrócenia w odpowiedzi.
page_token

string

Token stronicowania zwrócony z poprzedniego wywołania funkcji ListDeployments, który wskazuje, od którego miejsca należy kontynuować wyświetlanie tej listy.
filter

string

Wyrażenie filtra. Filtr powinien mieć format „DIRECT_CHILDREN” lub „direct_children”. Filtr nie uwzględnia wielkości znaków. Jeśli jest puste, żadne wdrożenia nie są filtrowane.

ListDeploymentsResponse

Odpowiedź na zapytanie ListDeployments.

Pola
deployments[]

Deployment

deployments, które spełniają warunki żądania.
next_page_token

string

Token stronicowania zwrócony z poprzedniego wywołania funkcji ListDeployments, który wskazuje, od którego miejsca należy kontynuować wyświetlanie listy. Jeśli pole jest puste lub go brakuje, oznacza to, że nie ma już więcej wdrożeń.

ListDevicesRequest

Prośba o ListDevices.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego.
page_size

int32

Maksymalna liczba urządzeń do zwrócenia w odpowiedzi. Jeśli jest pusta lub ma wartość zero, zostaną wyświetlone wszystkie urządzenia. Musi mieścić się w zakresie [0, 1000].
page_token

string

Token stronicowania zwrócony z poprzedniego wywołania funkcji ListDevices, który wskazuje, od którego miejsca należy kontynuować wyświetlanie tej listy.
filter

string

Wyrażenie filtra. Filtr powinien mieć jeden z tych formatów: „sn=123454” lub „display_name=MyDevice”. sn odpowiada numerowi seryjnemu urządzenia. Filtr nie uwzględnia wielkości znaków.

ListDevicesResponse

Odpowiedź na zapytanie ListDevices.

Pola
devices[]

Device

devices, które spełniają warunki żądania.
next_page_token

string

Token stronicowania zwrócony z poprzedniego wywołania funkcji ListDevices, który wskazuje, od którego miejsca należy kontynuować wyświetlanie listy. Jeśli pole jest puste lub go brakuje, oznacza to, że nie ma już więcej urządzeń.

ListNodesRequest

Prośba o ListNodes.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego, np. „nodes/1”.
page_size

int32

Maksymalna liczba węzłów do zwrócenia w odpowiedzi.
page_token

string

Token stronicowania zwrócony z poprzedniego wywołania funkcji ListNodes, który wskazuje, od którego miejsca należy kontynuować wyświetlanie tej listy.
filter

string

Wyrażenie filtra. Filtr powinien mieć format „DIRECT_CHILDREN” lub „direct_children”. Filtr nie uwzględnia wielkości znaków. Jeśli jest puste, żadne węzły nie są filtrowane.

ListNodesResponse

Odpowiedź na zapytanie ListNodes.

Pola
nodes[]

Node

nodes, które spełniają warunki żądania.
next_page_token

string

Token stronicowania zwrócony z poprzedniego wywołania funkcji ListNodes, który wskazuje, od którego miejsca należy kontynuować wyświetlanie listy. Jeśli pole jest puste lub go brakuje, oznacza to, że nie ma już więcej węzłów.

MeasurementCapability

Możliwość pomiaru na urządzeniu. Wartości są zdefiniowane w dokumencie WINNF-SSC-0002.

Wartości w polu enum
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

Prośba o MoveDeployment.

Pola
name

string

Wymagany. Nazwa deployment do przeniesienia.
destination

string

Wymagany. Nazwa nowego zasobu nadrzędnego node lub customer, do którego ma zostać przeniesione wdrożenie.

MoveDeviceRequest

Prośba o MoveDevice.

Pola
name

string

Wymagany. Nazwa urządzenia do przeniesienia.
destination

string

Wymagany. Nazwa nowego zasobu nadrzędnego node lub customer, pod którym ma się znajdować urządzenie.

MoveNodeRequest

Prośba o MoveNode.

Pola
name

string

Wymagany. Nazwa node do przeniesienia.
destination

string

Wymagany. Nazwa nowego zasobu nadrzędnego node lub customer, pod którym ma się znajdować węzeł.

Węzeł

Węzeł.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu.
display_name

string

Wyświetlana nazwa węzła.
sas_user_ids[]

string

Identyfikatory użytkowników używane przez urządzenia należące do tego węzła.

Zasady

Określa zasady kontroli dostępu do zasobów.

Pola
assignments[]

Assignment

Lista z assignments
etag

bytes

Tag ETag jest używany do optymistycznej kontroli współbieżności, aby zapobiegać jednoczesnym aktualizacjom zasad, które mogłyby się wzajemnie nadpisywać. Zdecydowanie zalecamy, aby systemy korzystały z etykiety etag w cyklu odczyt-modyfikacja-zapis, aby przeprowadzać aktualizacje zasad i unikać sytuacji wyścigu: etykieta etag jest zwracana w odpowiedzi na żądanie GetPolicy, a systemy powinny umieszczać ją w żądaniu SetPolicy, aby mieć pewność, że zmiana zostanie zastosowana do tej samej wersji zasad.

Jeśli w wywołaniu funkcji GetPolicy nie podano tagu etag, istniejąca zasada zostanie bezwarunkowo zastąpiona.

SetPolicyRequest

Wiadomość z prośbą o metodę SetPolicy.

Pola
resource

string

Wymagany. Zasób, dla którego określana jest zasada. Ta zasada zastępuje wszystkie dotychczasowe zasady.
policy

Policy

Wymagany. Zasady, które mają zostać zastosowane do resource.

SignDeviceRequest

Prośba o SignDevice.

Pola
device

Device

Wymagany. device, aby podpisać. Pola device name, fcc_id i serial_number muszą być ustawione. Pole user_id musi być ustawione.

TestPermissionsRequest

Wiadomość z prośbą o metodę TestPermissions.

Pola
resource

string

Wymagany. Zasób, do którego przyznawane są uprawnienia.
permissions[]

string

Zestaw uprawnień do sprawdzenia w przypadku resource.

TestPermissionsResponse

Wiadomość odpowiedzi dla metody TestPermissions.

Pola
permissions[]

string

Zestaw uprawnień, które ma wywołujący.

UpdateCustomerRequest

Prośba o UpdateCustomer.

Pola
customer

Customer

Wymagany. Nowe wartości parametru customer. Klient musi mieć ustawione wartości name i display_name.
update_mask

FieldMask

Pola do zaktualizowania.

UpdateDeploymentRequest

Prośba o UpdateDeployment.

Pola
deployment

Deployment

Wymagany. Nowe wartości parametru deployment. Musisz ustawić wartości name i display_name.
update_mask

FieldMask

Pola do zaktualizowania.

UpdateDeviceRequest

Prośba o UpdateDevice.

Pola
device

Device

Wymagany. device do zaktualizowania. Pola device name, fcc_id i serial_number muszą być ustawione. Pole user_id musi być ustawione.
update_mask

FieldMask

Pola do zaktualizowania.

UpdateNodeRequest

Prośba o UpdateNode.

Pola
node

Node

Wymagany. Nowe wartości parametru node. Musisz ustawić wartości name i display_name.
update_mask

FieldMask

Pola do zaktualizowania.

UpdateSignedDeviceRequest

Prośba o UpdateSignedDevice.

Pola
name

string

Wymagany. Nazwa urządzenia, które chcesz zaktualizować.
encoded_device

bytes

Wymagany. Token sieciowy JSON podpisany kluczem prywatnym platformy CPI. Ładunek musi być kodowaniem JSON obiektu device. Pole user_id musi być ustawione.
installer_id

string

Wymagany. Unikalny identyfikator instalatora (CPI ID) z bazy danych certyfikowanych profesjonalnych instalatorów.

ValidateInstallerRequest

Prośba o ValidateInstaller.

Pola
installer_id

string

Wymagany. Unikalny identyfikator instalatora (CPI ID) z bazy danych certyfikowanych profesjonalnych instalatorów.
secret

string

Wymagany. Tajny kod zwrócony przez GenerateSecret.
encoded_secret

string

Wymagany. Token sieciowy JSON podpisany kluczem prywatnym platformy CPI. Ładunek musi zawierać roszczenie „secret”, którego wartością jest klucz tajny.

ValidateInstallerResponse

Odpowiedź na zapytanie ValidateInstaller.