Package spectrum.sas.portal.v1alpha1

אינדקס

לקוחות

שירות לניהול לקוחות SAS.

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

מחזירה customer שנדרש.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

מחזירה רשימה של customers מבוקשים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

מעדכן customer קיים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

DeviceManager

שירות לניהול מכשירים של שירות רדיו בפס רחב אזרחי (CBRS).

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

יוצר deployment חדש.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc CreateDevice(CreateDeviceRequest) returns (Device)

יוצר device מתחת לnode או לcustomer.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc CreateNode(CreateNodeRequest) returns (Node)

יוצר node חדש.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

יוצר חתימה device מתחת ל-node או ל-customer.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

מחיקת deployment.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

מחיקת device.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

מחיקת node.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

המערכת מייצרת סוד לשימוש עם ValidateInstaller.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

מחזירה deployment שנדרש.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc GetDevice(GetDeviceRequest) returns (Device)

קבלת פרטים על device.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc GetNode(GetNodeRequest) returns (Node)

מחזירה node שנדרש.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

רשימות deployments.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

רשימות devices מתחת לnode או לcustomer.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

רשימות nodes.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

העברה של deployment מתחת ל-node או ל-customer אחרים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

העברה של device מתחת ל-node או ל-customer אחרים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc MoveNode(MoveNodeRequest) returns (Operation)

העברה של node מתחת ל-node או ל-customer אחרים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc SignDevice(SignDeviceRequest) returns (Empty)

חתימה על device.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

מעדכן deployment קיים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

מעדכן את device.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc UpdateNode(UpdateNodeRequest) returns (Node)

מעדכן node קיים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

עדכון של device חתום.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

מאמת את הזהות של מתקין מוסמך (CPI).

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

PolicyService

שירות בקרת הגישה ל-Spectrum Resource Manager.

GetPolicy

rpc GetPolicy(GetPolicyRequest) returns (Policy)

מקבלת את מדיניות בקרת הגישה למשאב. הפונקציה מחזירה מדיניות ריקה אם המשאב קיים ולא מוגדרת לו מדיניות.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc SetPolicy(SetPolicyRequest) returns (Policy)

הגדרת מדיניות בקרת הגישה במשאב שצוין. מחליף כל מדיניות קיימת.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

מחזירה את ההרשאות שיש למבצע הקריאה במשאב שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

מטלה

משייך את members אל role.

שדות
role

string

חובה. התפקיד שהוקצה למשתמש members.

members[]

string

הזהויות שהתפקיד מוקצה להן. הערך יכול להיות אחד מהערכים הבאים:

  • {user_email}: כתובת אימייל שמייצגת חשבון Google ספציפי. לדוגמה: alice@gmail.com

  • {group_email}: כתובת אימייל שמייצגת קבוצה ב-Google. לדוגמה, viewers@gmail.com.

BillingMode

מצב החיוב של מכשיר CBSD

טיפוסים בני מנייה (enum)
BILLING_MODE_UNSPECIFIED לא צוין מצב חיוב.
MOBILE המחיר מבוסס על הקטגוריה של CBSD: קטגוריה א', קטגוריה ב' שרשומות ב-SAS.
FIXED_WIRELESS המחיר מבוסס על סוג ה-CBSD: תחנת בסיס או CPE.

ChannelType

טיפוסים בני מנייה (enum)
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

בקשה לקבלת CreateDeployment.

שדות
parent

string

חובה. שם משאב האב שבו ייווצר הפריסה.

deployment

Deployment

חובה. פרטי הפריסה. התג name חייב להיות ריק. הוא נוצר על ידי השרת. צריך להגדיר את הפריסה display_name.

CreateDeviceRequest

בקשה לקבלת CreateDevice.

שדות
parent

string

חובה. השם של משאב האב.

device

Device

פרטי הרישום של device. התג name חייב להיות ריק. הוא נוצר על ידי השרת. צריך להגדיר את השדות device fcc_id ו-serial_number. צריך להגדיר את השדה user_id.

