class Amazonite::ApiGateway::GetSdkRequest

Overview

Request a new generated client SDK for a RestApi and Stage.

Included Modules

Defined in:

api_gateway/get_sdk_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(rest_api_id : String, stage_name : String, sdk_type : String, parameters : Hash(String, String) | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def parameters : Hash(String, String) | Nil #

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.


[View source]
def parameters=(parameters : Hash(String, String) | Nil) #

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.


[View source]
def rest_api_id : String #

The string identifier of the associated RestApi.


[View source]
def rest_api_id=(rest_api_id : String) #

The string identifier of the associated RestApi.


[View source]
def sdk_type : String #

The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.


[View source]
def sdk_type=(sdk_type : String) #

The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.


[View source]
def stage_name : String #

The name of the Stage that the SDK will use.


[View source]
def stage_name=(stage_name : String) #

The name of the Stage that the SDK will use.


[View source]
def validate! : Nil #

[View source]