OperationSpec interface
A specification that defines how to perform a particular service operation over HTTP, including how to properly serialize request information into and deserialize response information into an object payload returnable by the ServiceClient.
Properties
| base |
The URL that was provided in the service's specification. This will still have all of the URL template variables in it. If this is not provided when the OperationSpec is created, then it will be populated by a "baseUri" property on the ServiceClient. |
| content |
The content type of the request body. This value will be used as the "Content-Type" header if it is provided. |
| form |
The parameters to the operation method that will be used to create a formdata body for the operation's HTTP request. |
| header |
The parameters to the operation method that will be converted to headers on the operation's HTTP request. |
| http |
The HTTP method that should be used by requests for this operation. |
| isXML | Whether or not this operation uses XML request and response bodies. |
| media |
The media type of the request body. This value can be used to aide in serialization if it is provided. |
| path | The fixed path for this operation's URL. This will still have all of the URL template variables in it. |
| query |
The parameters to the operation method that will be added to the constructed URL's query. |
| request |
The parameter that will be used to construct the HTTP request's body. |
| responses | The different types of responses that this operation can return based on what status code is returned. |
| serializer | The serializer to use in this operation. |
| url |
The parameters to the operation method that will be substituted into the constructed URL. |
Property Details
baseUrl
The URL that was provided in the service's specification. This will still have all of the URL template variables in it. If this is not provided when the OperationSpec is created, then it will be populated by a "baseUri" property on the ServiceClient.
baseUrl?: stringProperty Value
string
contentType
The content type of the request body. This value will be used as the "Content-Type" header if it is provided.
contentType?: stringProperty Value
string
formDataParameters
The parameters to the operation method that will be used to create a formdata body for the operation's HTTP request.
formDataParameters?: readonly OperationParameter[]Property Value
readonly OperationParameter[]
headerParameters
The parameters to the operation method that will be converted to headers on the operation's HTTP request.
headerParameters?: readonly OperationParameter[]Property Value
readonly OperationParameter[]
httpMethod
The HTTP method that should be used by requests for this operation.
httpMethod: HttpMethodsProperty Value
isXML
Whether or not this operation uses XML request and response bodies.
isXML?: booleanProperty Value
boolean
mediaType
The media type of the request body. This value can be used to aide in serialization if it is provided.
mediaType?: stringProperty Value
string
path
The fixed path for this operation's URL. This will still have all of the URL template variables in it.
path?: stringProperty Value
string
queryParameters
The parameters to the operation method that will be added to the constructed URL's query.
queryParameters?: readonly OperationQueryParameter[]Property Value
readonly OperationQueryParameter[]
requestBody
The parameter that will be used to construct the HTTP request's body.
requestBody?: OperationParameterProperty Value
responses
The different types of responses that this operation can return based on what status code is returned.
responses: {[responseCode: string]: OperationResponse}Property Value
{[responseCode: string]: OperationResponse}
serializer
urlParameters
The parameters to the operation method that will be substituted into the constructed URL.
urlParameters?: readonly OperationURLParameter[]Property Value
readonly OperationURLParameter[]