OperationSpec interface
Egy műveletet meghatározó specifikáció.
Tulajdonságok
| base |
A szolgáltatás specifikációjában megadott URL-cím. Ez továbbra is tartalmazza az ÖSSZES URL-sablonváltozót. Ha ez nem érhető el az OperationSpec létrehozásakor, akkor a ServiceClient egyik "baseUri" tulajdonsága tölti ki. |
| content |
A kérelem törzsének tartalomtípusa. Ez az érték a "Content-Type" fejlécként lesz használva, ha meg van adva. |
| form |
A műveletmetódus paraméterei, amelyek a művelet HTTP-kérésének űrlapadat törzsének létrehozásához lesznek felhasználva. |
| header |
A művelet metódusának paraméterei, amelyeket a művelet HTTP-kérése fejlécekké konvertál. |
| http |
A műveletre vonatkozó kérések által használandó HTTP-metódus. |
| isXML | Azt jelzi, hogy ez a művelet XML-kérés- és választörzseket használ-e. |
| path | A művelet URL-címének rögzített elérési útja. Ez továbbra is tartalmazza az ÖSSZES URL-sablonváltozót. |
| query |
A létrehozott URL-lekérdezéshez hozzáadandó műveleti módszer paraméterei. |
| request |
A HTTP-kérés törzsének létrehozásához használt paraméter. |
| responses | A művelet által visszaadott különböző típusú válaszok a visszaadott állapotkód alapján. |
| serializer | A műveletben használni kívánt szerializáló. |
| url |
A műveleti módszer azon paraméterei, amelyeket a létrehozott URL-címre cserélünk. |
Tulajdonság adatai
baseUrl
A szolgáltatás specifikációjában megadott URL-cím. Ez továbbra is tartalmazza az ÖSSZES URL-sablonváltozót. Ha ez nem érhető el az OperationSpec létrehozásakor, akkor a ServiceClient egyik "baseUri" tulajdonsága tölti ki.
baseUrl?: string
Tulajdonság értéke
string
contentType
A kérelem törzsének tartalomtípusa. Ez az érték a "Content-Type" fejlécként lesz használva, ha meg van adva.
contentType?: string
Tulajdonság értéke
string
formDataParameters
A műveletmetódus paraméterei, amelyek a művelet HTTP-kérésének űrlapadat törzsének létrehozásához lesznek felhasználva.
formDataParameters?: readonly OperationParameter[]
Tulajdonság értéke
readonly OperationParameter[]
headerParameters
A művelet metódusának paraméterei, amelyeket a művelet HTTP-kérése fejlécekké konvertál.
headerParameters?: readonly OperationParameter[]
Tulajdonság értéke
readonly OperationParameter[]
httpMethod
A műveletre vonatkozó kérések által használandó HTTP-metódus.
httpMethod: HttpMethods
Tulajdonság értéke
isXML
Azt jelzi, hogy ez a művelet XML-kérés- és választörzseket használ-e.
isXML?: boolean
Tulajdonság értéke
boolean
path
A művelet URL-címének rögzített elérési útja. Ez továbbra is tartalmazza az ÖSSZES URL-sablonváltozót.
path?: string
Tulajdonság értéke
string
queryParameters
A létrehozott URL-lekérdezéshez hozzáadandó műveleti módszer paraméterei.
queryParameters?: readonly OperationQueryParameter[]
Tulajdonság értéke
readonly OperationQueryParameter[]
requestBody
A HTTP-kérés törzsének létrehozásához használt paraméter.
requestBody?: OperationParameter
Tulajdonság értéke
responses
A művelet által visszaadott különböző típusú válaszok a visszaadott állapotkód alapján.
responses: {[responseCode: string]: OperationResponse}
Tulajdonság értéke
{[responseCode: string]: OperationResponse}
serializer
urlParameters
A műveleti módszer azon paraméterei, amelyeket a létrehozott URL-címre cserélünk.
urlParameters?: readonly OperationURLParameter[]
Tulajdonság értéke
readonly OperationURLParameter[]