Package spectrum.sas.portal.v1alpha1

Dizin

Müşteriler

SAS müşterilerini yönetme hizmeti.

Müşteri Edinin

rpc GetCustomer(GetCustomerRequest) returns (Customer)

İstenen bir customer değerini döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
ListeMüşterileri

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

İstenen customers listesinin listesini döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
GüncellemeMüşteri

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Mevcut bir customer güncellenir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Cihaz Yöneticisi

Citizens Broadband Radyo Hizmeti Cihazları'nın yönetimi hizmeti.

Dağıtımı Oluşturma

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Yeni bir deployment oluşturur.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Cihaz Oluştur

rpc CreateDevice(CreateDeviceRequest) returns (Device)

node veya customer altında bir device oluşturur.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
OluşturmaNode

rpc CreateNode(CreateNodeRequest) returns (Node)

Yeni bir node oluşturur.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
OluşturulanCihaz Oluştur

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

node veya customer altında imzalı bir device oluşturur.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Dağıtımı Sil

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

deployment öğesini siler.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Cihazı Sil

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

device öğesini siler.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

node öğesini siler.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Gizli Anahtar Oluştur

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

ValidateInstaller ile kullanılacak bir gizli anahtar oluşturur.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Dağıtımı Alma

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

İstenen bir deployment değerini döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

rpc GetDevice(GetDeviceRequest) returns (Device)

device hakkında ayrıntılı bilgi edinin.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

rpc GetNode(GetNodeRequest) returns (Node)

İstenen bir node değerini döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Liste Dağıtımları

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Listeler deployments.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Liste Cihazları

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

node veya customer altında devices listeleri.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Liste Düğümleri

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Listeler nodes.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Taşıma Dağıtımı

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Bir deployment değerini başka bir node veya customer altına taşır.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Cihazı Taşı

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Bir device değerini başka bir node veya customer altına taşır.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Hareket Düğümleri

rpc MoveNode(MoveNodeRequest) returns (Operation)

Bir node değerini başka bir node veya customer altına taşır.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Cihazı İşaretle

rpc SignDevice(SignDeviceRequest) returns (Empty)

device imzalar.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Güncelleme Dağıtımı

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Mevcut bir deployment güncellenir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
GüncellemeCihazı

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

device güncellenir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Güncelleme Düğümü

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Mevcut bir node güncellenir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
İmzalanmışCihazı Güncelleme

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

İmzalı bir device güncellenir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Doğrula Yükleyici

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Bir Sertifikalı Profesyonel Yükleyicinin (YBM) kimliğini doğrular.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Politika Hizmeti

Spectrum Resource Manager'a Erişim Denetimi Hizmeti.

Politika Alma

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Bir kaynağın erişim denetimi politikasını alır. Kaynak ayarlanmışsa ve politika ayarlanmamışsa boş politika döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Politika ayarlayın

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Belirtilen kaynak için erişim denetimi politikasını ayarlar. Mevcut tüm politikaları değiştirir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/userinfo.email
Test İzinleri

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Bir arayanın belirtilen kaynakta sahip olduğu izinleri döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Ödev

members öğesini role ile ilişkilendirir.

Alanlar
role

string

Zorunlu. members adlı kullanıcıya atanan rol.

members[]

string

Rolün atandığı kimlikler. Aşağıdaki değerlere sahip olabilir:

  • {user_email}: Belirli bir Google Hesabı'nı temsil eden bir e-posta adresidir. Örneğin: alice@gmail.com.

  • {group_email}: Bir Google grubunu temsil eden bir e-posta adresidir. Örneğin, viewers@gmail.com.

Faturalandırma Modu

CBSD'nin faturalandırma modu

Sıralamalar
BILLING_MODE_UNSPECIFIED Faturalandırma modu belirtilmemiş.
MOBILE Fiyat, CBSD kategorisine bağlıdır: A Kategorisi, SAS ile kayıtlı B Kategorisi.
FIXED_WIRELESS Fiyat, CBSD türüne bağlıdır: Baz istasyonu veya ETBM.

