software.amazon.awssdk.services.apigateway.model

Class SdkConfigurationProperty

java.lang.Object

software.amazon.awssdk.services.apigateway.model.SdkConfigurationProperty

All Implemented Interfaces:

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

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

A configuration property of an SDK type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SdkConfigurationProperty.Builder

Method Summary

Modifier and Type	Method and Description
static SdkConfigurationProperty.Builder	builder()
String	defaultValue() The default value of an SdkType configuration property.
String	description() The description of an SdkType configuration property.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	friendlyName() The user-friendly name of an SdkType configuration property.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of a an SdkType configuration property.
Boolean	required() A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).
List<SdkField<?>>	sdkFields()
static Class<? extends SdkConfigurationProperty.Builder>	serializableBuilderClass()
SdkConfigurationProperty.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

name

public final String name()

The name of a an SdkType configuration property.

Returns:

The name of a an SdkType configuration property.

friendlyName

public final String friendlyName()

The user-friendly name of an SdkType configuration property.

Returns:

The user-friendly name of an SdkType configuration property.

description

public final String description()

The description of an SdkType configuration property.

Returns:

The description of an SdkType configuration property.

required

public final Boolean required()

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

Returns:

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

defaultValue

public final String defaultValue()

The default value of an SdkType configuration property.

Returns:

The default value of an SdkType configuration property.

toBuilder

public SdkConfigurationProperty.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<SdkConfigurationProperty.Builder,SdkConfigurationProperty>

Returns:

a builder for type T

builder

public static SdkConfigurationProperty.Builder builder()

serializableBuilderClass

public static Class<? extends SdkConfigurationProperty.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

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