OperationSpec interface
操作を定義する仕様。
プロパティ
base |
サービスの仕様で提供された URL。 これでも、すべての URL テンプレート変数が含まれます。 OperationSpec の作成時にこれが指定されていない場合は、ServiceClient の "baseUri" プロパティによって設定されます。 |
content |
要求本文のコンテンツの種類。 この値が指定されている場合は、"Content-Type" ヘッダーとして使用されます。 |
form |
操作の HTTP 要求の formdata 本文を作成するために使用される操作メソッドのパラメーター。 |
header |
操作の HTTP 要求のヘッダーに変換される操作メソッドのパラメーター。 |
http |
この操作の要求で使用する必要がある HTTP メソッド。 |
isXML | この操作で XML 要求本文と応答本文を使用するかどうか。 |
media |
要求本文のメディアの種類。 この値は、指定されている場合にシリアル化を支援するために使用できます。 |
path | この操作の URL の固定パス。 これでも、すべての URL テンプレート変数が含まれます。 |
query |
構築された URL のクエリに追加される操作メソッドのパラメーター。 |
request |
HTTP 要求の本文を構築するために使用されるパラメーター。 |
responses | 返される状態コードに基づいて、この操作が返すことができるさまざまな種類の応答。 |
serializer | この操作で使用するシリアライザー。 |
url |
構築された URL に置き換えられる操作メソッドのパラメーター。 |
プロパティの詳細
baseUrl
サービスの仕様で提供された URL。 これでも、すべての URL テンプレート変数が含まれます。 OperationSpec の作成時にこれが指定されていない場合は、ServiceClient の "baseUri" プロパティによって設定されます。
baseUrl?: string
プロパティ値
string
contentType
要求本文のコンテンツの種類。 この値が指定されている場合は、"Content-Type" ヘッダーとして使用されます。
contentType?: string
プロパティ値
string
formDataParameters
操作の HTTP 要求の formdata 本文を作成するために使用される操作メソッドのパラメーター。
formDataParameters?: readonly OperationParameter[]
プロパティ値
readonly OperationParameter[]
headerParameters
操作の HTTP 要求のヘッダーに変換される操作メソッドのパラメーター。
headerParameters?: readonly OperationParameter[]
プロパティ値
readonly OperationParameter[]
httpMethod
isXML
この操作で XML 要求本文と応答本文を使用するかどうか。
isXML?: boolean
プロパティ値
boolean
mediaType
要求本文のメディアの種類。 この値は、指定されている場合にシリアル化を支援するために使用できます。
mediaType?: string
プロパティ値
string
path
この操作の URL の固定パス。 これでも、すべての URL テンプレート変数が含まれます。
path?: string
プロパティ値
string
queryParameters
構築された URL のクエリに追加される操作メソッドのパラメーター。
queryParameters?: readonly OperationQueryParameter[]
プロパティ値
readonly OperationQueryParameter[]
requestBody
responses
返される状態コードに基づいて、この操作が返すことができるさまざまな種類の応答。
responses: {[responseCode: string]: OperationResponseMap}
プロパティ値
{[responseCode: string]: OperationResponseMap}
serializer
urlParameters
構築された URL に置き換えられる操作メソッドのパラメーター。
urlParameters?: readonly OperationURLParameter[]
プロパティ値
readonly OperationURLParameter[]