Update digital twin javadocs to clarify that create APIs behave like …

…createOrUpdate APIs (Azure#16400)
stevewithington · Oct 16, 2020 · 8c86f66 · 8c86f66
1 parent b511c36
commit 8c86f66
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 12 deletions.
diff --git a/...-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsAsyncClient.java b/...-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsAsyncClient.java
@@ -93,7 +93,8 @@ public DigitalTwinsServiceVersion getServiceVersion() {
     //region Digital twin APIs
 
     /**
-     * Creates a digital twin.
+     * Creates a digital twin. If the provided digital twin Id is already in use, then this will attempt
+     * to replace the existing digital twin with the provided digital twin.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -119,7 +120,8 @@ public <T> Mono<T> createDigitalTwin(String digitalTwinId, T digitalTwin, Class<
     }
 
     /**
-     * Creates a digital twin.
+     * Creates a digital twin. If the provided digital twin Id is already in use, then this will attempt
+     * to replace the existing digital twin with the provided digital twin.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -332,7 +334,8 @@ Mono<Response<Void>> deleteDigitalTwinWithResponse(String digitalTwinId, DeleteD
     //region Relationship APIs
 
     /**
-     * Creates a relationship on a digital twin.
+     * Creates a relationship on a digital twin. If the provided relationship Id is already in use, then this will
+     * attempt to replace the existing relationship with the provided relationship.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -358,7 +361,8 @@ public <T> Mono<T> createRelationship(String digitalTwinId, String relationshipI
     }
 
     /**
-     * Creates a relationship on a digital twin.
+     * Creates a relationship on a digital twin. If the provided relationship Id is already in use, then this will
+     * attempt to replace the existing relationship with the provided relationship.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -1225,7 +1229,8 @@ <T> Mono<PagedResponse<T>> queryNextPage(String nextLink, Class<T> clazz, QueryO
     //region Event Route APIs
 
     /**
-     * Create an event route.
+     * Create an event route. If the provided eventRouteId is already in use, then this will attempt to replace the
+     * existing event route with the provided event route.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -1243,7 +1248,8 @@ public Mono<Void> createEventRoute(String eventRouteId, EventRoute eventRoute)
     }
 
     /**
-     * Create an event route.
+     * Create an event route. If the provided eventRouteId is already in use, then this will attempt to replace the
+     * existing event route with the provided event route.
      *
      * <p><strong>Code Samples</strong></p>
      *

diff --git a/...azure-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsClient.java b/...azure-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsClient.java
@@ -49,7 +49,8 @@ public DigitalTwinsServiceVersion getServiceVersion() {
     //region Digital twin APIs
 
     /**
-     * Creates a digital twin.
+     * Creates a digital twin. If the provided digital twin Id is already in use, then this will attempt
+     * to replace the existing digital twin with the provided digital twin.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -74,7 +75,8 @@ public <T> T createDigitalTwin(String digitalTwinId, T digitalTwin, Class<T> cla
     }
 
     /**
-     * Creates a digital twin.
+     * Creates a digital twin. If the provided digital twin Id is already in use, then this will attempt
+     * to replace the existing digital twin with the provided digital twin.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -235,7 +237,8 @@ public Response<Void> deleteDigitalTwinWithResponse(String digitalTwinId, Delete
     //region Relationship APIs
 
     /**
-     * Creates a relationship on a digital twin.
+     * Creates a relationship on a digital twin. If the provided relationship Id is already in use, then this will
+     * attempt to replace the existing relationship with the provided relationship.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -260,7 +263,8 @@ public <T> T createRelationship(String digitalTwinId, String relationshipId, T r
     }
 
     /**
-     * Creates a relationship on a digital twin.
+     * Creates a relationship on a digital twin. If the provided relationship Id is already in use, then this will
+     * attempt to replace the existing relationship with the provided relationship.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -791,7 +795,8 @@ public <T> PagedIterable<T> query(String query, Class<T> clazz, QueryOptions opt
 
     //region Event Route APIs
     /**
-     * Create an event route.
+     * Create an event route. If the provided eventRouteId is already in use, then this will attempt to replace the
+     * existing event route with the provided event route.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -806,7 +811,8 @@ public void createEventRoute(String eventRouteId, EventRoute eventRoute) {
     }
 
     /**
-     * Create an event route.
+     * Create an event route. If the provided eventRouteId is already in use, then this will attempt to replace the
+     * existing event route with the provided event route.
      *
      * <p><strong>Code Samples</strong></p>
      *