CreateNodeRequest

בקשה לקבלת CreateNode.

שדות
parent

string

חובה. שם משאב ההורה שבו ייצור הצומת.

node

Node

פרטי הצומת. התג name חייב להיות ריק. הוא נוצר על ידי השרת. צריך להגדיר את הצומת display_name.

CreateSignedDeviceRequest

בקשה לקבלת CreateSignedDevice.

שדות
parent

string

חובה. השם של משאב האב.

encoded_device

bytes

חובה. אסימון אינטרנט מבוסס JSON שחתום באמצעות מפתח פרטי של CPI. המטען הייעודי (payload) חייב להיות קידוד JSON של device. צריך להגדיר את השדה user_id.

installer_id

string

חובה. מזהה ייחודי של מתקין (מזהה CPI) מתוך מסד הנתונים של מתקינים מקצועיים מוסמכים.

לקוח

ישות שמייצגת לקוח של SAS.

שדות
name

string

פלט בלבד. שם המשאב של הלקוח.

display_name

string

חובה. שם הארגון שהישות של הלקוח מייצגת.

sas_user_ids[]

string

מזהי משתמשים שמשמשים במכשירים ששייכים ללקוח הזה.

DeleteDeploymentRequest

בקשה לקבלת DeleteDeployment.

שדות
name

string

חובה. השם של deployment.

DeleteDeviceRequest

בקשה לקבלת DeleteDevice.

שדות
name

string

חובה. השם של המכשיר.

DeleteNodeRequest

בקשה לקבלת DeleteNode.

שדות
name

string

חובה. השם של node.

פריסה

הפריסה.

שדות
name

string

פלט בלבד. שם המשאב.

display_name

string

השם המוצג של הפריסה.

sas_user_ids[]

string

מזהה המשתמש שבו משתמשים המכשירים ששייכים לפריסה הזו. כל פריסה צריכה להיות משויכת למזהה משתמש ייחודי אחד.

default_billing_mode

BillingMode

מצב החיוב שמוגדר כברירת מחדל לפריסה ולמכשירים שכלולים בה.

allowed_billing_modes[]

BillingMode

מצבי החיוב המותרים בפריסה הזו.

מכשיר

שדות
name

string

פלט בלבד. שם נתיב המשאב.

fcc_id

string

מזהה ה-FCC של המכשיר.

serial_number

string

מספר סידורי שהוקצה למכשיר על ידי יצרן המכשיר.

preloaded_config

DeviceConfig

הגדרת המכשיר, כפי שצוין דרך SAS Portal API.

active_config

DeviceConfig

פלט בלבד. ההגדרה הנוכחית של המכשיר כפי שנרשמה ב-SAS.

state

State

פלט בלבד. מצב המכשיר.

grants[]

DeviceGrant

פלט בלבד. הרשאות שמוחזקות על ידי המכשיר.

display_name

string

השם המוצג של המכשיר.

device_metadata

DeviceMetadata

פרמטרים של מכשיר שאפשר לשנות גם דרך SAS Portal וגם דרך בקשות רישום SAS.

מדינה

המצב של המכשיר.

טיפוסים בני מנייה (enum)
DEVICE_STATE_UNSPECIFIED הסטטוס לא צוין.
RESERVED המכשיר נוצר ב-SAS Portal, אבל עדיין לא נרשם ב-SAS.
REGISTERED המכשיר רשום ב-SAS.
DEREGISTERED המכשיר בוטל הרישום ב-SAS.

DeviceAirInterface

מידע על ממשק האוויר של המכשיר.

שדות
radio_technology

RadioTechnology

מותנה. בשדה הזה מצוינת טכנולוגיית הגישה לרדיו שמשמשת את ה-CBSD.

supported_spec

string

אופציונלי. השדה הזה קשור ל-radioTechnology ומציין את מפרט ממשק האוויר שה-CBSD תואם לו בזמן הרישום.