Kanal Türü

Sıralamalar
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

DağıtımDağıtım İsteği

CreateDeployment isteği.

Alanlar
parent

string

Zorunlu. Dağıtımın oluşturulacağı üst kaynak adı.

deployment

Deployment

Zorunlu. Dağıtım ayrıntıları. name boş olmalıdır. Sunucu tarafından oluşturulur. display_name dağıtımı ayarlanmalıdır.

CihazCihazı İsteği Oluştur

CreateDevice isteği.

Alanlar
parent

string

Zorunlu. Ana kaynağın adı.

device

Device

device kayıt bilgileri. name boş olmalıdır. Sunucu tarafından oluşturulur. fcc_id ve serial_number device alanları ayarlanmalıdır. user_id alanı ayarlanmalıdır.

CreateNodeRequest

CreateNode isteği.

Alanlar
parent

string

Zorunlu. Düğümün oluşturulacağı üst kaynak adı.

node

Node

Düğüm ayrıntıları. name boş olmalıdır. Sunucu tarafından oluşturulur. display_name düğümü ayarlanmalıdır.

OluşturulanCihaz İsteğini Oluştur

CreateSignedDevice isteği.

Alanlar
parent

string

Zorunlu. Ana kaynağın adı.

encoded_device

bytes

Zorunlu. JSON Web Token, YBM özel anahtarı kullanılarak imzalandı. Yük, device öğesinin JSON kodlaması olmalıdır. user_id alanı ayarlanmalıdır.

installer_id

string

Zorunlu. Sertifikalı Profesyonel Yükleyiciler veritabanından alınan benzersiz yükleyici kimliği (YBM Kimliği).

Müşteri

SAS müşterisini temsil eden tüzel kişi.

Alanlar
name

string

Yalnızca çıkış. Müşterinin kaynak adı.

display_name

string

Zorunlu. Müşteri varlığının temsil ettiği kuruluşun adı.

sas_user_ids[]

string

Bu müşteriye ait cihazlar tarafından kullanılan kullanıcı kimlikleri.

Dağıtım İsteğini Sil

DeleteDeployment isteği.

Alanlar
name

string

Zorunlu. deployment adı.

Cihaz İsteğini Sil

DeleteDevice isteği.

Alanlar
name

string

Zorunlu. Cihazın adı.

NodeRequest Silme

DeleteNode isteği.

Alanlar
name

string

Zorunlu. node adı.

Dağıtım

Dağıtım.

Alanlar
name

string

Yalnızca çıkış. Kaynak adı.

display_name

string

Dağıtımın görünen adı.

sas_user_ids[]

string

Bu dağıtıma ait cihazlar tarafından kullanılan kullanıcı kimliği. Her dağıtım, tek bir benzersiz kullanıcı kimliğiyle ilişkilendirilmelidir.

default_billing_mode

BillingMode

Dağıtım ve altındaki cihazlar için varsayılan faturalandırma modu.

allowed_billing_modes[]

BillingMode

Bu dağıtım altında izin verilen faturalandırma modları.

Cihaz

Alanlar
name

string

Yalnızca çıkış. Kaynak yolu adı.

fcc_id

string

Cihazın FCC tanımlayıcısı.

serial_number

string

Cihaz üreticisi tarafından cihaza atanan seri numarası.

preloaded_config

DeviceConfig

Cihazın SAS Portal API'sı aracılığıyla belirtilen yapılandırması.

active_config

DeviceConfig

Yalnızca çıkış. Cihazın SAS'da kayıtlı olduğu geçerli yapılandırması.

state

State

Yalnızca çıkış. Cihaz durumu.

grants[]

DeviceGrant

Yalnızca çıkış. Cihaz tarafından verilen hibeler.

display_name

string

Görünen cihaz adı.

device_metadata

DeviceMetadata

