get_sdk¶
Operation¶
get_sdk
¶
get_sdk(request: GetSdkInput | GetSdkInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSdkInputDict]) -> GetSdkOutput
Generates a client SDK for a RestApi and Stage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetSdkInput | GetSdkInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetSdkInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetSdkOutput
|
An instance of |
get_sdk
async
¶
get_sdk(request: GetSdkInput | GetSdkInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSdkInputDict]) -> GetSdkOutput
Generates a client SDK for a RestApi and Stage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetSdkInput | GetSdkInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetSdkInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetSdkOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetSdkInputDict
¶
Bases: TypedDict
Dictionary form of GetSdkInput.
Attributes¶
parameters
instance-attribute
¶
A string-to-string key-value map of query parameters sdkType-dependent
properties of the SDK. For sdkType of objectivec or swift, a
parameter named classPrefix is required. For sdkType of android,
parameters named groupId, artifactId, artifactVersion, and
invokerPackage are required. For sdkType of java, parameters named
serviceName and javaPackageName are required.
rest_api_id
instance-attribute
¶
The string identifier of the associated RestApi.
sdk_type
instance-attribute
¶
The language for the generated SDK. Currently java, javascript,
android, objectivec (for iOS), swift (for iOS), and ruby are
supported.
GetSdkInput
dataclass
¶
Bases: _SerdeShape
Request a new generated client SDK for a RestApi and Stage.
Attributes¶
parameters
class-attribute
instance-attribute
¶
A string-to-string key-value map of query parameters sdkType-dependent
properties of the SDK. For sdkType of objectivec or swift, a
parameter named classPrefix is required. For sdkType of android,
parameters named groupId, artifactId, artifactVersion, and
invokerPackage are required. For sdkType of java, parameters named
serviceName and javaPackageName are required.
rest_api_id
class-attribute
instance-attribute
¶
rest_api_id: str | None = ...
The string identifier of the associated RestApi.
Output¶
GetSdkOutput
dataclass
¶
Bases: _SerdeShape
The binary blob response to GetSdk, which contains the generated SDK.
Attributes¶
body
class-attribute
instance-attribute
¶
body: bytes | None = ...
The binary blob response to GetSdk, which contains the generated SDK.
content_disposition
class-attribute
instance-attribute
¶
content_disposition: str | None = ...
The content-disposition header value in the HTTP response.
content_type
class-attribute
instance-attribute
¶
content_type: str | None = ...
The content-type header value in the HTTP response.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.