Package spectrum.sas.portal.v1alpha1

אינדקס

לקוחות

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

הורדת הלקוח

rpc GetCustomer(GetCustomerRequest) returns (Customer)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
רשימת לקוחות

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
עדכון לקוח

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

מתבצע עדכון של customer קיים.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

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

מנהל המכשיר

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

יצירת פריסה

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

יצירת deployment חדש.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
יצירת מכשיר

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
יצירת חתימה במכשיר

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
מחיקת הפריסה

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

מתבצעת מחיקה של deployment.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
מחיקת מכשיר

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

מתבצעת מחיקה של device.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
מחיקת צומת

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

מתבצעת מחיקה של node.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
יצירת סוד

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
קבלת פריסה

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
התקן

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
פריסות רשימה

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

רשימה deployments.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
מכשירי List

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
צומתי רשימות

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

רשימה nodes.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
העברת הפריסה

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

מתבצעת העברה של deployment אל node או של customer אחר.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
העברת מכשיר

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

מתבצעת העברה של device אל node או של customer אחר.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
העברת צומת

rpc MoveNode(MoveNodeRequest) returns (Operation)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
מזהה המכשיר

rpc SignDevice(SignDeviceRequest) returns (Empty)

חתימה על device.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
עדכון הפריסה

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

מתבצע עדכון של deployment קיים.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
עדכון המכשיר

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

מתבצע עדכון של device.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
עדכון צומת

rpc UpdateNode(UpdateNodeRequest) returns (Node)

מתבצע עדכון של node קיים.

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
עדכון של מכשיר חתום

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
אימות המתקין

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

אימות הזהות של מנהל התקנה מקצועי (CPI).

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

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

מדיניות השירות

גישה לשירות בקרת הניהול למנהל המשאבים של ספקטרום.

מדיניות

rpc GetPolicy(GetPolicyRequest) returns (Policy)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
מדיניות

rpc SetPolicy(SetPolicyRequest) returns (Policy)

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/userinfo.email
בדיקת הרשאות

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.

מצב חיוב

מצב חיוב של CBSD

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

סוג ערוץ

Enums
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

יצירה של בקשת פריסה

בקשה עבור 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.

יצירה של חתימה במכשיר

בקשה עבור CreateSignedDevice.

שדות
parent

string

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

bytes

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

string

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

לקוח

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

שדות
name

string

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

string

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

string

מזהי User-ID שבהם נעשה שימוש במכשירים השייכים ללקוח הזה.

DeleteDeploymentRequest

בקשה עבור DeleteDeployment.

שדות
name

string

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

מחיקת מכשיר

בקשה עבור DeleteDevice.

שדות
name

string

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

מחיקת NodeRequest

בקשה עבור DeleteNode.

שדות
name

string

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

Deployment (פריסה)

הפריסה.

שדות
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 וגם בקשות הרשמה ל-SAS.

מדינה

מצב המכשיר.

Enums
DEVICE_STATE_UNSPECIFIED מצב לא מוגדר.
RESERVED המכשיר שנוצר בפורטל SAS, עדיין לא רשום ב-SAS.
REGISTERED המכשיר רשום ב-SAS.
DEREGISTERED רישום המכשיר עם SAS בוטל.

מכשיר AirAirface

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

שדות
radio_technology

RadioTechnology

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

string

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

טכנולוגיית רדיו

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

Enums
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

קטגוריית מכשיר

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

Enums
DEVICE_CATEGORY_UNSPECIFIED קטגוריית מכשיר לא מוגדרת.
DEVICE_CATEGORY_A קטגוריה א.
DEVICE_CATEGORY_B קטגוריה ב.

הגדרת תצורה של מכשיר

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

שדות
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.

Enums
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

הרשאות מכשיר

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

שדות
max_eirp

DoubleValue

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

FrequencyRange

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

GrantState

מצב המענק.
channel_type

ChannelType

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

DpaMoveList

רשימת DPA מעבירה רשימות שבהן המענק מופיע.
expire_time

Timestamp

תאריך התפוגה של המענק.
suspension_reason[]

string

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

string

הענק מזהה.

מטא נתונים של מכשיר

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

דגם המכשיר

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

שדות
vendor

string

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

string

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

string

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

string

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

string

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

רשימת רשימות

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

שדות
dpa_id

StringValue

המזהה של הרשות להגנה על מידע (DPA).
frequency_range

FrequencyRange

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

טווח תדרים

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

שדות
low_frequency_mhz

DoubleValue

התדירות הנמוכה ביותר של טווח התדירות ב-MHz.
high_frequency_mhz

DoubleValue

התדירות הגבוהה ביותר של טווח התדירות ב-MHz.

יצירת SecretSecret

בקשה עבור GenerateSecret.

יצירת תגובה סודית

תגובה עבור GenerateSecret.

שדות
secret

string

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

בקשת לקוח

בקשה עבור GetCustomer .

שדות
name

string

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

בקשת פריסה

בקשה עבור GetDeployment.

שדות
name

string

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