RadioTechnology

סוגי טכנולוגיית הגישה לרדיו שאושרו.

טיפוסים בני מנייה (enum)
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

קטגוריית ה-FCC של המכשיר, כפי שמוגדרת בחלק 96.

טיפוסים בני מנייה (enum)
DEVICE_CATEGORY_UNSPECIFIED קטגוריית המכשיר לא צוינה.
DEVICE_CATEGORY_A קטגוריה א'.
DEVICE_CATEGORY_B קטגוריה ב'.

DeviceConfig

מידע על הגדרת המכשיר.

שדות
category

DeviceCategory

קטגוריית המכשיר לפי FCC.

model

DeviceModel

מידע על דגם המכשיר הזה.

air_interface

DeviceAirInterface

מידע על הממשק האווירי של המכשיר הזה.

installation_params

InstallationParams

פרמטרים של התקנה למכשיר.

measurement_capabilities[]

MeasurementCapability

יכולות הדיווח על המדידה של המכשיר.

user_id

StringValue

המזהה של משתמש במכשיר.

call_sign

string

אות הקריאה של מפעיל המכשיר.

state

State

הסטטוס של ההגדרה.

is_signed

BoolValue

פלט בלבד. האם ההגדרה נחתמה על ידי CPI.

update_time

Timestamp

פלט בלבד. הפעם האחרונה שבה נערכה הגדרת המכשיר.

מדינה

המצב של תצורת המכשיר. אפשר להשתמש רק בהגדרות במצב DEVICE_CONFIG_STATE_FINAL במהלך רישום CBSD.

טיפוסים בני מנייה (enum)
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

הרשאת מכשיר. זהו אישור שניתן על ידי מערכת הגישה לספקטרום למכשיר לשדר באמצעות פרמטרים מוגדרים של הפעלה אחרי שהמכשיר שולח אות פעימה מוצלח.

שדות
max_eirp

DoubleValue

ההספק האיזוטרופי האפקטיבי המוקרן (EIRP) המקסימלי שמותר לפי הרישיון. הערך המקסימלי של EIRP הוא ביחידות של dBm/MHz. הערך של maxEirp מייצג את ה-EIRP הממוצע (RMS) שיימדד לפי ההליך שמוגדר בחלק 96.41(e)(3) של תקנות FCC.

frequency_range

FrequencyRange

טווח תדרי השידור.

state

GrantState

המצב של מתן ההרשאה.

channel_type

ChannelType

סוג הערוץ שבו נעשה שימוש.

move_list[]

DpaMoveList

רשימות ההעברה של ה-DPA שבהן מופיע המענק הזה.

expire_time

Timestamp

מועד התפוגה של ההרשאה.

suspension_reason[]

string

אם המענק מושעה, הסיבות להשעיה.

grant_id

string

מזהה הרשאה.

DeviceMetadata

אפשר לשנות את נתוני המכשיר גם דרך SAS Portal וגם דרך בקשות הרשמה.

DeviceModel

מידע על דגם המכשיר.

שדות
vendor

string

השם של ספק המכשיר.

name

string

שם דגם המכשיר.

software_version

string

גרסת התוכנה של המכשיר.

hardware_version

string

גרסת החומרה של המכשיר.

firmware_version

string

גרסת הקושחה של המכשיר.

DpaMoveList

רשומה ברשימת ההעברה של DPA.

שדות
dpa_id

StringValue

המזהה של ה-DPA.

frequency_range

FrequencyRange

טווח התדירות שרשימת ההעברה משפיעה עליו.

FrequencyRange

טווח התדירות מ-low_frequency עד high_frequency.

שדות
low_frequency_mhz

DoubleValue

התדר הנמוך ביותר בטווח התדרים במגה-הרץ.

high_frequency_mhz

DoubleValue

התדירות הגבוהה ביותר בטווח התדרים במגה-הרץ.

GenerateSecretRequest

