Class RestConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RestConfiguration.Builder,RestConfiguration>
Configuration that defines HTTP request and response handling, validation endpoints, and entity configurations for REST API interactions.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic RestConfiguration.Builderbuilder()final Map<String,EntityConfiguration> A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final SourceConfigurationGlobal configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.final booleanFor responses, this returns true if the service returned a value for the EntityConfigurations property.final inthashCode()static Class<? extends RestConfiguration.Builder>final StringtoString()Returns a string representation of this object.final SourceConfigurationConfiguration for the endpoint used to validate connection credentials and test connectivity during connection creation.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
globalSourceConfiguration
Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.
- Returns:
- Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.
-
validationEndpointConfiguration
Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.
- Returns:
- Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.
-
hasEntityConfigurations
public final boolean hasEntityConfigurations()For responses, this returns true if the service returned a value for the EntityConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
entityConfigurations
A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.
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
hasEntityConfigurations()method.- Returns:
- A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<RestConfiguration.Builder,RestConfiguration>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-