בקשת מכשיר

בקשה עבור GetDevice.

שדות
name

string

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

GetNodeRequest

בקשה עבור GetNode.

שדות
name

string

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

GetPolicyRequest

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

שדות
resource

string

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

גרנט סטייט

מצב המענק.

Enums
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED המענק מוענק אבל המכשיר לא פעימת לב.
GRANT_STATE_TERMINATED המענק הסתיים על ידי SAS.
GRANT_STATE_SUSPENDED המענק הושעה על ידי ה-SAS.
GRANT_STATE_AUTHORIZED המכשיר משודר כרגע.
GRANT_STATE_EXPIRED פג התוקף של המענק.

סוג הגובה

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

Enums
HEIGHT_TYPE_UNSPECIFIED סוג הגובה לא צוין.
HEIGHT_TYPE_AGL גובה AGL נמדד ביחס לרמת הקרקע.
HEIGHT_TYPE_AMSL גובה ה-AMSL נמדד ביחס לרמת הים הממוצעת.

מחיצות להתקנה

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

שדות
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: בפנים. 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 (מעלות), כולל. אופציונלי: מכשירים בקטגוריה A וכפופים למכשירים בקטגוריה B.
antenna_model

string

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

BoolValue

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

רשימת לקוחות

בקשה עבור ListCustomers.

שדות
page_size

int32

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

string

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

תשובה ללקוחות

תגובה עבור ListCustomers.

שדות
customers[]

Customer

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

string

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

הצגת רשימה של בקשות פריסה

בקשה עבור ListDeployments.

שדות
parent

string

חובה. שם המשאב ההורה, לדוגמה, "nodes/1", customer/1/nodes/2.
page_size

int32

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

string

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

string

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

הצגת רשימה של פריסות

תגובה עבור ListDeployments.

שדות
deployments[]

Deployment

deployments שתואם לבקשה.
next_page_token

string

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

הצגת בקשה למכשירים

בקשה עבור ListDevices.

שדות
parent

string

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

int32

המספר המקסימלי של מכשירים שניתן להחזיר בתגובה. אם ריק או אפס, כל המכשירים יוצגו. חייב להיות בטווח [0, 1000].
page_token

string

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

string

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

הצגת רשימה של מכשירי המכשירים

תגובה עבור 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). אם שדה ריק, לא יסוננו צמתים.

הצגת רשימה של NoNodesResponse

תגובה עבור ListNodes.

שדות
nodes[]

Node

nodes שתואם לבקשה.
next_page_token

string

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

יכולת מדידה

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

Enums
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

העברת פריסה

בקשה עבור MoveDeployment.

שדות
name

string

חובה. השם של deployment להעברה.
destination

string

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

העברת מכשיר

בקשה עבור 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

מזהי User-ID שבהם נעשה שימוש במכשירים ששייכים לצומת הזה.

מדיניות

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

שדות
assignments[]

Assignment

רשימה של assignments
etag

bytes

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

אם לא סופק ee בשיחה אל GetPolicy, המדיניות הקיימת תימחק באופן עיוור.

SetPolicyRequest

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

שדות
resource

string

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

Policy

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

בקשה של DeviceDevice

בקשה עבור SignDevice.

שדות
device

Device

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

בדיקת הרשאות

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

שדות
resource

string

חובה. המשאב שלגביו מבקשים את ההרשאות.
permissions[]

string

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

בדיקת הרשאות להרשאות

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

שדות
permissions[]

string

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

עדכון CustomerRequest

בקשה עבור UpdateCustomer.

שדות
customer

Customer

חובה. הערכים החדשים של customer. יש להגדיר את הלקוח name ואת display_name.
update_mask

FieldMask

שדות שיש לעדכן.

עדכון הפריסה

בקשה עבור UpdateDeployment.

שדות
deployment

Deployment

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

FieldMask

שדות שיש לעדכן.

עדכון DeviceDevice

בקשה עבור UpdateDevice.

שדות
device

Device

חובה. device לעדכון. חובה להגדיר את השדות device, name, fcc_id וגם serial_number. יש להגדיר את השדה user_id.
update_mask

FieldMask

שדות שיש לעדכן.

עדכון לא רצוי

בקשה עבור UpdateNode.

שדות
node

Node

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

FieldMask

שדות שיש לעדכן.

עדכון SignDeviceDeviceRequest

בקשה עבור UpdateSignedDevice.

שדות
name

string

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

bytes

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

string

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

אימות InstallInstaller

בקשה עבור ValidateInstaller.

שדות
installer_id

string

חובה. מזהה ייחודי של מנהל ההתקנה (מזהה עלות להתקנה) ממסד הנתונים של המתקינים המקצועיים המורשים.
secret

string

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

string

חובה. אסימון רשת מבוסס JSON נחתם באמצעות מפתח פרטי של עלות להתקנה (CPI). המטען הייעודי יכול לכלול תביעת "סודי" וטענה שערכיה הם סוד.

אימות מאמת ההתקנה

תגובה עבור ValidateInstaller.