You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

Instance Attribute Summary collapse

Instance Attribute Details

#parametersHash<String,String>

A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType of objectivec, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required.

Returns:

  • (Hash<String,String>)


3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3347

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3347

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

#sdk_typeString

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

Returns:

  • (String)


3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3347

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

#stage_nameString

The name of the Stage that the SDK will use.

Returns:

  • (String)


3347
3348
3349
3350
3351
3352
3353
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3347

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