בקשה לקבלת GenerateSecret.

GenerateSecretResponse

תשובה לשאילתה GenerateSecret.

שדות
secret

string

הסוד שנוצר על ידי המחרוזת ומשמש את ValidateInstaller.

GetCustomerRequest

בקשה לקבלת GetCustomer .

שדות
name

string

חובה. השם של customer.

GetDeploymentRequest

בקשה לקבלת GetDeployment.

שדות
name

string

חובה. השם של deployment.

GetDeviceRequest

בקשה לקבלת GetDevice.

שדות
name

string

חובה. השם של המכשיר.

GetNodeRequest

בקשה לקבלת GetNode.

שדות
name

string

חובה. השם של node.

GetPolicyRequest

הודעת בקשה לשיטת GetPolicy.

שדות
resource

string

חובה. המשאב שעבורו נשלחת בקשת המדיניות.

GrantState

המצב של ההרשאה.

טיפוסים בני מנייה (enum)
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED ההרשאה ניתנה, אבל המכשיר לא שולח פעימות לב.
GRANT_STATE_TERMINATED המענק בוטל על ידי SAS.
GRANT_STATE_SUSPENDED ההרשאה הושעתה על ידי SAS.
GRANT_STATE_AUTHORIZED המכשיר משדר כרגע.
GRANT_STATE_EXPIRED המענק פג.

HeightType

מציינת איך הגובה נמדד.

טיפוסים בני מנייה (enum)
HEIGHT_TYPE_UNSPECIFIED סוג הגובה לא צוין.
HEIGHT_TYPE_AGL גובה AGL נמדד ביחס לגובה פני הקרקע.
HEIGHT_TYPE_AMSL גובה AMSL נמדד ביחס לגובה הממוצע של פני הים.

InstallationParams

מידע על פרמטרים של התקנת המכשיר.

שדות
latitude

DoubleValue

קו הרוחב של מיקום האנטנה של המכשיר במעלות ביחס לנקודת הייחוס WGS 84. הטווח המותר הוא מ-90.000000- עד 90.000000+. ערכים חיוביים מייצגים קווי רוחב מצפון לקו המשווה, וערכים שליליים מייצגים קווי רוחב מדרום לקו המשווה.

longitude

DoubleValue

קו האורך של מיקום האנטנה של המכשיר במעלות ביחס לנקודת הייחוס WGS 84. הטווח המותר הוא מ-‎-180.000000 עד ‎+180.000000. ערכים חיוביים מייצגים קווי אורך ממזרח לקו גריניץ', וערכים שליליים מייצגים קווי אורך ממערב לקו גריניץ'.

height

DoubleValue

גובה האנטנה של המכשיר במטרים. אם ערך הפרמטר heightType הוא AGL, גובה האנטנה צריך להיות יחסי לגובה פני הקרקע. כשהערך של הפרמטר heightType הוא AMSL, הוא ניתן ביחס לנתון WGS84.

height_type

HeightType

מציינת איך הגובה נמדד.

horizontal_accuracy

DoubleValue

מספר חיובי במטרים שמציין את רמת הדיוק של המיקום האופקי של אנטנת המכשיר. הפרמטר האופציונלי הזה צריך להיות נוכח רק אם הערך שלו קטן מהדרישה של FCC (ועדת התקשורת הפדרלית) של 50 מטרים.

vertical_accuracy

DoubleValue

