Class KafkaSchemaRegistryConfig
- java.lang.Object
-
- software.amazon.awssdk.services.lambda.model.KafkaSchemaRegistryConfig
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<KafkaSchemaRegistryConfig.Builder,KafkaSchemaRegistryConfig>
@Generated("software.amazon.awssdk:codegen") public final class KafkaSchemaRegistryConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KafkaSchemaRegistryConfig.Builder,KafkaSchemaRegistryConfig>
Specific configuration settings for a Kafka schema registry.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
KafkaSchemaRegistryConfig.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<KafkaSchemaRegistryAccessConfig>
accessConfigs()
An array of access configuration objects that tell Lambda how to authenticate with your schema registry.static KafkaSchemaRegistryConfig.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
SchemaRegistryEventRecordFormat
eventRecordFormat()
The record format that Lambda delivers to your function after schema validation.String
eventRecordFormatAsString()
The record format that Lambda delivers to your function after schema validation.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAccessConfigs()
For responses, this returns true if the service returned a value for the AccessConfigs property.int
hashCode()
boolean
hasSchemaValidationConfigs()
For responses, this returns true if the service returned a value for the SchemaValidationConfigs property.String
schemaRegistryURI()
The URI for your schema registry.List<KafkaSchemaValidationConfig>
schemaValidationConfigs()
An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends KafkaSchemaRegistryConfig.Builder>
serializableBuilderClass()
KafkaSchemaRegistryConfig.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
-
schemaRegistryURI
public final String schemaRegistryURI()
The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
-
For Glue schema registries, use the ARN of the registry.
-
For Confluent schema registries, use the URL of the registry.
- Returns:
- The URI for your schema registry. The correct URI format depends on the type of schema registry you're
using.
-
For Glue schema registries, use the ARN of the registry.
-
For Confluent schema registries, use the URL of the registry.
-
-
-
eventRecordFormat
public final SchemaRegistryEventRecordFormat eventRecordFormat()
The record format that Lambda delivers to your function after schema validation.
-
Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. -
Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
If the service returns an enum value that is not available in the current SDK version,
eventRecordFormat
will returnSchemaRegistryEventRecordFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventRecordFormatAsString()
.- Returns:
- The record format that Lambda delivers to your function after schema validation.
-
Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. -
Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
-
- See Also:
SchemaRegistryEventRecordFormat
-
-
eventRecordFormatAsString
public final String eventRecordFormatAsString()
The record format that Lambda delivers to your function after schema validation.
-
Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. -
Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
If the service returns an enum value that is not available in the current SDK version,
eventRecordFormat
will returnSchemaRegistryEventRecordFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventRecordFormatAsString()
.- Returns:
- The record format that Lambda delivers to your function after schema validation.
-
Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. -
Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
-
- See Also:
SchemaRegistryEventRecordFormat
-
-
hasAccessConfigs
public final boolean hasAccessConfigs()
For responses, this returns true if the service returned a value for the AccessConfigs 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.
-
accessConfigs
public final List<KafkaSchemaRegistryAccessConfig> accessConfigs()
An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
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
hasAccessConfigs()
method.- Returns:
- An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
-
hasSchemaValidationConfigs
public final boolean hasSchemaValidationConfigs()
For responses, this returns true if the service returned a value for the SchemaValidationConfigs 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.
-
schemaValidationConfigs
public final List<KafkaSchemaValidationConfig> schemaValidationConfigs()
An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
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
hasSchemaValidationConfigs()
method.- Returns:
- An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
-
toBuilder
public KafkaSchemaRegistryConfig.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<KafkaSchemaRegistryConfig.Builder,KafkaSchemaRegistryConfig>
-
builder
public static KafkaSchemaRegistryConfig.Builder builder()
-
serializableBuilderClass
public static Class<? extends KafkaSchemaRegistryConfig.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-