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:

  • Method Details

    • 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 return SchemaRegistryEventRecordFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventRecordFormatAsString().

      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:

    • 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 return SchemaRegistryEventRecordFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventRecordFormatAsString().

      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:

    • 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 the isEmpty() 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 the isEmpty() 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()
      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<KafkaSchemaRegistryConfig.Builder,KafkaSchemaRegistryConfig>
      Returns:
      a builder for type T

    • builder

      public static KafkaSchemaRegistryConfig.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.