OperationSpec interface
مواصفات تحدد عملية.
الخصائص
base |
عنوان URL الذي تم توفيره في مواصفات الخدمة. سيظل هذا يحتوي على جميع متغيرات قالب URL فيه. إذا لم يتم توفير هذا عند إنشاء OperationSpec، فسيتم ملؤه بواسطة خاصية "baseUri" على ServiceClient. |
content |
نوع محتوى نص الطلب. سيتم استخدام هذه القيمة كعنوان "نوع المحتوى" إذا تم توفيرها. |
form |
معلمات أسلوب العملية التي سيتم استخدامها لإنشاء نص بيانات النموذج لطلب HTTP الخاص بالعملية. |
header |
المعلمات إلى أسلوب العملية التي سيتم تحويلها إلى رؤوس على طلب HTTP الخاص بالعملية. |
http |
أسلوب HTTP الذي يجب استخدامه بواسطة طلبات هذه العملية. |
isXML | ما إذا كانت هذه العملية تستخدم هيئات طلب واستجابة XML أم لا. |
media |
نوع الوسائط لنص الطلب. يمكن استخدام هذه القيمة للمساعدة في التسلسل إذا تم توفيرها. |
path | المسار الثابت لعنون URL الخاص بهذه العملية. سيظل هذا يحتوي على جميع متغيرات قالب URL فيه. |
query |
المعلمات إلى أسلوب العملية التي ستتم إضافتها إلى استعلام URL الذي تم إنشاؤه. |
request |
المعلمة التي سيتم استخدامها لإنشاء نص طلب HTTP. |
responses | أنواع الاستجابات المختلفة التي يمكن أن ترجعها هذه العملية استنادا إلى رمز الحالة الذي يتم إرجاعه. |
serializer | المتسلسل المراد استخدامه في هذه العملية. |
url |
المعلمات لأسلوب العملية التي سيتم استبدالها في عنوان URL الذي تم إنشاؤه. |
تفاصيل الخاصية
baseUrl
عنوان URL الذي تم توفيره في مواصفات الخدمة. سيظل هذا يحتوي على جميع متغيرات قالب URL فيه. إذا لم يتم توفير هذا عند إنشاء OperationSpec، فسيتم ملؤه بواسطة خاصية "baseUri" على ServiceClient.
baseUrl?: string
قيمة الخاصية
string
contentType
نوع محتوى نص الطلب. سيتم استخدام هذه القيمة كعنوان "نوع المحتوى" إذا تم توفيرها.
contentType?: string
قيمة الخاصية
string
formDataParameters
معلمات أسلوب العملية التي سيتم استخدامها لإنشاء نص بيانات النموذج لطلب HTTP الخاص بالعملية.
formDataParameters?: readonly OperationParameter[]
قيمة الخاصية
readonly OperationParameter[]
headerParameters
المعلمات إلى أسلوب العملية التي سيتم تحويلها إلى رؤوس على طلب HTTP الخاص بالعملية.
headerParameters?: readonly OperationParameter[]
قيمة الخاصية
readonly OperationParameter[]
httpMethod
أسلوب HTTP الذي يجب استخدامه بواسطة طلبات هذه العملية.
httpMethod: HttpMethods
قيمة الخاصية
isXML
ما إذا كانت هذه العملية تستخدم هيئات طلب واستجابة XML أم لا.
isXML?: boolean
قيمة الخاصية
boolean
mediaType
نوع الوسائط لنص الطلب. يمكن استخدام هذه القيمة للمساعدة في التسلسل إذا تم توفيرها.
mediaType?: string
قيمة الخاصية
string
path
المسار الثابت لعنون URL الخاص بهذه العملية. سيظل هذا يحتوي على جميع متغيرات قالب URL فيه.
path?: string
قيمة الخاصية
string
queryParameters
المعلمات إلى أسلوب العملية التي ستتم إضافتها إلى استعلام URL الذي تم إنشاؤه.
queryParameters?: readonly OperationQueryParameter[]
قيمة الخاصية
readonly OperationQueryParameter[]
requestBody
المعلمة التي سيتم استخدامها لإنشاء نص طلب HTTP.
requestBody?: OperationParameter
قيمة الخاصية
responses
أنواع الاستجابات المختلفة التي يمكن أن ترجعها هذه العملية استنادا إلى رمز الحالة الذي يتم إرجاعه.
responses: {[responseCode: string]: OperationResponseMap}
قيمة الخاصية
{[responseCode: string]: OperationResponseMap}
serializer
urlParameters
المعلمات لأسلوب العملية التي سيتم استبدالها في عنوان URL الذي تم إنشاؤه.
urlParameters?: readonly OperationURLParameter[]
قيمة الخاصية
readonly OperationURLParameter[]