get_sdk¶
Operation¶
async
¶
get_sdk(input: GetSdkInput, plugins: list[Plugin] | None = None) -> GetSdkOutput
Generates a client SDK for a RestApi and Stage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetSdkInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
GetSdkOutput
|
An instance of |
Input¶
dataclass
¶
Request a new generated client SDK for a RestApi and Stage.
Attributes¶
class-attribute
instance-attribute
¶
parameters: dict[str, str] | None = None
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.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
sdk_type: str | None = None
The language for the generated SDK. Currently java, javascript,
android, objectivec (for iOS), swift (for iOS), and ruby are
supported.
class-attribute
instance-attribute
¶
stage_name: str | None = None
The name of the Stage that the SDK will use.
Output¶
dataclass
¶
The binary blob response to GetSdk, which contains the generated SDK.
Attributes¶
class-attribute
instance-attribute
¶
body: bytes | None = None
The binary blob response to GetSdk, which contains the generated SDK.
class-attribute
instance-attribute
¶
content_disposition: str | None = None
The content-disposition header value in the HTTP response.
class-attribute
instance-attribute
¶
content_type: str | None = None
The content-type header value in the HTTP response.