Hem SAS Portal hem de SAS kayıt istekleri tarafından geçersiz kılınabilen cihaz parametreleri.

Eyalet

Cihazın durumu.

Sıralamalar
DEVICE_STATE_UNSPECIFIED Belirtilmemiş durum.
RESERVED Cihaz, SAS Portal'da oluşturuldu ancak henüz SAS'a kayıtlı değil.
REGISTERED Cihaz SAS'a kayıtlı.
DEREGISTERED Cihazın SAS kaydı iptal edildi.

Cihaz Hava Arayüzü

Cihazın hava arayüzü hakkında bilgi.

Alanlar
radio_technology

RadioTechnology

Koşula bağlı. Bu alan, CBSD için kullanılan radyo erişim teknolojisini belirtir.

supported_spec

string

İsteğe bağlı. Bu alan, radioTechnology ile ilgilidir ve kayıt sırasında CBSD'nin uyumlu olduğu hava arayüzü spesifikasyonunu sağlar.

RadyoTeknolojisi

Onaylı radyo erişim teknolojisi türleri.

Sıralamalar
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

Cihaz Kategorisi

96. Bölüm'de tanımlandığı şekilde cihazın FCC kategorisi.

Sıralamalar
DEVICE_CATEGORY_UNSPECIFIED Belirtilmemiş cihaz kategorisi.
DEVICE_CATEGORY_A A Kategorisi.
DEVICE_CATEGORY_B B Kategorisi.

Cihaz Yapılandırması

Cihaz yapılandırmasıyla ilgili bilgiler.

Alanlar
category

DeviceCategory

Cihazın FCC kategorisi.

model

DeviceModel

Bu cihaz modeli hakkında bilgi.

air_interface

DeviceAirInterface

Bu cihazın hava arayüzü hakkında bilgi.

installation_params

InstallationParams

Cihaz için kurulum parametreleri.

measurement_capabilities[]

MeasurementCapability

Cihazın ölçüm raporlama özellikleri.

user_id

StringValue

Cihaz kullanıcısının tanımlayıcısı.

call_sign

string

Cihaz operatörünün çağrı işareti.

state

State

Yapılandırmanın durumu.

is_signed

BoolValue

Yalnızca çıkış. Yapılandırmanın bir YBM tarafından imzalanıp imzalanmadığı.

update_time

Timestamp

Yalnızca çıkış. Cihaz yapılandırmasının son düzenlendiği zamanı.

Eyalet

Cihaz yapılandırmasının durumu. CBSD Kaydı sırasında yalnızca DEVICE_CONFIG_STATE_FINAL durumundaki yapılandırmalar kullanılabilir.

Sıralamalar
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

Cihaz Hibesi

Cihaz izni. Spectrum Access System tarafından cihaz tarafından başarılı bir sinyal geçtikten sonra belirtilen çalışma parametreleri kullanılarak aktarım için bir cihaza verilen yetkilendirmedir.

Alanlar
max_eirp

DoubleValue

Hibe tarafından izin verilen maksimum eşdeğer izotropik radyasyon gücü (EIRP). Maksimum EIRP, dBm/MHz birimlerindedir. maxEirp değeri, FCC bölümünde 96.41 (e)(3)'te tanımlanan prosedürle ölçülecek olan ortalama (RMS) EIRP'yi temsil eder.

frequency_range

FrequencyRange

İletim sıklığı aralığı.

state

GrantState

Bağış durumu.

channel_type

ChannelType

Kullanılan kanal türü.

move_list[]

DpaMoveList

Bu bağışın gösterildiği DPA taşıma listeleri.

expire_time

Timestamp

Hibenin geçerlilik süresi.

suspension_reason[]

string

Hibe askıya alındıysa askıya alma nedenleri.

grant_id

string

Hibe Kimliği

Cihaz Meta Verileri

Cihaz verileri hem SAS Portal hem de kayıt istekleri tarafından geçersiz kılınabilir.

Cihaz Modeli

Cihazın modeli hakkında bilgiler.

