OperationSpec interface
Спецификация, определяющая операцию.
Свойства
base |
URL-адрес, указанный в спецификации службы. В нем по-прежнему будут содержаться все переменные шаблона URL-адреса. Если этот параметр не указан при создании OperationSpec, он будет заполнен свойством baseUri в ServiceClient. |
content |
Тип контента для текста запроса. Это значение будет использоваться в качестве заголовка Content-Type, если оно указано. |
form |
Параметры метода операции, которые будут использоваться для создания тела formdata для HTTP-запроса операции. |
header |
Параметры метода операции, которые будут преобразованы в заголовки HTTP-запроса операции. |
http |
Метод HTTP, который должен использоваться в запросах для этой операции. |
isXML | Указывает, используется ли в этой операции текст запроса и ответа XML. |
path | Фиксированный путь к URL-адресу этой операции. В нем по-прежнему будут содержаться все переменные шаблона URL-адреса. |
query |
Параметры метода операции, которые будут добавлены в запрос созданного URL-адреса. |
request |
Параметр, который будет использоваться для создания текста HTTP-запроса. |
responses | Различные типы ответов, которые эта операция может возвращать в зависимости от того, какой код состояния возвращается. |
serializer | Сериализатор, используемый в этой операции. |
url |
Параметры метода операции, которые будут заменены в сконструированный URL-адрес. |
Сведения о свойстве
baseUrl
URL-адрес, указанный в спецификации службы. В нем по-прежнему будут содержаться все переменные шаблона URL-адреса. Если этот параметр не указан при создании OperationSpec, он будет заполнен свойством baseUri в ServiceClient.
baseUrl?: string
Значение свойства
string
contentType
Тип контента для текста запроса. Это значение будет использоваться в качестве заголовка Content-Type, если оно указано.
contentType?: string
Значение свойства
string
formDataParameters
Параметры метода операции, которые будут использоваться для создания тела formdata для HTTP-запроса операции.
formDataParameters?: readonly OperationParameter[]
Значение свойства
readonly OperationParameter[]
headerParameters
Параметры метода операции, которые будут преобразованы в заголовки HTTP-запроса операции.
headerParameters?: readonly OperationParameter[]
Значение свойства
readonly OperationParameter[]
httpMethod
Метод HTTP, который должен использоваться в запросах для этой операции.
httpMethod: HttpMethods
Значение свойства
isXML
Указывает, используется ли в этой операции текст запроса и ответа XML.
isXML?: boolean
Значение свойства
boolean
path
Фиксированный путь к URL-адресу этой операции. В нем по-прежнему будут содержаться все переменные шаблона URL-адреса.
path?: string
Значение свойства
string
queryParameters
Параметры метода операции, которые будут добавлены в запрос созданного URL-адреса.
queryParameters?: readonly OperationQueryParameter[]
Значение свойства
readonly OperationQueryParameter[]
requestBody
Параметр, который будет использоваться для создания текста HTTP-запроса.
requestBody?: OperationParameter
Значение свойства
responses
Различные типы ответов, которые эта операция может возвращать в зависимости от того, какой код состояния возвращается.
responses: {[responseCode: string]: OperationResponse}
Значение свойства
{[responseCode: string]: OperationResponse}
serializer
urlParameters
Параметры метода операции, которые будут заменены в сконструированный URL-адрес.
urlParameters?: readonly OperationURLParameter[]
Значение свойства
readonly OperationURLParameter[]