[I] SdkBodyParameter

Http body parameter.

Extends

• SdkModelPropertyTypeBase

Properties

Property	Type	Description	Inherited from
__raw?	ModelProperty	-	SdkModelPropertyTypeBase.__raw
access	AccessFlags	Whether the type has public or private accessibility	SdkModelPropertyTypeBase.access
apiVersions	string[]	API versions supported for current type.	SdkModelPropertyTypeBase.apiVersions
clientDefaultValue?	unknown	Client level default value for the type.	SdkModelPropertyTypeBase.clientDefaultValue
contentTypes	string[]	-	-
correspondingMethodParams	( | SdkMethodParameter | SdkModelPropertyType)[]	Deprecated This property is deprecated. Use methodParameterSegments instead. Corresponding method level parameter or model property for current parameter.	-
crossLanguageDefinitionId	string	Unique ID for the current type.	SdkModelPropertyTypeBase.crossLanguageDefinitionId
decorators	DecoratorInfo[]	Client types sourced from TypeSpec decorated types will have this generic decoratores list. Only decorators in allowed list will be included in this list. Language’s emitter could set additionalDecorators in the option when createSdkContext to extend the allowed list.	SdkModelPropertyTypeBase.decorators
defaultContentType	string	-	-
doc?	string	Document for the type.	SdkModelPropertyTypeBase.doc
encode?	ArrayKnownEncoding	How to encode the property on wire.	SdkModelPropertyTypeBase.encode
flatten	boolean	Whether this property could be flattened	SdkModelPropertyTypeBase.flatten
isApiVersionParam	boolean	Whether the type is an API version parameter	SdkModelPropertyTypeBase.isApiVersionParam
isGeneratedName	boolean	Whether name is created by TCGC.	SdkModelPropertyTypeBase.isGeneratedName
kind	"body"	-	-
methodParameterSegments	( | SdkMethodParameter | SdkModelPropertyType)[][]	Segments to indicate the complete path from method parameters to this HTTP parameter. Each inner array represents a complete path from method parameter to the final HTTP parameter. For body parameters with spread, there can be multiple paths.	-
name	string	Parameter client name.	SdkModelPropertyTypeBase.name
onClient	boolean	Whether the type is on client level.	SdkModelPropertyTypeBase.onClient
optional	boolean	Whether the type is optional.	SdkModelPropertyTypeBase.optional
serializedName	string	Name for the parameter in the payload	-
streamMetadata?	SdkStreamMetadata	Stream metadata, present when the body is a streaming type (e.g. JsonlStream, SSEStream).	-
summary?	string	Summary for the type.	SdkModelPropertyTypeBase.summary
type	SdkType	Parameter type.	SdkModelPropertyTypeBase.type
visibility?	Visibility[]	Visibility of the type.	SdkModelPropertyTypeBase.visibility