מספר חיובי במטרים שמציין את רמת הדיוק של המיקום האנכי של האנטנה במכשיר. הפרמטר האופציונלי הזה צריך להיות נוכח רק אם הערך שלו קטן מהדרישה של FCC‎ (ועדת התקשורת הפדרלית בארה"ב) של 3 מטרים.

indoor_deployment

BoolValue

האם האנטנה של המכשיר נמצאת בתוך מבנה או לא. ‫true: indoor. false: בחוץ.

antenna_azimuth

Int32Value

כיוון הציר האופטי של המישור האופקי של האנטנה במעלות ביחס לצפון המוחלט. הערך של הפרמטר הזה הוא מספר שלם בין 0 ל-359, כולל. הערך 0 מעלות מציין צפון אמיתי, והערך 90 מעלות מציין מזרח. הפרמטר הזה הוא אופציונלי למכשירים מקטגוריה א' ומוגבל למכשירים מקטגוריה ב'.

antenna_downtilt

Int32Value

הטיית האנטנה כלפי מטה במעלות, והיא מספר שלם עם ערך בין ‎-90 ל-‎+90 כולל. ערך שלילי מציין שהאנטנה מוטה כלפי מעלה (מעל האופק). הפרמטר הזה הוא אופציונלי למכשירים מקטגוריה א' ומוגבל למכשירים מקטגוריה ב'.

antenna_gain

Int32Value

שבח האנטנה המקסימלי בדציבלים ביחס לאנטנה איזוטרופית (dBi). הפרמטר הזה הוא מספר שלם עם ערך בין ‎-127 ל-‎+128 (dBi), כולל.

eirp_capability

Int32Value

הפרמטר הזה הוא ה-EIRP המקסימלי של המכשיר ביחידות של dBm/10MHz, והוא מספר שלם עם ערך בין ‎-127 ל-‎+47 (dBm/10 MHz), כולל. אם לא מציינים את הערך הזה, מערכת ה-SAS מפרשת אותו כ-EIRP מקסימלי מותר ביחידות של dBm/10MHz לקטגוריית המכשיר.

antenna_beamwidth

Int32Value

רוחב האלומה של האנטנה במישור האופקי במעלות, בנקודה שבה עוצמת האות יורדת ב-3dB. הפרמטר הזה הוא מספר שלם לא חתום עם ערך בין 0 ל-360 (מעלות), כולל. הוא אופציונלי למכשירים מקטגוריה א' ומוגבל למכשירים מקטגוריה ב'.

antenna_model

string

אם משתמשים באנטנה חיצונית, אפשר לציין את דגם האנטנה בשדה הזה. האורך המקסימלי של המחרוזת הוא 128 אוקטטים.

cpe_cbsd_indication

BoolValue

אם הפרמטר הזה קיים, הוא מציין אם ה-CBSD הוא CPE-CBSD או לא.

ListCustomersRequest

בקשה לקבלת ListCustomers.

שדות
page_size

int32

המספר המקסימלי של customers שיוחזרו בתשובה.

page_token

string

אסימון עימוד שהוחזר מקריאה קודמת ל-ListCustomers ומציין מאיפה צריך להמשיך את הרישום הזה.

ListCustomersResponse

תשובה לשאילתה ListCustomers.

שדות
customers[]

Customer

רשימת customers שתואמות לבקשה.

next_page_token

string

אסימון עימוד שהוחזר מקריאה קודמת ל-ListCustomers ומציין מאיפה צריך להמשיך את הרשימה. אם השדה חסר או ריק, המשמעות היא שאין יותר לקוחות.

ListDeploymentsRequest

בקשה לקבלת ListDeployments.

שדות
parent

string

חובה. שם משאב האב, לדוגמה, 'nodes/1', ‏ customer/1/nodes/2.

page_size

int32

המספר המקסימלי של פריסות שיוחזרו בתשובה.

page_token

string

אסימון עימוד שהוחזר מקריאה קודמת ל-ListDeployments ומציין מאיפה צריך להמשיך את הרישום הזה.

filter

string

ביטוי הסינון. המסנן צריך להיות בפורמט 'DIRECT_CHILDREN' או בפורמט 'direct_children'. המסנן לא תלוי אותיות רישיות (case-sensitive). אם השדה ריק, לא מתבצע סינון של פריסות.

ListDeploymentsResponse

תשובה לשאילתה ListDeployments.

שדות
deployments[]

Deployment

ה-deployments שתואמים לבקשה.

next_page_token

string

אסימון עימוד שהוחזר מקריאה קודמת ל-ListDeployments ומציין מאיפה צריך להמשיך את הרשימה. אם השדה חסר או ריק, המשמעות היא שאין יותר פריסות.

ListDevicesRequest

בקשה לקבלת ListDevices.

שדות
parent

string

חובה. השם של משאב האב.

page_size

int32

מספר המכשירים המקסימלי שיוחזר בתשובה. אם הערך ריק או אפס, כל המכשירים יופיעו ברשימה. הערך חייב להיות בטווח [0, 1000].

page_token

string

אסימון עימוד שהוחזר מקריאה קודמת ל-ListDevices ומציין מאיפה צריך להמשיך את הרישום הזה.

filter

string

ביטוי הסינון. המסנן צריך להיות באחד מהפורמטים הבאים: 'sn=123454' או 'display_name=MyDevice'. ‏sn מתאים למספר הסידורי של המכשיר. המסנן לא תלוי אותיות רישיות (case-sensitive).

ListDevicesResponse

תשובה לשאילתה ListDevices.

שדות
devices[]

Device

ה-devices שתואמים לבקשה.

next_page_token

string

אסימון עימוד שהוחזר מקריאה קודמת ל-ListDevices ומציין מאיפה צריך להמשיך את הרשימה. אם השדה חסר או ריק, המשמעות היא שאין יותר מכשירים.

ListNodesRequest

בקשה לקבלת ListNodes.

שדות
parent

string

חובה. שם משאב האב, לדוגמה, 'nodes/1'.

page_size

int32

המספר המקסימלי של צמתים שיוחזרו בתשובה.

page_token

string

אסימון עימוד שהוחזר מקריאה קודמת ל-ListNodes ומציין מאיפה צריך להמשיך את הרישום הזה.

filter

string

ביטוי הסינון. המסנן צריך להיות בפורמט 'DIRECT_CHILDREN' או בפורמט 'direct_children'. המסנן לא תלוי אותיות רישיות (case-sensitive). אם השדה ריק, לא מסוננים צמתים.

ListNodesResponse

תשובה לשאילתה ListNodes.

שדות
nodes[]

Node

ה-nodes שתואמים לבקשה.

next_page_token

string

אסימון עימוד שהוחזר מקריאה קודמת ל-ListNodes ומציין מאיפה צריך להמשיך את הרשימה. אם השדה חסר או ריק, זה אומר שאין עוד צמתים.

MeasurementCapability

יכולת המדידה של המכשיר. הערכים מוגדרים על ידי WINNF-SSC-0002.

טיפוסים בני מנייה (enum)
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

בקשה לקבלת MoveDeployment.

שדות
name

string

חובה. השם של deployment שרוצים להעביר.

destination

string

חובה. השם של משאב האב החדש node או customer שאליו רוצים להעביר את הפריסה.

MoveDeviceRequest

בקשה לקבלת MoveDevice.

שדות
name

string

חובה. השם של המכשיר שרוצים להעביר.

destination

string

חובה. השם של משאב ההורה החדש node או customer שאליו רוצים להעביר את המכשיר.

MoveNodeRequest

בקשה לקבלת MoveNode.

שדות
name

string

חובה. השם של node שרוצים להעביר.

destination

string

חובה. השם של משאב האב החדש node או customer שאליו רוצים להעביר את הצומת.

צומת

הצומת.

שדות
name

string

פלט בלבד. שם המשאב.

display_name

string

השם המוצג של הצומת.

sas_user_ids[]

string

מזהי משתמשים שמשמשים את המכשירים ששייכים לצומת הזה.

מדיניות

הגדרת מדיניות בקרת גישה למשאבים.

שדות
assignments[]

Assignment

רשימה של assignments פריטים

etag

bytes

ה-etag משמש לבקרת בו-זמניות אופטימית כדי למנוע מצב שבו עדכונים שקורים במקביל יחליפו אחד את השני. מומלץ מאוד להשתמש ב-etag במחזור הקריאה-שינוי-כתיבה כדי לבצע עדכונים במדיניות, וכך להימנע מתנאי מירוץ: ערך ה-etag מוחזר בתגובה ל-GetPolicy, והמערכות אמורות להוסיף את ה-etag הזה לבקשה ל-SetPolicy כדי לוודא שהשינוי יוחל על אותה גרסה של המדיניות.

אם לא מצוין etag בקריאה אל GetPolicy, המדיניות הקיימת מוחלפת באופן אוטומטי.

SetPolicyRequest

הודעת בקשה לשיטת SetPolicy.

שדות
resource

string

חובה. המשאב שעבורו מציינים את המדיניות. המדיניות הזו מחליפה כל מדיניות קיימת.

policy

Policy

חובה. המדיניות שתחול על resource.

SignDeviceRequest

בקשה לקבלת SignDevice.

שדות
device

Device

חובה. הקוד device לחתימה. צריך להגדיר את השדות device name, fcc_id ו-serial_number. צריך להגדיר את השדה user_id.

TestPermissionsRequest

הודעת בקשה לשיטת TestPermissions.

שדות
resource

string

חובה. המשאב שעבורו מתבקשות ההרשאות.

permissions[]

string

קבוצת ההרשאות לבדיקה עבור resource.

TestPermissionsResponse

הודעת תגובה לשיטה TestPermissions.

שדות
permissions[]

string

קבוצת ההרשאות שיש למשתמש ששלח את הקריאה.

UpdateCustomerRequest

בקשה לקבלת UpdateCustomer.

שדות
customer

Customer

חובה. הערכים החדשים של customer. צריך להגדיר את הערכים name ו-display_name.

update_mask

FieldMask

השדות שרוצים לעדכן.

UpdateDeploymentRequest

בקשה לקבלת UpdateDeployment.

שדות
deployment

Deployment

חובה. הערכים החדשים של deployment. צריך להגדיר את name ואת display_name.

update_mask

FieldMask

השדות שרוצים לעדכן.

UpdateDeviceRequest

בקשה לקבלת UpdateDevice.

שדות
device

Device

חובה. הגרסה של device שצריך לעדכן. צריך להגדיר את השדות device name, fcc_id ו-serial_number. צריך להגדיר את השדה user_id.

update_mask

FieldMask

השדות שרוצים לעדכן.

UpdateNodeRequest

בקשה לקבלת UpdateNode.

שדות
node

Node

חובה. הערכים החדשים של node. צריך להגדיר את name ואת display_name.

update_mask

FieldMask

השדות שרוצים לעדכן.

UpdateSignedDeviceRequest

בקשה לקבלת UpdateSignedDevice.

שדות
name

string

חובה. השם של המכשיר שרוצים לעדכן.

encoded_device

bytes

חובה. אסימון ה-JSON Web Token שנחתם באמצעות מפתח פרטי של CPI. המטען הייעודי (payload) חייב להיות קידוד JSON של device. צריך להגדיר את השדה user_id.

installer_id

string

חובה. מזהה ייחודי של מתקין (מזהה CPI) מתוך מסד הנתונים של מתקינים מקצועיים מוסמכים.

ValidateInstallerRequest

בקשה לקבלת ValidateInstaller.

שדות
installer_id

string

חובה. מזהה ייחודי של מתקין (מזהה CPI) מתוך מסד הנתונים של מתקינים מקצועיים מוסמכים.

secret

string

חובה. הסוד שהוחזר על ידי GenerateSecret.

encoded_secret

string

חובה. אסימון אינטרנט מבוסס JSON שחתום באמצעות מפתח פרטי של CPI. המטען הייעודי צריך לכלול הצהרה מסוג 'סוד' שהערך שלה הוא הסוד.

ValidateInstallerResponse

תשובה לשאילתה ValidateInstaller.