Alanlar
vendor

string

Cihaz satıcısının adı.

name

string

Cihaz modelinin adı.

software_version

string

Cihazın yazılım sürümü.

hardware_version

string

Cihazın donanım sürümü.

firmware_version

string

Cihazın donanım yazılımı sürümü.

DpaTaşıma Listesi

DPA'lar taşıma listesinde bir giriş.

Alanlar
dpa_id

StringValue

DPA'nın kimliği.

frequency_range

FrequencyRange

Taşıma listesinin etkilediği sıklık aralığı.

Frekans Aralığı

Sıklık aralığı low_frequency ile high_frequency arasında.

Alanlar
low_frequency_mhz

DoubleValue

MHz'deki en düşük sıklık aralığı.

high_frequency_mhz

DoubleValue

MHz'deki en yüksek sıklık aralığı.

Gizli İstek Oluştur

GenerateSecret isteği.

Gizli Yanıt Oluştur

GenerateSecret için yanıt.

Alanlar
secret

string

Dize tarafından oluşturulan ve ValidateInstaller tarafından kullanılan gizli anahtar.

Müşteri İsteği Alma

GetCustomer isteği.

Alanlar
name

string

Zorunlu. customer adı.

DağıtımDağıtım İsteği

GetDeployment isteği.

Alanlar
name

string

Zorunlu. deployment adı.

AlCihaz İsteği

GetDevice isteği.

Alanlar
name

string

Zorunlu. Cihazın adı.

GetNodeRequest

GetNode isteği.

Alanlar
name

string

Zorunlu. node adı.

Politika Alma İsteği

GetPolicy yöntemi için mesaj iste.

Alanlar
resource

string

Zorunlu. Politikanın istendiği kaynak.

GrantState

Bağış durumu.

Sıralamalar
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Hibe verildi ancak cihaz fazla nabız atmıyor.
GRANT_STATE_TERMINATED Hibe SAS tarafından sonlandırıldı.
GRANT_STATE_SUSPENDED Bağış, SAS tarafından askıya alındı.
GRANT_STATE_AUTHORIZED Cihaz şu anda aktarım yapıyor.
GRANT_STATE_EXPIRED Hibenin süresi doldu.

YükseklikTürü

Yüksekliğin nasıl ölçüldüğünü belirtir.

Sıralamalar
HEIGHT_TYPE_UNSPECIFIED Belirtilmemiş yükseklik türü.
HEIGHT_TYPE_AGL AGL yüksekliği yer seviyesine göre ölçülür.
HEIGHT_TYPE_AMSL AMSL yüksekliği, ortalama deniz düzeyine göre ölçülür.

Yükleme Paramları

Cihaz kurulum parametreleri hakkında bilgi.

Alanlar
latitude

DoubleValue

Cihaz anteninin, WGS 84 verisine göre derece cinsinden enlemi. İzin verilen aralık -90,000000 ile +90,000000 arasındadır. Pozitif değerler, ekvatorun kuzeyindeki enlemleri, ekvatorun güneyindeki negatif değerleri temsil eder.

longitude

DoubleValue

Cihaz anteninin, WGS 84 verisine göre derece derecesi. İzin verilen aralık -180,000000 ile +180.000000 arasındadır. Pozitif değerler primer meridyenin doğu boylamını, meridyenin batısındaki negatif değerleri temsil eder.

height

DoubleValue

Metre cinsinden metre anten yüksekliği. heightType parametre değeri "AGL" olduğunda anten yüksekliği yer seviyesine göre verilmelidir. heightType parametre değeri"AMSL"olduğunda WGS84 verisi ile ilgili olarak verilir.

height_type

HeightType

Yüksekliğin nasıl ölçüldüğünü belirtir.

horizontal_accuracy

DoubleValue

Cihaz anteni yatay konumunun doğruluğunu belirtmek için metre cinsinden pozitif bir sayı. İsteğe bağlı bu parametre, yalnızca değeri 50 metre olan FCC gereksiniminin altındaysa mevcut olmalıdır.

