software.amazon.awssdk.services.apigateway.model

Class GetSdkRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.GetSdkRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSdkRequest.Builder,GetSdkRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSdkRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<GetSdkRequest.Builder,GetSdkRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSdkRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetSdkRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Map<String,String>	parameters() A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK.
String	restApiId() [Required] The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
String	sdkType() [Required] The language for the generated SDK.
static Class<? extends GetSdkRequest.Builder>	serializableBuilderClass()
String	stageName() [Required] The name of the Stage that the SDK will use.
GetSdkRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

restApiId

public String restApiId()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

stageName

public String stageName()

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

Returns:

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

sdkType

public String sdkType()

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

Returns:

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

parameters

public Map<String,String> parameters()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

toBuilder

public GetSdkRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetSdkRequest.Builder,GetSdkRequest>

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static GetSdkRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetSdkRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.