[Metrics Advisor] Renamed Feedback API's (Azure#17240)

Author: samvaity

sdk/metricsadvisor/azure-ai-metricsadvisor/CHANGELOG.md

@@ -14,6 +14,9 @@
 - Renamed property `confidenceScore` to `contributionScore` and its accessors on `IncidentRootCause` model.
 - Removed model `ListMetricSeriesData` as top and skip parameters are not valid for this API.
 - Moved `startTime` and `endTime` to positional arguments on several methods as they are required.
+- Renamed Data feed ingestion granularity type to `"PerMinute"` and `"PerSecond"` instead of `"Minutely"` and `"Secondly"`.
+- Renamed Feedback api's from `createMetricFeedback`, `getMetricFeedback` and `listMetricFeedbacks` 
+to `addFeedback`, `getFeedback` and `listFeedback` respectively.
 
 ## 1.0.0-beta.1 (2020-10-07)
 Version 1.0.0-beta.1 is a preview of our efforts in creating a Azure Metrics Advisor client library that is developer-friendly

sdk/metricsadvisor/azure-ai-metricsadvisor/README.md

@@ -301,7 +301,7 @@ gracefully by catching the exception and display the additional information abou
 <!-- embedme ./src/samples/java/com/azure/ai/metricsadvisor/ReadmeSamples.java#L256-L260 -->
 ```java
 try {
-    metricsAdvisorClient.getMetricFeedback("non_existing_feedback_id");
+    metricsAdvisorClient.getFeedback("non_existing_feedback_id");
 } catch (HttpResponseException e) {
     System.out.println(e.getMessage());
 }

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/MetricsAdvisorAsyncClient.java

@@ -1273,7 +1273,7 @@ private Mono<PagedResponse<AnomalyIncident>> listIncidentsForAlertNextPageAsync(
      * Create a new metric feedback.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.createMetricFeedback#String-MetricFeedback}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.addFeeddback#String-MetricFeedback}
      *
      * @param metricId the unique id for which the feedback needs to be submitted.
      * @param metricFeedback the actual metric feedback.
@@ -1282,15 +1282,15 @@ private Mono<PagedResponse<AnomalyIncident>> listIncidentsForAlertNextPageAsync(
      * @throws NullPointerException If {@code metricId}, {@code metricFeedback.dimensionFilter} is null.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<MetricFeedback> createMetricFeedback(String metricId, MetricFeedback metricFeedback) {
-        return createMetricFeedbackWithResponse(metricId, metricFeedback).flatMap(FluxUtil::toMono);
+    public Mono<MetricFeedback> addFeeddback(String metricId, MetricFeedback metricFeedback) {
+        return addFeedbackWithResponse(metricId, metricFeedback).flatMap(FluxUtil::toMono);
     }
 
     /**
      * Create a new metric feedback.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.createMetricFeedbackWithResponse#String-MetricFeedback}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.addFeedbackWithResponse#String-MetricFeedback}
      *
      * @param metricId the unique id for which the feedback needs to be submitted.
      * @param metricFeedback the actual metric feedback.
@@ -1300,16 +1300,16 @@ public Mono<MetricFeedback> createMetricFeedback(String metricId, MetricFeedback
      * {@code metricFeedback.dimensionFilter} is null.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<Response<MetricFeedback>> createMetricFeedbackWithResponse(String metricId,
+    public Mono<Response<MetricFeedback>> addFeedbackWithResponse(String metricId,
         MetricFeedback metricFeedback) {
         try {
-            return withContext(context -> createMetricFeedbackWithResponse(metricId, metricFeedback, context));
+            return withContext(context -> addFeedbackWithResponse(metricId, metricFeedback, context));
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
         }
     }
 
-    Mono<Response<MetricFeedback>> createMetricFeedbackWithResponse(String metricId, MetricFeedback metricFeedback,
+    Mono<Response<MetricFeedback>> addFeedbackWithResponse(String metricId, MetricFeedback metricFeedback,
         Context context) {
         Objects.requireNonNull(metricId, "'metricId' is required.");
         Objects.requireNonNull(metricFeedback, "'metricFeedback' is required.");
@@ -1388,15 +1388,15 @@ Mono<Response<MetricFeedback>> createMetricFeedbackWithResponse(String metricId,
         }
         return service.createMetricFeedbackWithResponseAsync(innerMetricFeedback, context)
             .flatMap(createdMetricFeedbackResponse ->
-                getMetricFeedbackWithResponse(parseOperationId(createdMetricFeedbackResponse
+                getFeedbackWithResponse(parseOperationId(createdMetricFeedbackResponse
                     .getDeserializedHeaders().getLocation())));
     }
 
     /**
      * Get a metric feedback by its id.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.getMetricFeedback#String}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.getFeedback#String}
      *
      * @param feedbackId The metric feedback unique id.
      *
@@ -1405,15 +1405,15 @@ Mono<Response<MetricFeedback>> createMetricFeedbackWithResponse(String metricId,
      * @throws NullPointerException thrown if the {@code feedbackId} is null.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<MetricFeedback> getMetricFeedback(String feedbackId) {
-        return getMetricFeedbackWithResponse(feedbackId).flatMap(FluxUtil::toMono);
+    public Mono<MetricFeedback> getFeedback(String feedbackId) {
+        return getFeedbackWithResponse(feedbackId).flatMap(FluxUtil::toMono);
     }
 
     /**
      * Get a metric feedback by its id.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.getMetricFeedbackWithResponse#String}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.getFeedbackWithResponse#String}
      *
      * @param feedbackId The metric feedback unique id.
      *
@@ -1422,15 +1422,15 @@ public Mono<MetricFeedback> getMetricFeedback(String feedbackId) {
      * @throws NullPointerException thrown if the {@code feedbackId} is null.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<Response<MetricFeedback>> getMetricFeedbackWithResponse(String feedbackId) {
+    public Mono<Response<MetricFeedback>> getFeedbackWithResponse(String feedbackId) {
         try {
-            return withContext(context -> getMetricFeedbackWithResponse(feedbackId, context));
+            return withContext(context -> getFeedbackWithResponse(feedbackId, context));
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
         }
     }
 
-    Mono<Response<MetricFeedback>> getMetricFeedbackWithResponse(String feedbackId, Context context) {
+    Mono<Response<MetricFeedback>> getFeedbackWithResponse(String feedbackId, Context context) {
         Objects.requireNonNull(feedbackId, "'feedbackId' is required.");
         return service.getMetricFeedbackWithResponseAsync(UUID.fromString(feedbackId), context)
             .map(metricFeedbackResponse -> new SimpleResponse<>(metricFeedbackResponse,
@@ -1441,7 +1441,7 @@ Mono<Response<MetricFeedback>> getMetricFeedbackWithResponse(String feedbackId,
      * List information of metrics feedback on the account for a metric Id.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.listMetricFeedbacks#String}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.listFeedback#String}
      *
      * @param metricId the unique metric Id.
      *
@@ -1452,15 +1452,15 @@ Mono<Response<MetricFeedback>> getMetricFeedbackWithResponse(String feedbackId,
      * @throws NullPointerException thrown if the {@code metricId} is null.
      */
     @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<MetricFeedback> listMetricFeedbacks(String metricId) {
-        return listMetricFeedbacks(metricId, null);
+    public PagedFlux<MetricFeedback> listFeedback(String metricId) {
+        return listFeedback(metricId, null);
     }
 
     /**
      * List information of all metric feedbacks on the metrics advisor account for a metric Id.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.listMetricFeedbacks#String-ListMetricFeedbackOptions}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorAsyncClient.listFeedback#String-ListMetricFeedbackOptions}
      *
      * @param metricId the unique metric Id.
      * @param options The configurable {@link ListMetricFeedbackOptions options} to pass for filtering the output
@@ -1473,7 +1473,7 @@ public PagedFlux<MetricFeedback> listMetricFeedbacks(String metricId) {
      * @throws NullPointerException thrown if the {@code metricId} is null.
      */
     @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<MetricFeedback> listMetricFeedbacks(
+    public PagedFlux<MetricFeedback> listFeedback(
         String metricId,
         ListMetricFeedbackOptions options) {
         options = options != null ? options : new ListMetricFeedbackOptions();
@@ -1492,7 +1492,7 @@ public PagedFlux<MetricFeedback> listMetricFeedbacks(
         }
     }
 
-    PagedFlux<MetricFeedback> listMetricFeedbacks(String metricId, ListMetricFeedbackOptions options, Context context) {
+    PagedFlux<MetricFeedback> listFeedback(String metricId, ListMetricFeedbackOptions options, Context context) {
         options = options != null ? options : new ListMetricFeedbackOptions();
         final MetricFeedbackFilter metricFeedbackFilter = MetricFeedbackTransforms.toInnerFilter(metricId, options);
         final ListMetricFeedbackOptions finalOptions = options;

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/MetricsAdvisorClient.java

@@ -628,7 +628,7 @@ public PagedIterable<AnomalyIncident> listIncidentsForAlert(
      * Create a new metric feedback.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.createMetricFeedback#String-MetricFeedback}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.addFeeddback#String-MetricFeedback}
      *
      * @param metricId the unique id for which the feedback needs to be submitted.
      * @param metricFeedback the actual metric feedback.
@@ -637,15 +637,15 @@ public PagedIterable<AnomalyIncident> listIncidentsForAlert(
      * @throws NullPointerException If {@code metricId}, {@code metricFeedback.dimensionFilter} is null.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public MetricFeedback createMetricFeedback(String metricId, MetricFeedback metricFeedback) {
+    public MetricFeedback addFeedback(String metricId, MetricFeedback metricFeedback) {
         return createMetricFeedbackWithResponse(metricId, metricFeedback, Context.NONE).getValue();
     }
 
     /**
      * Create a new metric feedback.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.createMetricFeedbackWithResponse#String-MetricFeedback-Context}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.addFeedbackWithResponse#String-MetricFeedback-Context}
      *
      * @param metricId the unique id for which the feedback needs to be submitted.
      * @param metricFeedback the actual metric feedback.
@@ -657,14 +657,14 @@ public MetricFeedback createMetricFeedback(String metricId, MetricFeedback metri
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Response<MetricFeedback> createMetricFeedbackWithResponse(String metricId, MetricFeedback metricFeedback,
         Context context) {
-        return client.createMetricFeedbackWithResponse(metricId, metricFeedback, context).block();
+        return client.addFeedbackWithResponse(metricId, metricFeedback, context).block();
     }
 
     /**
      * Get a metric feedback by its id.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.getMetricFeedback#String}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.getFeedback#String}
      *
      * @param feedbackId The metric feedback unique id.
      *
@@ -673,15 +673,15 @@ public Response<MetricFeedback> createMetricFeedbackWithResponse(String metricId
      * @throws NullPointerException thrown if the {@code feedbackId} is null.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public MetricFeedback getMetricFeedback(String feedbackId) {
-        return getMetricFeedbackWithResponse(feedbackId, Context.NONE).getValue();
+    public MetricFeedback getFeedback(String feedbackId) {
+        return getFeedbackWithResponse(feedbackId, Context.NONE).getValue();
     }
 
     /**
      * Get a metric feedback by its id.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.getMetricFeedbackWithResponse#String-Context}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.getFeedbackWithResponse#String-Context}
      *
      * @param feedbackId The metric feedback unique id.
      * @param context Additional context that is passed through the HTTP pipeline during the service call.
@@ -691,15 +691,15 @@ public MetricFeedback getMetricFeedback(String feedbackId) {
      * @throws NullPointerException thrown if the {@code feedbackId} is null.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Response<MetricFeedback> getMetricFeedbackWithResponse(String feedbackId, Context context) {
-        return client.getMetricFeedbackWithResponse(feedbackId, context).block();
+    public Response<MetricFeedback> getFeedbackWithResponse(String feedbackId, Context context) {
+        return client.getFeedbackWithResponse(feedbackId, context).block();
     }
 
     /**
      * List information of all metric feedbacks on the metrics advisor account.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.listMetricFeedbacks#String}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.listFeedback#String}
      *
      * @param metricId the unique metric Id.
      *
@@ -710,16 +710,16 @@ public Response<MetricFeedback> getMetricFeedbackWithResponse(String feedbackId,
      * @throws NullPointerException thrown if the {@code metricId} is null.
      */
     @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedIterable<MetricFeedback> listMetricFeedbacks(
+    public PagedIterable<MetricFeedback> listFeedback(
         String metricId) {
-        return listMetricFeedbacks(metricId, null, Context.NONE);
+        return listFeedback(metricId, null, Context.NONE);
     }
 
     /**
      * List information of all metric feedbacks on the metrics advisor account.
      *
      * <p><strong>Code sample</strong></p>
-     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.listMetricFeedbacks#String-ListMetricFeedbackOptions-Context}
+     * {@codesnippet com.azure.ai.metricsadvisor.MetricsAdvisorClient.listFeedback#String-ListMetricFeedbackOptions-Context}
      *
      * @param metricId the unique metric Id.
      * @param options The configurable {@link ListMetricFeedbackOptions options} to pass for filtering the output
@@ -733,10 +733,10 @@ public PagedIterable<MetricFeedback> listMetricFeedbacks(
      * @throws NullPointerException thrown if the {@code metricId} is null.
      */
     @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedIterable<MetricFeedback> listMetricFeedbacks(
+    public PagedIterable<MetricFeedback> listFeedback(
         String metricId,
         ListMetricFeedbackOptions options, Context context) {
-        return new PagedIterable<>(client.listMetricFeedbacks(metricId, options,
+        return new PagedIterable<>(client.listFeedback(metricId, options,
             context == null ? Context.NONE : context));
     }
 

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/implementation/models/CreateMetricFeedbackResponse.java

@@ -8,7 +8,7 @@
 import com.azure.core.http.HttpRequest;
 import com.azure.core.http.rest.ResponseBase;
 
-/** Contains all response data for the createMetricFeedback operation. */
+/** Contains all response data for the addFeeddback operation. */
 public final class CreateMetricFeedbackResponse extends ResponseBase<CreateMetricFeedbackHeaders, Void> {
     /**
      * Creates an instance of CreateMetricFeedbackResponse.

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/models/DataFeedGranularityType.java

@@ -39,12 +39,12 @@ public final class DataFeedGranularityType extends ExpandableStringEnum<DataFeed
     /**
      * Static value Minutely for DataFeedGranularityType.
      */
-    public static final DataFeedGranularityType MINUTELY = fromString("Minutely");
+    public static final DataFeedGranularityType PER_MINUTE = fromString("Minutely");
 
     /**
      * Static value Secondly for DataFeedGranularityType.
      */
-    public static final DataFeedGranularityType SECONDLY = fromString("Secondly");
+    public static final DataFeedGranularityType PER_SECOND = fromString("Secondly");
 
     /**
      * Static value Custom for DataFeedGranularityType.

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/models/MetricFeedback.java

@@ -93,7 +93,7 @@ public FeedbackType getFeedbackType() {
     }
 
     /**
-     * Get the dimensionFilter.
+     * Get the series keys value for the feedback.
      *
      * @return the dimensionFilter value.
      */
@@ -104,7 +104,7 @@ public DimensionKey getDimensionFilter() {
     /**
      * Set the series keys value for the feedback.
      *
-     * @param dimensionFilter the dimensionFilter value.
+     * @param dimensionFilter the dimensionFilter value to set.
      *
      * @return the MetricFeedback object itself.
      */

sdk/metricsadvisor/azure-ai-metricsadvisor/src/samples/java/com/azure/ai/metricsadvisor/MetricFeedbackAsyncSample.java

@@ -39,7 +39,7 @@ public static void main(String[] args) {
 
         System.out.printf("Creating Metric Feedback%n");
         final Mono<MetricFeedback> createdFeedbackMono
-            = advisorAsyncClient.createMetricFeedback(metricId, metricChangePointFeedback);
+            = advisorAsyncClient.addFeeddback(metricId, metricChangePointFeedback);
 
         createdFeedbackMono
             .doOnSubscribe(__ ->
@@ -50,7 +50,7 @@ public static void main(String[] args) {
         // Retrieve the metric feedback that just created.
         Mono<MetricFeedback> fetchFeedbackMono =
             createdFeedbackMono.flatMap(createdFeedback -> {
-                return advisorAsyncClient.getMetricFeedback(createdFeedback.getId())
+                return advisorAsyncClient.getFeedback(createdFeedback.getId())
                     .doOnSubscribe(__ ->
                         System.out.printf("Fetching Metric Feedback: %s%n", createdFeedback.getId()))
                     .doOnSuccess(config ->
@@ -85,7 +85,7 @@ public static void main(String[] args) {
 
         // List metric feedbacks.
         System.out.printf("Listing metric feedbacks%n");
-        advisorAsyncClient.listMetricFeedbacks(metricId)
+        advisorAsyncClient.listFeedback(metricId)
             .doOnNext(feedbackItem -> {
                 System.out.printf("Metric Feedback Id : %s%n", feedbackItem.getId());
                 System.out.printf("Metric Feedback created time : %s%n", feedbackItem.getCreatedTime());