Package software.amazon.awssdk.services.amplifyuibuilder.model

Class ApiConfiguration

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.ApiConfiguration

All Implemented Interfaces:

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

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

Describes the API configuration for a code generation job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApiConfiguration.Builder
static class	ApiConfiguration.Type

Method Summary

Modifier and Type	Method	Description
static ApiConfiguration.Builder	builder()
DataStoreRenderConfig	dataStoreConfig()	The configuration for an application using DataStore APIs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static ApiConfiguration	fromDataStoreConfig(Consumer<DataStoreRenderConfig.Builder> dataStoreConfig)	Create an instance of this class with dataStoreConfig() initialized to the given value.
static ApiConfiguration	fromDataStoreConfig(DataStoreRenderConfig dataStoreConfig)	Create an instance of this class with dataStoreConfig() initialized to the given value.
static ApiConfiguration	fromGraphQLConfig(Consumer<GraphQLRenderConfig.Builder> graphQLConfig)	Create an instance of this class with graphQLConfig() initialized to the given value.
static ApiConfiguration	fromGraphQLConfig(GraphQLRenderConfig graphQLConfig)	Create an instance of this class with graphQLConfig() initialized to the given value.
static ApiConfiguration	fromNoApiConfig(Consumer<NoApiRenderConfig.Builder> noApiConfig)	Create an instance of this class with noApiConfig() initialized to the given value.
static ApiConfiguration	fromNoApiConfig(NoApiRenderConfig noApiConfig)	Create an instance of this class with noApiConfig() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GraphQLRenderConfig	graphQLConfig()	The configuration for an application using GraphQL APIs.
int	hashCode()
NoApiRenderConfig	noApiConfig()	The configuration for an application with no API being used.
List<SdkField<?>>	sdkFields()
static Class<? extends ApiConfiguration.Builder>	serializableBuilderClass()
ApiConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ApiConfiguration.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

graphQLConfig

public final GraphQLRenderConfig graphQLConfig()

The configuration for an application using GraphQL APIs.

Returns:

The configuration for an application using GraphQL APIs.

dataStoreConfig

public final DataStoreRenderConfig dataStoreConfig()

The configuration for an application using DataStore APIs.

Returns:

The configuration for an application using DataStore APIs.

noApiConfig

public final NoApiRenderConfig noApiConfig()

The configuration for an application with no API being used.

Returns:

The configuration for an application with no API being used.

toBuilder

public ApiConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ApiConfiguration.Builder,ApiConfiguration>

builder

public static ApiConfiguration.Builder builder()

serializableBuilderClass

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

fromGraphQLConfig

public static ApiConfiguration fromGraphQLConfig(GraphQLRenderConfig graphQLConfig)

Create an instance of this class with graphQLConfig() initialized to the given value.

The configuration for an application using GraphQL APIs.

Parameters:

graphQLConfig - The configuration for an application using GraphQL APIs.

fromGraphQLConfig

public static ApiConfiguration fromGraphQLConfig(Consumer<GraphQLRenderConfig.Builder> graphQLConfig)

Create an instance of this class with graphQLConfig() initialized to the given value.

The configuration for an application using GraphQL APIs.

Parameters:

graphQLConfig - The configuration for an application using GraphQL APIs.

fromDataStoreConfig

public static ApiConfiguration fromDataStoreConfig(DataStoreRenderConfig dataStoreConfig)

Create an instance of this class with dataStoreConfig() initialized to the given value.

The configuration for an application using DataStore APIs.

Parameters:

dataStoreConfig - The configuration for an application using DataStore APIs.

fromDataStoreConfig

public static ApiConfiguration fromDataStoreConfig(Consumer<DataStoreRenderConfig.Builder> dataStoreConfig)

Create an instance of this class with dataStoreConfig() initialized to the given value.

The configuration for an application using DataStore APIs.

Parameters:

dataStoreConfig - The configuration for an application using DataStore APIs.

fromNoApiConfig

public static ApiConfiguration fromNoApiConfig(NoApiRenderConfig noApiConfig)

Create an instance of this class with noApiConfig() initialized to the given value.

The configuration for an application with no API being used.

Parameters:

noApiConfig - The configuration for an application with no API being used.

fromNoApiConfig

public static ApiConfiguration fromNoApiConfig(Consumer<NoApiRenderConfig.Builder> noApiConfig)

Create an instance of this class with noApiConfig() initialized to the given value.

The configuration for an application with no API being used.

Parameters:

noApiConfig - The configuration for an application with no API being used.

type

public ApiConfiguration.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ApiConfiguration.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ApiConfiguration.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo