Azure Monitor Logs Query: Rename QueryTimeInterval to LogsQueryTimeInterval (#46099)

* Azure Monitor Logs Query: Rename QueryTimeInterval to LogsQueryTimeInterval

* fix javadocs

Author: srnagar

sdk/monitor/azure-monitor-query-logs/README.md

@@ -153,7 +153,7 @@ LogsQueryClient logsQueryClient = new LogsQueryClientBuilder()
     .buildClient();
 
 LogsQueryResult queryResults = logsQueryClient.queryWorkspace("{workspace-id}", "{kusto-query}",
-    new QueryTimeInterval(Duration.ofDays(2)));
+    new LogsQueryTimeInterval(Duration.ofDays(2)));
 
 for (LogsTableRow row : queryResults.getTable().getRows()) {
     System.out.println(row.getColumnValue("OperationName") + " " + row.getColumnValue("ResourceGroup"));
@@ -183,7 +183,7 @@ LogsQueryClient logsQueryClient = new LogsQueryClientBuilder()
     .buildClient();
 
 List<CustomLogModel> customLogModels = logsQueryClient.queryWorkspace("{workspace-id}", "{kusto-query}",
-    new QueryTimeInterval(Duration.ofDays(2)), CustomLogModel.class);
+    new LogsQueryTimeInterval(Duration.ofDays(2)), CustomLogModel.class);
 
 for (CustomLogModel customLogModel : customLogModels) {
     System.out.println(customLogModel.getOperationName() + " " + customLogModel.getResourceGroup());
@@ -222,7 +222,7 @@ LogsQueryClient logsQueryClient = new LogsQueryClientBuilder()
     .buildClient();
 
 LogsQueryResult queryResults = logsQueryClient.queryResource("{resource-id}", "{kusto-query}",
-    new QueryTimeInterval(Duration.ofDays(2)));
+    new LogsQueryTimeInterval(Duration.ofDays(2)));
 
 for (LogsTableRow row : queryResults.getTable().getRows()) {
     System.out.println(row.getColumnValue("OperationName") + " " + row.getColumnValue("ResourceGroup"));
@@ -237,9 +237,9 @@ LogsQueryClient logsQueryClient = new LogsQueryClientBuilder()
     .buildClient();
 
 LogsBatchQuery logsBatchQuery = new LogsBatchQuery();
-String query1 = logsBatchQuery.addWorkspaceQuery("{workspace-id}", "{query-1}", new QueryTimeInterval(Duration.ofDays(2)));
-String query2 = logsBatchQuery.addWorkspaceQuery("{workspace-id}", "{query-2}", new QueryTimeInterval(Duration.ofDays(30)));
-String query3 = logsBatchQuery.addWorkspaceQuery("{workspace-id}", "{query-3}", new QueryTimeInterval(Duration.ofDays(10)));
+String query1 = logsBatchQuery.addWorkspaceQuery("{workspace-id}", "{query-1}", new LogsQueryTimeInterval(Duration.ofDays(2)));
+String query2 = logsBatchQuery.addWorkspaceQuery("{workspace-id}", "{query-2}", new LogsQueryTimeInterval(Duration.ofDays(30)));
+String query3 = logsBatchQuery.addWorkspaceQuery("{workspace-id}", "{query-3}", new LogsQueryTimeInterval(Duration.ofDays(10)));
 
 LogsBatchQueryResultCollection batchResults = logsQueryClient
     .queryBatchWithResponse(logsBatchQuery, Context.NONE).getValue();
@@ -274,7 +274,7 @@ LogsQueryOptions options = new LogsQueryOptions()
     .setServerTimeout(Duration.ofMinutes(10));
 
 Response<LogsQueryResult> response = logsQueryClient.queryWorkspaceWithResponse("{workspace-id}",
-    "{kusto-query}", new QueryTimeInterval(Duration.ofDays(2)), options, Context.NONE);
+    "{kusto-query}", new LogsQueryTimeInterval(Duration.ofDays(2)), options, Context.NONE);
 ```
 
 #### Query multiple workspaces
@@ -292,7 +292,7 @@ LogsQueryClient logsQueryClient = new LogsQueryClientBuilder()
     .buildClient();
 
 Response<LogsQueryResult> response = logsQueryClient.queryWorkspaceWithResponse("{workspace-id}", "{kusto-query}",
-    new QueryTimeInterval(Duration.ofDays(2)), new LogsQueryOptions()
+    new LogsQueryTimeInterval(Duration.ofDays(2)), new LogsQueryOptions()
         .setAdditionalWorkspaces(Arrays.asList("{additional-workspace-identifiers}")),
     Context.NONE);
 LogsQueryResult result = response.getValue();
@@ -314,7 +314,7 @@ LogsQueryClient client = new LogsQueryClientBuilder()
 LogsQueryOptions options = new LogsQueryOptions()
     .setIncludeStatistics(true);
 Response<LogsQueryResult> response = client.queryWorkspaceWithResponse("{workspace-id}",
-    "AzureActivity | top 10 by TimeGenerated", QueryTimeInterval.LAST_1_HOUR, options, Context.NONE);
+    "AzureActivity | top 10 by TimeGenerated", LogsQueryTimeInterval.LAST_1_HOUR, options, Context.NONE);
 LogsQueryResult result = response.getValue();
 BinaryData statistics = result.getStatistics();
 
@@ -359,7 +359,7 @@ String visualizationQuery = "StormEvents"
 LogsQueryOptions options = new LogsQueryOptions()
     .setIncludeVisualization(true);
 Response<LogsQueryResult> response = client.queryWorkspaceWithResponse("{workspace-id}", visualizationQuery,
-    QueryTimeInterval.LAST_7_DAYS, options, Context.NONE);
+    LogsQueryTimeInterval.LAST_7_DAYS, options, Context.NONE);
 LogsQueryResult result = response.getValue();
 BinaryData visualization = result.getVisualization();
 

sdk/monitor/azure-monitor-query-logs/TROUBLESHOOTING.md

@@ -163,7 +163,7 @@ LogsQueryClient client = new LogsQueryClientBuilder()
     .credential(credential)
     .buildClient();
 
-client.queryWorkspaceWithResponse("{workspaceId}", "{kusto-query-string}", QueryTimeInterval.LAST_DAY,
+client.queryWorkspaceWithResponse("{workspaceId}", "{kusto-query-string}", LogsQueryTimeInterval.LAST_DAY,
     new LogsQueryOptions().setServerTimeout(Duration.ofMinutes(10)), Context.NONE);
 ```
 
