Azure · conniey · Mar 8, 2022 · Mar 8, 2022 · Mar 10, 2022 · Mar 10, 2022
diff --git a/eng/versioning/version_client.txt b/eng/versioning/version_client.txt
@@ -354,8 +354,8 @@ unreleased_com.azure:azure-aot-graalvm-support;1.0.0-beta.1
 unreleased_com.azure:azure-aot-graalvm-support-netty;1.0.0-beta.1
 unreleased_com.azure:azure-aot-graalvm-perf;1.0.0-beta.1
 
-
 unreleased_com.azure:azure-core-amqp;2.5.0-beta.1
+unreleased_com.azure:azure-core-experimental;1.0.0-beta.26
 
 # Released Beta dependencies: Copy the entry from above, prepend "beta_", remove the current
 # version and set the version to the released beta. Released beta dependencies are only valid

@@ -6,6 +6,8 @@
 
 ### Breaking Changes
 
+- Changed `com.azure.core.experimental.models.MessageWithMetadata` to `BinaryContent`.
+
 ### Bugs Fixed
 
 ### Other Changes

@@ -10,7 +10,7 @@
  * An abstraction for a message containing a content type along with its data.
  */
 @Fluent
-public class MessageWithMetadata {
+public class BinaryContent {
     private BinaryData binaryData;
     private String contentType;
 
@@ -28,9 +28,9 @@ public BinaryData getBodyAsBinaryData() {
      *
      * @param binaryData The message body.
      *
-     * @return The updated {@link MessageWithMetadata} object.
+     * @return The updated {@link BinaryContent} object.
      */
-    public MessageWithMetadata setBodyAsBinaryData(BinaryData binaryData) {
+    public BinaryContent setBodyAsBinaryData(BinaryData binaryData) {
         this.binaryData = binaryData;
         return this;
     }
@@ -49,9 +49,9 @@ public String getContentType() {
      *
      * @param contentType The content type.
      *
-     * @return The updated {@link MessageWithMetadata} object.
+     * @return The updated {@link BinaryContent} object.
      */
-    public MessageWithMetadata setContentType(String contentType) {
+    public BinaryContent setContentType(String contentType) {
         this.contentType = contentType;
         return this;
     }

@@ -9,16 +9,16 @@
 import static org.junit.jupiter.api.Assertions.assertNull;
 
 /**
- * Tests for {@link MessageWithMetadata}
+ * Tests for {@link BinaryContent}
  */
-public class MessageWithMetadataTest {
+public class BinaryContentTest {
     /**
      * Verify default parameters.
      */
     @Test
     public void initialize() {
         // Act
-        final MessageWithMetadata message = new MessageWithMetadata();
+        final BinaryContent message = new BinaryContent();
 
         // Assert
         assertNull(message.getBodyAsBinaryData(), "'body' should initially be null.");
@@ -33,10 +33,10 @@ public void settingProperties() {
         // Arrange
         final BinaryData binaryData = BinaryData.fromString("foo.bar.baz");
         final String contentType = "some-content";
-        final MessageWithMetadata message = new MessageWithMetadata();
+        final BinaryContent message = new BinaryContent();
 
         // Act
-        final MessageWithMetadata actual = message.setContentType(contentType)
+        final BinaryContent actual = message.setContentType(contentType)
             .setBodyAsBinaryData(binaryData);
 
         // Assert

@@ -6,6 +6,11 @@
 
 ### Breaking Changes
 
+- Changed `SchemaRegistryApacheAvroEncoder` to deserialize `BinaryContent`.
+- Changed `SchemaRegistryApacheAvroEncoder` to `SchemaRegistryApacheAvroSerializer`.
+- Changed `decodeMessageData` and `decodeMessageDataAsync` to `deserializeMessageData` and `deserializeMessageDataAsync`.
+- Changed `encodeMessageData` and `encodeMessageDataAsync` to `serializeMessageData` and `serializeMessageDataAsync`.
+
 ### Bugs Fixed
 
 ### Other Changes
@@ -14,7 +19,7 @@
 
 ### Features Added
 
-- Changed `SchemaRegistryApacheAvroEncoder` to deserialize `MessageWithMetadata` rather than tied to a binary format 
+- Changed `SchemaRegistryApacheAvroEncoder` to deserialize `MessageWithMetadata` rather than tied to a binary format
   with preamble. Backwards compatibility with preamble format supported for this release. See issue #26449.
 
 ### Breaking Changes

@@ -72,11 +72,11 @@ SchemaRegistryAsyncClient schemaRegistryAsyncClient = new SchemaRegistryClientBu
 
 #### Create `SchemaRegistryAvroSerializer` through the builder
 
-```java readme-sample-createSchemaRegistryAvroEncoder
-SchemaRegistryApacheAvroEncoder encoder = new SchemaRegistryApacheAvroEncoderBuilder()
+```java readme-sample-createSchemaRegistryAvroSerializer
+SchemaRegistryApacheAvroSerializer serializer = new SchemaRegistryApacheAvroSerializerBuilder()
     .schemaRegistryAsyncClient(schemaRegistryAsyncClient)
     .schemaGroup("{schema-group}")
-    .buildEncoder();
+    .buildSerializer();
 ```
 
 ## Key concepts
@@ -105,14 +105,14 @@ The serializer in this library creates messages in a wire format. The format is
 ### Serialize
 Serialize a strongly-typed object into Schema Registry-compatible avro payload.
 
-```java readme-sample-encodeSample
+```java readme-sample-serializeSample
 PlayingCard playingCard = new PlayingCard();
 playingCard.setPlayingCardSuit(PlayingCardSuit.SPADES);
 playingCard.setIsFaceCard(false);
 playingCard.setCardValue(5);
 
-MessageWithMetadata message = encoder.encodeMessageData(playingCard,
-    TypeReference.createInstance(MessageWithMetadata.class));
+BinaryContent message = serializer.serializeMessageData(playingCard,
+    TypeReference.createInstance(BinaryContent.class));
 ```
 
 The avro type `PlayingCard` is available in samples package
@@ -121,10 +121,10 @@ The avro type `PlayingCard` is available in samples package
 ### Deserialize
 Deserialize a Schema Registry-compatible avro payload into a strongly-type object.
 
-```java readme-sample-decodeSample
-SchemaRegistryApacheAvroEncoder encoder = createAvroSchemaRegistryEncoder();
-MessageWithMetadata message = getSchemaRegistryAvroMessage();
-PlayingCard playingCard = encoder.decodeMessageData(message, TypeReference.createInstance(PlayingCard.class));
+```java readme-sample-deserializeSample
+SchemaRegistryApacheAvroSerializer serializer = createAvroSchemaRegistrySerializer();
+BinaryContent message = getSchemaRegistryAvroMessage();
+PlayingCard playingCard = serializer.deserializeMessageData(message, TypeReference.createInstance(PlayingCard.class));
 ```
 
 ## Troubleshooting

@@ -44,10 +44,15 @@
   </properties>
 
   <dependencies>
+    <dependency>
+      <groupId>com.azure</groupId>
+      <artifactId>azure-core</artifactId>
+      <version>1.26.0</version> <!-- {x-version-update;com.azure:azure-core;dependency} -->
+    </dependency>
     <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-core-experimental</artifactId>
-      <version>1.0.0-beta.25</version> <!-- {x-version-update;com.azure:azure-core-experimental;dependency} -->
+      <version>1.0.0-beta.26</version> <!-- {x-version-update;unreleased_com.azure:azure-core-experimental;dependency} -->
     </dependency>
     <dependency>
       <groupId>com.azure</groupId>

@@ -3,7 +3,7 @@
 
 package com.azure.data.schemaregistry.apacheavro;
 
-import com.azure.core.experimental.models.MessageWithMetadata;
+import com.azure.core.experimental.models.BinaryContent;
 import com.azure.core.util.BinaryData;
 import com.azure.core.util.CoreUtils;
 import com.azure.core.util.logging.ClientLogger;
@@ -28,13 +28,13 @@
 /**
  * Schema Registry-based serializer implementation for Avro data format using Apache Avro.
  */
-public final class SchemaRegistryApacheAvroEncoder {
+public final class SchemaRegistryApacheAvroSerializer {
     static final String AVRO_MIME_TYPE = "avro/binary";
     static final byte[] RECORD_FORMAT_INDICATOR = new byte[]{0x00, 0x00, 0x00, 0x00};
     static final int RECORD_FORMAT_INDICATOR_SIZE = RECORD_FORMAT_INDICATOR.length;
     static final int SCHEMA_ID_SIZE = 32;
 
-    private final ClientLogger logger = new ClientLogger(SchemaRegistryApacheAvroEncoder.class);
+    private final ClientLogger logger = new ClientLogger(SchemaRegistryApacheAvroSerializer.class);
     private final SchemaRegistryAsyncClient schemaRegistryClient;
     private final AvroSerializer avroSerializer;
     private final SerializerOptions serializerOptions;
@@ -46,7 +46,7 @@ public final class SchemaRegistryApacheAvroEncoder {
      * @param avroSerializer Serializer implemented using Apache Avro.
      * @param serializerOptions Options to configure the serializer with.
      */
-    SchemaRegistryApacheAvroEncoder(SchemaRegistryAsyncClient schemaRegistryClient,
+    SchemaRegistryApacheAvroSerializer(SchemaRegistryAsyncClient schemaRegistryClient,
         AvroSerializer avroSerializer, SerializerOptions serializerOptions) {
         this.schemaRegistryClient = Objects.requireNonNull(schemaRegistryClient,
             "'schemaRegistryClient' cannot be null.");
@@ -60,7 +60,7 @@ public final class SchemaRegistryApacheAvroEncoder {
      *
      * @param object Object to encode.
      * @param typeReference Type of message to create.
-     * @param <T> Concrete type of {@link MessageWithMetadata}.
+     * @param <T> Concrete type of {@link BinaryContent}.
      *
      * @return The message encoded or {@code null} if the message could not be encoded.
      *
@@ -70,8 +70,8 @@ public final class SchemaRegistryApacheAvroEncoder {
      *     encoding the object.
      * @throws NullPointerException if the {@code object} is null or {@code typeReference} is null.
      */
-    public <T extends MessageWithMetadata> T encodeMessageData(Object object, TypeReference<T> typeReference) {
-        return encodeMessageDataAsync(object, typeReference).block();
+    public <T extends BinaryContent> T serializeMessageData(Object object, TypeReference<T> typeReference) {
+        return serializeMessageDataAsync(object, typeReference).block();
     }
 
     /**
@@ -80,7 +80,7 @@ public <T extends MessageWithMetadata> T encodeMessageData(Object object, TypeRe
      * @param object Object to encode.
      * @param typeReference Type of message to create.
      * @param messageFactory Factory to create an instance given the serialized Avro.
-     * @param <T> Concrete type of {@link MessageWithMetadata}.
+     * @param <T> Concrete type of {@link BinaryContent}.
      *
      * @return The message encoded or {@code null} if the message could not be encoded.
      *
@@ -90,17 +90,17 @@ public <T extends MessageWithMetadata> T encodeMessageData(Object object, TypeRe
      *     encoding the object.
      * @throws NullPointerException if the {@code object} is null or {@code typeReference} is null.
      */
-    public <T extends MessageWithMetadata> T encodeMessageData(Object object, TypeReference<T> typeReference,
+    public <T extends BinaryContent> T serializeMessageData(Object object, TypeReference<T> typeReference,
         Function<BinaryData, T> messageFactory) {
-        return encodeMessageDataAsync(object, typeReference, messageFactory).block();
+        return serializeMessageDataAsync(object, typeReference, messageFactory).block();
     }
 
     /**
      * Encodes an object into a message.
      *
      * @param object Object to encode.
      * @param typeReference Type of message to create.
-     * @param <T> Concrete type of {@link MessageWithMetadata}.
+     * @param <T> Concrete type of {@link BinaryContent}.
      *
      * @return A Mono that completes with the encoded message.
      *
@@ -110,10 +110,10 @@ public <T extends MessageWithMetadata> T encodeMessageData(Object object, TypeRe
      *     encoding the object.
      * @throws NullPointerException if the {@code object} is null or {@code typeReference} is null.
      */
-    public <T extends MessageWithMetadata> Mono<T> encodeMessageDataAsync(Object object,
+    public <T extends BinaryContent> Mono<T> serializeMessageDataAsync(Object object,
         TypeReference<T> typeReference) {
 
-        return encodeMessageDataAsync(object, typeReference, null);
+        return serializeMessageDataAsync(object, typeReference, null);
     }
 
     /**
@@ -123,7 +123,7 @@ public <T extends MessageWithMetadata> Mono<T> encodeMessageDataAsync(Object obj
      * @param typeReference Type of message to create.
      * @param messageFactory Factory to create an instance given the serialized Avro. If null is passed in, then the
      *     no argument constructor will be used.
-     * @param <T> Concrete type of {@link MessageWithMetadata}.
+     * @param <T> Concrete type of {@link BinaryContent}.
      *
      * @return A Mono that completes with the encoded message.
      *
@@ -133,7 +133,7 @@ public <T extends MessageWithMetadata> Mono<T> encodeMessageDataAsync(Object obj
      *     encoding the object.
      * @throws NullPointerException if the {@code object} is null or {@code typeReference} is null.
      */
-    public <T extends MessageWithMetadata> Mono<T> encodeMessageDataAsync(Object object,
+    public <T extends BinaryContent> Mono<T> serializeMessageDataAsync(Object object,
         TypeReference<T> typeReference, Function<BinaryData, T> messageFactory) {
 
         if (object == null) {
@@ -193,29 +193,29 @@ public <T extends MessageWithMetadata> Mono<T> encodeMessageDataAsync(Object obj
      *
      * @param message Object to encode.
      * @param typeReference Message to encode to.
-     * @param <T> Concrete type of {@link MessageWithMetadata}.
+     * @param <T> Concrete type of {@link BinaryContent}.
      *
      * @return The message encoded.
      *
      * @throws NullPointerException if {@code message} or {@code typeReference} is null.
      */
-    public <T> T decodeMessageData(MessageWithMetadata message, TypeReference<T> typeReference) {
-        return decodeMessageDataAsync(message, typeReference).block();
+    public <T> T deserializeMessageData(BinaryContent message, TypeReference<T> typeReference) {
+        return deserializeMessageDataAsync(message, typeReference).block();
     }
 
     /**
      * Decodes a message into its object.
      *
      * @param message Object to encode.
      * @param typeReference Message to encode to.
-     * @param <T> Concrete type of {@link MessageWithMetadata}.
+     * @param <T> Concrete type of {@link BinaryContent}.
      *
      * @return A Mono that completes when the message encoded. If {@code message.getBodyAsBinaryData()} is null or
      *     empty, then an empty Mono is returned.
      *
      * @throws NullPointerException if {@code message} or {@code typeReference} is null.
      */
-    public <T> Mono<T> decodeMessageDataAsync(MessageWithMetadata message, TypeReference<T> typeReference) {
+    public <T> Mono<T> deserializeMessageDataAsync(BinaryContent message, TypeReference<T> typeReference) {
         if (message == null) {
             return monoError(logger, new NullPointerException("'message' cannot be null."));
         } else if (typeReference == null) {
@@ -282,10 +282,10 @@ public <T> Mono<T> decodeMessageDataAsync(MessageWithMetadata message, TypeRefer
             contents.reset();
         }
 
-        return decodeMessageDataAsync(schemaId, contents, typeReference);
+        return deserializeMessageDataAsync(schemaId, contents, typeReference);
     }
 
-    private <T> Mono<T> decodeMessageDataAsync(String schemaId, ByteBuffer buffer, TypeReference<T> typeReference) {
+    private <T> Mono<T> deserializeMessageDataAsync(String schemaId, ByteBuffer buffer, TypeReference<T> typeReference) {
         return this.schemaRegistryClient.getSchema(schemaId)
             .handle((registryObject, sink) -> {
                 final byte[] payloadSchema = registryObject.getDefinition().getBytes(StandardCharsets.UTF_8);
@@ -305,7 +305,7 @@ private <T> Mono<T> decodeMessageDataAsync(String schemaId, ByteBuffer buffer, T
      * @throws RuntimeException if an instance of {@code T} could not be instantiated.
      */
     @SuppressWarnings("unchecked")
-    private static <T extends MessageWithMetadata> T createNoArgumentInstance(TypeReference<T> typeReference) {
+    private static <T extends BinaryContent> T createNoArgumentInstance(TypeReference<T> typeReference) {
 
         final Optional<Constructor<?>> constructor =
             Arrays.stream(typeReference.getJavaClass().getDeclaredConstructors())