Class: Aws::APIGateway::Types::GetSdkRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass GetSdkRequest data as a hash:

{
  rest_api_id: "String", # required
  stage_name: "String", # required
  sdk_type: "String", # required
  parameters: {
    "String" => "String",
  },
}

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#parameters ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) 


4083
4084
4085
4086
4087
4088
4089
4090
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4083

class GetSdkRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :sdk_type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) 


4083
4084
4085
4086
4087
4088
4089
4090
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4083

class GetSdkRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :sdk_type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#sdk_type ⇒ String

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

Returns:

  • (String) 


4083
4084
4085
4086
4087
4088
4089
4090
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4083

class GetSdkRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :sdk_type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#stage_name ⇒ String

[Required] The name of the Stage that the SDK will use.

Returns:

  • (String) 


4083
4084
4085
4086
4087
4088
4089
4090
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4083

class GetSdkRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :sdk_type,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end