@@ -188,6 +188,6 @@ behavior off and consume the partially successful response, you can set the `all
 in `LogsQueryOptions` as shown below:
 
 ```java readme-sample-allowpartialerrors
-client.queryWorkspaceWithResponse("{workspaceId}", "{kusto-query-string}", QueryTimeInterval.LAST_DAY,
+client.queryWorkspaceWithResponse("{workspaceId}", "{kusto-query-string}", LogsQueryTimeInterval.LAST_DAY,
     new LogsQueryOptions().setAllowPartialErrors(true), Context.NONE);
 ```

sdk/monitor/azure-monitor-query-logs/src/main/java/com/azure/monitor/query/logs/LogsQueryAsyncClient.java

@@ -25,7 +25,7 @@
 import com.azure.monitor.query.logs.models.LogsQueryOptions;
 import com.azure.monitor.query.logs.models.LogsQueryResult;
 import com.azure.monitor.query.logs.models.LogsQueryResultStatus;
-import com.azure.monitor.query.logs.models.QueryTimeInterval;
+import com.azure.monitor.query.logs.models.LogsQueryTimeInterval;
 import reactor.core.publisher.Mono;
 import reactor.core.publisher.SynchronousSink;
 
@@ -67,10 +67,10 @@
  *
  * <ul>
  *     <li>
- *         {@link LogsQueryAsyncClient#queryWorkspace(String, String, QueryTimeInterval) queryWorkspace(String, String, QueryTimeInterval)} - Query logs from a workspace.
+ *         {@link LogsQueryAsyncClient#queryWorkspace(String, String, LogsQueryTimeInterval) queryWorkspace(String, String, LogsQueryTimeInterval)} - Query logs from a workspace.
  *     </li>
  *     <li>
- *         {@link LogsQueryAsyncClient#queryWorkspaceWithResponse(String, String, QueryTimeInterval, LogsQueryOptions) queryWorkspaceWithResponse(String, String, QueryTimeInterval, LogsQueryOptions)} - Query logs from a workspace using query options with service response returned.
+ *         {@link LogsQueryAsyncClient#queryWorkspaceWithResponse(String, String, LogsQueryTimeInterval, LogsQueryOptions) queryWorkspaceWithResponse(String, String, LogsQueryTimeInterval, LogsQueryOptions)} - Query logs from a workspace using query options with service response returned.
  *     </li>
  *     <li>
  *         {@link LogsQueryAsyncClient#queryBatch(LogsBatchQuery) queryBatch(LogsBatchQuery)} - Execute a batch of logs queries.
@@ -79,10 +79,10 @@
  *         {@link LogsQueryAsyncClient#queryBatchWithResponse(LogsBatchQuery) queryBatchWithResponse(LogsBatchQuery)} - Execute a batch of logs queries with service response returned.
  *     </li>
  *     <li>
- *         {@link LogsQueryAsyncClient#queryResource(String, String, QueryTimeInterval) queryResource(String, String, QueryTimeInterval)} - Query logs for an Azure resource.
+ *         {@link LogsQueryAsyncClient#queryResource(String, String, LogsQueryTimeInterval) queryResource(String, String, LogsQueryTimeInterval)} - Query logs for an Azure resource.
  *     </li>
  *     <li>
- *         {@link LogsQueryAsyncClient#queryResourceWithResponse(String, String, QueryTimeInterval, LogsQueryOptions) queryResourceWithResponse(String, String, QueryTimeInterval, LogsQueryOptions)} - Query logs for an Azure resource using query options with service response returned.
+ *         {@link LogsQueryAsyncClient#queryResourceWithResponse(String, String, LogsQueryTimeInterval, LogsQueryOptions) queryResourceWithResponse(String, String, LogsQueryTimeInterval, LogsQueryOptions)} - Query logs for an Azure resource using query options with service response returned.
  *     </li>
  * </ul>
  *
@@ -109,7 +109,7 @@ public final class LogsQueryAsyncClient {
      * <!-- src_embed com.azure.monitor.query.LogsQueryAsyncClient.query#String-String-QueryTimeInterval -->
      * <pre>
      * Mono&lt;LogsQueryResult&gt; queryResult = logsQueryAsyncClient.queryWorkspace&#40;&quot;&#123;workspace-id&#125;&quot;, &quot;&#123;kusto-query&#125;&quot;,
-     *         QueryTimeInterval.LAST_DAY&#41;;
+     *         LogsQueryTimeInterval.LAST_DAY&#41;;
      * queryResult.subscribe&#40;result -&gt; &#123;
      *     for &#40;LogsTableRow row : result.getTable&#40;&#41;.getRows&#40;&#41;&#41; &#123;
      *         System.out.println&#40;row.getRow&#40;&#41;
@@ -127,7 +127,7 @@ public final class LogsQueryAsyncClient {
      * @return The logs matching the query.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<LogsQueryResult> queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval) {
+    public Mono<LogsQueryResult> queryWorkspace(String workspaceId, String query, LogsQueryTimeInterval timeInterval) {
         return queryWorkspaceWithResponse(workspaceId, query, timeInterval, new LogsQueryOptions())
             .map(Response::getValue);
     }
@@ -143,7 +143,7 @@ public Mono<LogsQueryResult> queryWorkspace(String workspaceId, String query, Qu
      * @return The logs matching the query as a list of objects of type T.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public <T> Mono<List<T>> queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval,
+    public <T> Mono<List<T>> queryWorkspace(String workspaceId, String query, LogsQueryTimeInterval timeInterval,
         Class<T> type) {
         return queryWorkspace(workspaceId, query, timeInterval)
             .map(result -> LogsQueryHelper.toObject(result.getTable(), type));
@@ -162,7 +162,7 @@ public <T> Mono<List<T>> queryWorkspace(String workspaceId, String query, QueryT
      * @return The logs matching the query as a list of objects of type T.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public <T> Mono<List<T>> queryWorkspace(String workspaceId, String query, QueryTimeInterval timeInterval,
+    public <T> Mono<List<T>> queryWorkspace(String workspaceId, String query, LogsQueryTimeInterval timeInterval,
         Class<T> type, LogsQueryOptions options) {
         return queryWorkspaceWithResponse(workspaceId, query, timeInterval, options, Context.NONE)
             .map(response -> LogsQueryHelper.toObject(response.getValue().getTable(), type));
@@ -177,7 +177,7 @@ public <T> Mono<List<T>> queryWorkspace(String workspaceId, String query, QueryT
      * <pre>
      * Mono&lt;Response&lt;LogsQueryResult&gt;&gt; queryResult = logsQueryAsyncClient.queryWorkspaceWithResponse&#40;&quot;&#123;workspace-id&#125;&quot;,
      *         &quot;&#123;kusto-query&#125;&quot;,
-     *         QueryTimeInterval.LAST_7_DAYS,
+     *         LogsQueryTimeInterval.LAST_7_DAYS,
      *         new LogsQueryOptions&#40;&#41;.setServerTimeout&#40;Duration.ofMinutes&#40;2&#41;&#41;&#41;;
      *
      * queryResult.subscribe&#40;result -&gt; &#123;
@@ -200,7 +200,7 @@ public <T> Mono<List<T>> queryWorkspace(String workspaceId, String query, QueryT
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<Response<LogsQueryResult>> queryWorkspaceWithResponse(String workspaceId, String query,
-        QueryTimeInterval timeInterval, LogsQueryOptions options) {
+        LogsQueryTimeInterval timeInterval, LogsQueryOptions options) {
         return withContext(context -> queryWorkspaceWithResponse(workspaceId, query, timeInterval, options, context));
     }
 
@@ -218,7 +218,7 @@ public Mono<Response<LogsQueryResult>> queryWorkspaceWithResponse(String workspa
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public <T> Mono<Response<List<T>>> queryWorkspaceWithResponse(String workspaceId, String query,
-        QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options) {
+        LogsQueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options) {
         return queryWorkspaceWithResponse(workspaceId, query, timeInterval, options)
             .map(response -> new SimpleResponse<>(response.getRequest(), response.getStatusCode(),
                 response.getHeaders(), LogsQueryHelper.toObject(response.getValue().getTable(), type)));
@@ -232,9 +232,9 @@ public <T> Mono<Response<List<T>>> queryWorkspaceWithResponse(String workspaceId
      * <!-- src_embed com.azure.monitor.query.LogsQueryAsyncClient.queryBatch#LogsBatchQuery -->
      * <pre>
      * LogsBatchQuery batchQuery = new LogsBatchQuery&#40;&#41;;
-     * String queryId1 = batchQuery.addWorkspaceQuery&#40;&quot;&#123;workspace-id-1&#125;&quot;, &quot;&#123;kusto-query-1&#125;&quot;, QueryTimeInterval.LAST_DAY&#41;;
+     * String queryId1 = batchQuery.addWorkspaceQuery&#40;&quot;&#123;workspace-id-1&#125;&quot;, &quot;&#123;kusto-query-1&#125;&quot;, LogsQueryTimeInterval.LAST_DAY&#41;;
      * String queryId2 = batchQuery.addWorkspaceQuery&#40;&quot;&#123;workspace-id-2&#125;&quot;, &quot;&#123;kusto-query-2&#125;&quot;,
-     *         QueryTimeInterval.LAST_7_DAYS, new LogsQueryOptions&#40;&#41;.setServerTimeout&#40;Duration.ofMinutes&#40;2&#41;&#41;&#41;;
+     *         LogsQueryTimeInterval.LAST_7_DAYS, new LogsQueryOptions&#40;&#41;.setServerTimeout&#40;Duration.ofMinutes&#40;2&#41;&#41;&#41;;
      *
      * Mono&lt;LogsBatchQueryResultCollection&gt; batchQueryResponse = logsQueryAsyncClient.queryBatch&#40;batchQuery&#41;;
      *
@@ -277,7 +277,7 @@ public Mono<Response<LogsBatchQueryResultCollection>> queryBatchWithResponse(Log
      * <!-- src_embed com.azure.monitor.query.LogsQueryAsyncClient.queryResource#String-String-QueryTimeInterval -->
      * <pre>
      * Mono&lt;LogsQueryResult&gt; queryResult = logsQueryAsyncClient.queryResource&#40;&quot;&#123;resource-id&#125;&quot;, &quot;&#123;kusto-query&#125;&quot;,
-     *     QueryTimeInterval.LAST_DAY&#41;;
+     *     LogsQueryTimeInterval.LAST_DAY&#41;;
      * queryResult.subscribe&#40;result -&gt; &#123;
      *     for &#40;LogsTableRow row : result.getTable&#40;&#41;.getRows&#40;&#41;&#41; &#123;
      *         System.out.println&#40;row.getRow&#40;&#41;
@@ -295,7 +295,7 @@ public Mono<Response<LogsBatchQueryResultCollection>> queryBatchWithResponse(Log
      * @return The logs matching the query.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<LogsQueryResult> queryResource(String resourceId, String query, QueryTimeInterval timeInterval) {
+    public Mono<LogsQueryResult> queryResource(String resourceId, String query, LogsQueryTimeInterval timeInterval) {
         return queryResourceWithResponse(resourceId, query, timeInterval, new LogsQueryOptions())
             .map(Response::getValue);
     }
@@ -311,7 +311,7 @@ public Mono<LogsQueryResult> queryResource(String resourceId, String query, Quer
      * @return The logs matching the query as a list of objects of type T.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public <T> Mono<List<T>> queryResource(String resourceId, String query, QueryTimeInterval timeInterval,
+    public <T> Mono<List<T>> queryResource(String resourceId, String query, LogsQueryTimeInterval timeInterval,
         Class<T> type) {
         return queryResource(resourceId, query, timeInterval)
             .map(result -> LogsQueryHelper.toObject(result.getTable(), type));
@@ -330,7 +330,7 @@ public <T> Mono<List<T>> queryResource(String resourceId, String query, QueryTim
      * @return The logs matching the query as a list of objects of type T.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public <T> Mono<List<T>> queryResource(String resourceId, String query, QueryTimeInterval timeInterval,
+    public <T> Mono<List<T>> queryResource(String resourceId, String query, LogsQueryTimeInterval timeInterval,
         Class<T> type, LogsQueryOptions options) {
         return queryResourceWithResponse(resourceId, query, timeInterval, options, Context.NONE)
             .map(response -> LogsQueryHelper.toObject(response.getValue().getTable(), type));
@@ -345,7 +345,7 @@ public <T> Mono<List<T>> queryResource(String resourceId, String query, QueryTim
      * <pre>
      * Mono&lt;Response&lt;LogsQueryResult&gt;&gt; queryResult = logsQueryAsyncClient.queryResourceWithResponse&#40;&quot;&#123;resource-id&#125;&quot;,
      *     &quot;&#123;kusto-query&#125;&quot;,
-     *     QueryTimeInterval.LAST_7_DAYS,
+     *     LogsQueryTimeInterval.LAST_7_DAYS,
      *     new LogsQueryOptions&#40;&#41;.setServerTimeout&#40;Duration.ofMinutes&#40;2&#41;&#41;&#41;;
      *
      * queryResult.subscribe&#40;result -&gt; &#123;
@@ -368,7 +368,7 @@ public <T> Mono<List<T>> queryResource(String resourceId, String query, QueryTim
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<Response<LogsQueryResult>> queryResourceWithResponse(String resourceId, String query,
-        QueryTimeInterval timeInterval, LogsQueryOptions options) {
+        LogsQueryTimeInterval timeInterval, LogsQueryOptions options) {
         return withContext(context -> queryResourceWithResponse(resourceId, query, timeInterval, options, context));
     }
 
@@ -386,7 +386,7 @@ public Mono<Response<LogsQueryResult>> queryResourceWithResponse(String resource
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public <T> Mono<Response<List<T>>> queryResourceWithResponse(String resourceId, String query,
-        QueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options) {
+        LogsQueryTimeInterval timeInterval, Class<T> type, LogsQueryOptions options) {
         return queryResourceWithResponse(resourceId, query, timeInterval, options)
             .map(response -> new SimpleResponse<>(response.getRequest(), response.getStatusCode(),
                 response.getHeaders(), LogsQueryHelper.toObject(response.getValue().getTable(), type)));
@@ -417,7 +417,7 @@ private Context updateContext(Duration serverTimeout, Context context) {
     }
 
     Mono<Response<LogsQueryResult>> queryWorkspaceWithResponse(String workspaceId, String query,
-        QueryTimeInterval timeInterval, LogsQueryOptions options, Context context) {
+        LogsQueryTimeInterval timeInterval, LogsQueryOptions options, Context context) {
         String preferHeader = LogsQueryHelper.buildPreferHeaderString(options);
         context = updateContext(options.getServerTimeout(), context);
 
@@ -448,7 +448,7 @@ Mono<Response<LogsQueryResult>> queryWorkspaceWithResponse(String workspaceId, S
     }
 
     Mono<Response<LogsQueryResult>> queryResourceWithResponse(String resourceId, String query,
-        QueryTimeInterval timeInterval, LogsQueryOptions options, Context context) {
+        LogsQueryTimeInterval timeInterval, LogsQueryOptions options, Context context) {
         if (resourceId != null && resourceId.startsWith("/")) {
             resourceId = resourceId.substring(1);
         }