Class CustomConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CustomConfiguration.Builder,CustomConfiguration>
Associates blueprints with a project to produce custom structured output. A fallback blueprint can be supplied for documents that do not match a primary blueprint.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List<BlueprintItem> The blueprints used to extract custom structured output.static CustomConfiguration.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List<BlueprintItem> The blueprint used when a document does not match any of the primary blueprints.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the Blueprints property.final booleanFor responses, this returns true if the service returned a value for the FallbackBlueprints property.final inthashCode()static Class<? extends CustomConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasBlueprints
public final boolean hasBlueprints()For responses, this returns true if the service returned a value for the Blueprints 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. -
blueprints
The blueprints used to extract custom structured output.
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
hasBlueprints()method.- Returns:
- The blueprints used to extract custom structured output.
-
hasFallbackBlueprints
public final boolean hasFallbackBlueprints()For responses, this returns true if the service returned a value for the FallbackBlueprints 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. -
fallbackBlueprints
The blueprint used when a document does not match any of the primary blueprints. Requires at least one blueprint in
Blueprints.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
hasFallbackBlueprints()method.- Returns:
- The blueprint used when a document does not match any of the primary blueprints. Requires at least one
blueprint in
Blueprints.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CustomConfiguration.Builder,CustomConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-