vertical_accuracy

DoubleValue

Cihaz anteni dikey konumunun doğruluğunu belirtmek için metre cinsinden pozitif bir sayı. İsteğe bağlı bu parametre yalnızca değeri 3 metrenin FCC gereksiniminden az olduğunda mevcut olmalıdır.

indoor_deployment

BoolValue

Cihaz anteninin kapalı olup olmadığı. true: iç mekan false: Dış mekan.

antenna_azimuth

Int32Value

Antenin yatay düzleminin doğru kuzeye göre derecesinin görüş açısı. Bu parametrenin değeri, 0 ile 359 arasında bir değere sahip bir tam sayıdır. 0 derece değeri kuzey, 90 derece ise doğu anlamına gelir. Bu parametre A kategorisi cihazlar için isteğe bağlıdır ve B kategorisi cihazlar için koşulludur.

antenna_downtilt

Int32Value

Anten yelken derecesi ve -90 ile +90 arasında bir değere sahip bir tam sayıdır. Negatif değer, antenin yukarı doğru (yatay olarak) eğildiği anlamına gelir. Bu parametre A kategorisi cihazlar için isteğe bağlıdır ve B kategorisi cihazlar için koşulludur.

antenna_gain

Int32Value

dBi cinsinden en yüksek anten kazancı. Bu parametre, -127 ile +128 (dBi) arasında bir değere sahip bir tam sayıdır.

eirp_capability

Int32Value

Bu parametre, dBm/10 MHz birimlerindeki maksimum cihaz EIRP değeridir ve -127 ile +47 (dBm/10 MHz) arasında bir değere sahip bir tam sayıdır. Dahil edilmezse SAS, bunu cihaz kategorisi için dBm/10 MHz birimlerinde izin verilen maksimum EIRP olarak yorumlar.

antenna_beamwidth

Int32Value

Yatay düzlemde antenin derece cinsinden 3 dB anten kiriş genişliği. Bu parametre, 0 ile 360 (derece) arasında bir değere sahip olan imzalanmamış bir tam sayıdır. A Kategorisi cihazları için isteğe bağlıdır ve B Kategorisi cihazları için koşulludur.

antenna_model

string

Harici bir anten kullanılıyorsa anten modeli isteğe bağlı olarak bu alanda sağlanır. Dize en fazla 128 sekizli uzunluğunda olabilir.

cpe_cbsd_indication

BoolValue

Mevcut olması durumunda bu parametre, CBSD'nin CPE-CBSD olup olmadığını belirtir.

ListeMüşterilerİİİstek

ListCustomers isteği.

Alanlar
page_size

int32

Yanıtta döndürülecek maksimum customers sayısı.

page_token

string

Önceki bir çağrıdan (ListCustomers) bu girişin nereden devam edeceğini belirten sayfalara ayrılmış bir jeton.

ListCustomersResponse

ListCustomers için yanıt.

Alanlar
customers[]

Customer

İstekle eşleşen customers listesi.

next_page_token

string

Önceki bir çağrıdan (ListCustomers) listelemenin devam etmesi gerektiğini belirten sayfalandırma jetonu. Alan yoksa veya boşsa başka müşteri olmadığı anlamına gelir.

ListDeploymentsRequest

ListDeployments isteği.

Alanlar
parent

string

Zorunlu. Üst kaynak adı; örneğin, "düğümler/1'; müşteri/1/düğümler/2.

page_size

int32

Yanıtta döndürülecek maksimum dağıtım sayısı.

page_token

string

Önceki bir çağrıdan (ListDeployments) bu girişin nereden devam edeceğini belirten sayfalara ayrılmış bir jeton.

filter

string

Filtre ifadesi. Filtrenin biçimi şu şekilde olmalıdır: "DIRECT_CHILDREN" veya biçim: "direct_children" Filtre büyük/küçük harfe duyarlı değildir. Boşsa hiçbir dağıtım filtrelenmez.

