[I] SdkEndpointParameter
Endpoint parameter type for the client.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Overrides | 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 |
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 |
doc? | string | Document for the type. | - | SdkModelPropertyTypeBase.doc |
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 | "endpoint" | - | - | - |
name | string | Parameter client name. | - | SdkModelPropertyTypeBase.name |
onClient | true | Endpoint parameter is always on client level. | SdkModelPropertyTypeBase.onClient | - |
optional | boolean | Whether the type is optional. | - | SdkModelPropertyTypeBase.optional |
serializedName? | string | Deprecated This property is deprecated. Use type.templateArguments[x].serializedName or type.variantTypes[x].templateArguments[x].serializedName instead. | - | - |
summary? | string | Summary for the type. | - | SdkModelPropertyTypeBase.summary |
type | | SdkEndpointType | SdkUnionType<SdkEndpointType> | Parameter type. | - | SdkModelPropertyTypeBase.type |
urlEncode | boolean | Whether do url encode for the endpoint string. | - | - |
visibility? | Visibility[] | Visibility of the type. | - | SdkModelPropertyTypeBase.visibility |