Package software.amazon.awssdk.services.apigateway.model

Class SdkType

java.lang.Object

software.amazon.awssdk.services.apigateway.model.SdkType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SdkType.Builder,SdkType>

@Generated("software.amazon.awssdk:codegen")
public final class SdkType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SdkType.Builder,SdkType>

A type of SDK that API Gateway can generate.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SdkType.Builder

Method Summary

Modifier and Type	Method	Description
static SdkType.Builder	builder()
List<SdkConfigurationProperty>	configurationProperties()	A list of configuration properties of an SdkType.
String	description()	The description of an SdkType.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	friendlyName()	The user-friendly name of an SdkType instance.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConfigurationProperties()	For responses, this returns true if the service returned a value for the ConfigurationProperties property.
int	hashCode()
String	id()	The identifier of an SdkType instance.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SdkType.Builder>	serializableBuilderClass()
SdkType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The identifier of an SdkType instance.

Returns:

The identifier of an SdkType instance.

friendlyName

public final String friendlyName()

The user-friendly name of an SdkType instance.

Returns:

The user-friendly name of an SdkType instance.

description

public final String description()

The description of an SdkType.

Returns:

The description of an SdkType.

hasConfigurationProperties

public final boolean hasConfigurationProperties()

For responses, this returns true if the service returned a value for the ConfigurationProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

configurationProperties

public final List<SdkConfigurationProperty> configurationProperties()

A list of configuration properties of an SdkType.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConfigurationProperties() method.

Returns:

A list of configuration properties of an SdkType.

toBuilder

public SdkType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SdkType.Builder,SdkType>

builder

public static SdkType.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo