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 URL-sablon összes változójá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 lesz a "Content-Type" fejlécként használva, ha meg van adva. |
form |
A műveletmetódus paraméterei, amelyek a művelet HTTP-kéréséhez tartozó formdata-törzs létrehozásához lesznek felhasználva. |
header |
A művelet metódusának paraméterei, amelyek fejlécekké lesznek konvertálva a művelet HTTP-kérésében. |
http |
Az a HTTP-metódus, amelyet a művelet kéréseinek használniuk kell. |
isXML | Azt határozza meg, hogy ez a művelet XML-kérés- és választörzseket használ-e. |
media |
A kérelemtörzs médiatípusa. Ez az érték a szerializáláshoz használható, ha meg van adva. |
path | A művelet URL-címének rögzített elérési útja. Ez továbbra is tartalmazza az URL-sablon összes változóját. |
query |
A műveleti metódus paraméterei, amelyeket a rendszer hozzáad a létrehozott URL-cím lekérdezéséhez. |
request |
A HTTP-kérelem 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űvelethez használandó szerializáló. |
url |
A műveleti metódus paraméterei, amelyek a létrehozott URL-címmel lesznek helyettesítve. |
Tulajdonság adatai
baseUrl
A szolgáltatás specifikációjában megadott URL-cím. Ez továbbra is tartalmazza az URL-sablon összes változójá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 lesz a "Content-Type" fejlécként 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éhez tartozó formdata-törzs 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, amelyek fejlécekké lesznek konvertálva a művelet HTTP-kérésében.
headerParameters?: readonly OperationParameter[]
Tulajdonság értéke
readonly OperationParameter[]
httpMethod
Az a HTTP-metódus, amelyet a művelet kéréseinek használniuk kell.
httpMethod: HttpMethods
Tulajdonság értéke
isXML
Azt határozza meg, hogy ez a művelet XML-kérés- és választörzseket használ-e.
isXML?: boolean
Tulajdonság értéke
boolean
mediaType
A kérelemtörzs médiatípusa. Ez az érték a szerializáláshoz használható, ha meg van adva.
mediaType?: string
Tulajdonság értéke
string
path
A művelet URL-címének rögzített elérési útja. Ez továbbra is tartalmazza az URL-sablon összes változóját.
path?: string
Tulajdonság értéke
string
queryParameters
A műveleti metódus paraméterei, amelyeket a rendszer hozzáad a létrehozott URL-cím lekérdezéséhez.
queryParameters?: readonly OperationQueryParameter[]
Tulajdonság értéke
readonly OperationQueryParameter[]
requestBody
A HTTP-kérelem 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]: OperationResponseMap}
Tulajdonság értéke
{[responseCode: string]: OperationResponseMap}
serializer
urlParameters
A műveleti metódus paraméterei, amelyek a létrehozott URL-címmel lesznek helyettesítve.
urlParameters?: readonly OperationURLParameter[]
Tulajdonság értéke
readonly OperationURLParameter[]