ListDeploymentsResponse

ListDeployments için yanıt.

Alanlar
deployments[]

Deployment

İstekle eşleşen deployments.

next_page_token

string

Önceki bir çağrıdan (ListDeployments) listelemenin devam etmesi gerektiğini belirten sayfalandırma jetonu. Alan yoksa veya boşsa başka dağıtım yok demektir.

ListeCihazları İsteği

ListDevices isteği.

Alanlar
parent

string

Zorunlu. Ana kaynağın adı.

page_size

int32

Yanıtta döndürülecek maksimum cihaz sayısı. Boş veya sıfırsa tüm cihazlar listelenir. [0, 1000] aralığında olmalıdır.

page_token

string

Önceki bir çağrıdan (ListDevices) bu girişin nereden devam edeceğini belirten sayfalara ayrılmış bir jeton.

filter

string

Filtre ifadesi. Filtrenin biçimi şunlardan biri olmalıdır: "sn=123454" veya "display_name=MyDevice". sn cihazın seri numarasına karşılık gelir. Filtre büyük/küçük harfe duyarlı değildir.

ListDevicesResponse

ListDevices için yanıt.

Alanlar
devices[]

Device

İstekle eşleşen devices.

next_page_token

string

Önceki bir çağrıdan (ListDevices) listelemenin devam etmesi gerektiğini belirten sayfalandırma jetonu. Alan yoksa veya boşsa başka cihaz yok demektir.

ListNodesİsteği

ListNodes isteği.

Alanlar
parent

string

Zorunlu. Üst kaynak adı (ör. "düğümler/1")

page_size

int32

Yanıtta döndürülecek maksimum düğüm sayısı.

page_token

string

Önceki bir çağrıdan (ListNodes) bu girişin nereden devam edeceğini belirten sayfalara ayrılmış bir jeton.

filter

string

Filtre ifadesi. Filtrenin biçimi şu şekilde olmalıdır: "DIRECT_CHILDREN" veya biçim: "direct_children" Filtre büyük/küçük harfe duyarlı değildir. Boşsa hiçbir düğüm filtrelenmez.

ListNodesResponse

ListNodes için yanıt.

Alanlar
nodes[]

Node

İstekle eşleşen nodes.

next_page_token

string

Önceki bir çağrıdan (ListNodes) listelemenin devam etmesi gerektiğini belirten sayfalandırma jetonu. Alan yoksa veya boşsa başka düğüm yok demektir.

Ölçüm Özelliği

Cihaz ölçüm özelliği. Değerler WINNF-SSC-0002 ile tanımlanır.

Sıralamalar
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

Taşınma İsteği

MoveDeployment isteği.

Alanlar
name

string

Zorunlu. Taşınacak deployment öğesinin adı.

destination

string

Zorunlu. Dağıtımı yeniden adlandırmak için yeni üst kaynağın (node veya customer) adı.

Cihaz İsteğini Taşı

MoveDevice isteği.

Alanlar
name

string

Zorunlu. Taşınacak cihazın adı.

destination

string

Zorunlu. Cihazı yeniden adlandırmak için yeni üst kaynağın node veya customer adı.

TaşımaNodeİsteği

MoveNode isteği.

Alanlar
name

string

Zorunlu. Taşınacak node öğesinin adı.

destination

string

Zorunlu. Düğümü yeniden adlandırmak için yeni üst kaynağın (node veya customer) adı.

Düğüm

Düğüm.

Alanlar
name

string

Yalnızca çıkış. Kaynak adı.

display_name

string

Düğümün görünen adı.

sas_user_ids[]

string

Bu düğüme ait cihazlar tarafından kullanılan kullanıcı kimlikleri.

Politika

Kaynaklar için bir erişim denetimi politikası tanımlar.

Alanlar
assignments[]

Assignment

assignments öğesinin listesi

etag

bytes

Etag, bir politikada aynı anda yapılan güncellemelerin, birbirinin üzerine yazılmasını önlemeye yardımcı olmak için iyimser eşzamanlılık kontrolü için kullanılır. Yarış koşullarından kaçınmak amacıyla sistemlerin, politika güncellemelerini gerçekleştirmek için okuma/yazma yazma döngüsündeki etag'i kullanması kesinlikle önerilir: GetPolicy etiketinin yanıtında bir etiket döndürülür ve sistemlerin, değişikliklerinin politikanın aynı sürümüne uygulandığından emin olmak için bu etiketi SetPolicy isteğine eklemesi beklenir.

GetPolicy çağrısında herhangi bir etiket sağlanmazsa mevcut politikanın körü körüne üzerine yazılır.

Politika İsteğini Ayarlayın

SetPolicy yöntemi için mesaj iste.

Alanlar
resource

string

Zorunlu. Politikanın belirtildiği kaynak. Bu politika, mevcut tüm politikaların yerine geçer.

policy

Policy

Zorunlu. resource öğesine uygulanacak politika.

Cihaz İsteğini İşaretleme

SignDevice isteği.

Alanlar
device

Device

Zorunlu. İmzalanacak device. name, fcc_id ve serial_number device alanları ayarlanmalıdır. user_id alanı ayarlanmalıdır.

Test İzinleriİsteği

TestPermissions yöntemi için mesaj iste.

Alanlar
resource

string

Zorunlu. İzinlerin istendiği kaynak.

permissions[]

string

resource için kontrol edilecek izin grubu.

TestPermissionsResponse

TestPermissions yöntemi için yanıt mesajı.

Alanlar
permissions[]

string

Arayanın izin verdiği bir grup izin.

Müşteri İsteğini Güncelle

UpdateCustomer isteği.

Alanlar
customer

Customer

Zorunlu. customer için yeni değerler. Müşterinin name ve display_name ayarlarını yapmış olması gerekir.

update_mask

FieldMask

Güncellenecek alanlar.

GüncellemeDağıtım İsteği

UpdateDeployment isteği.

Alanlar
deployment

Deployment

Zorunlu. deployment için yeni değerler. name ve display_name ayarlanmalıdır.

update_mask

FieldMask

Güncellenecek alanlar.

GüncellemeCihaz İsteği

UpdateDevice isteği.

Alanlar
device

Device

Zorunlu. Güncellenecek device. name, fcc_id ve serial_number device alanları ayarlanmalıdır. user_id alanı ayarlanmalıdır.

update_mask

FieldMask

Güncellenecek alanlar.

GüncellemeNodeİsteği

UpdateNode isteği.

Alanlar
node

Node

Zorunlu. node için yeni değerler. name ve display_name ayarlanmalıdır.

update_mask

FieldMask

Güncellenecek alanlar.

GüncellenenCihaz İsteğini Güncelle

UpdateSignedDevice isteği.

Alanlar
name

string

Zorunlu. Güncellenecek cihazın adı.

encoded_device

bytes

Zorunlu. YBM özel anahtarı kullanılarak imzalanmış JSON Web Token. Yük, device öğesinin JSON kodlaması olmalıdır. user_id alanı ayarlanmalıdır.

installer_id

string

Zorunlu. Sertifikalı Profesyonel Yükleyiciler veritabanından alınan benzersiz yükleyici kimliği (YBM Kimliği).

VerifyInstallerRequest

ValidateInstaller isteği.

Alanlar
installer_id

string

Zorunlu. Sertifikalı Profesyonel Yükleyiciler veritabanından alınan benzersiz yükleyici kimliği (YBM Kimliği).

secret

string

Zorunlu. GenerateSecret, gizli anahtarı döndürdü.

encoded_secret

string

Zorunlu. JSON Web Token, YBM özel anahtarı kullanılarak imzalandı. Yük, gizli anahtarı olan bir "gizli" hak talebi içermelidir.

VerifyInstallerResponse

ValidateInstaller için yanıt.