Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

package com.microsoft.azure.management.monitor;

import com.microsoft.azure.PagedList;
import com.microsoft.azure.management.apigeneration.LangDefinition;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.monitor.implementation.ActivityLogsInner;
import com.microsoft.azure.management.monitor.implementation.MonitorManager;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import org.joda.time.DateTime;
import rx.Observable;

import java.util.List;

Entry point for Monitor Activity logs API.
/**
 * Entry point for Monitor Activity logs API.
 */
@LangDefinition(ContainerName = "/Microsoft.Azure.Management.Monitor.Fluent")
public interface ActivityLogs extends
        HasManager<MonitorManager>,
        HasInner<ActivityLogsInner> {


    
Lists available event categories supported in the Activity Logs Service.
Returns:
list of available event categories supported in the Activity Logs Service./**
     * Lists available event categories supported in the Activity Logs Service.
     *
     * @return list of available event categories supported in the Activity Logs Service.
     */
    @Method
    List<LocalizableString> listEventCategories();

    
Lists available event categories supported in the Activity Logs Service.
Returns:
list of available event categories supported in the Activity Logs Service./**
     * Lists available event categories supported in the Activity Logs Service.
     *
     * @return list of available event categories supported in the Activity Logs Service.
     */
    @Method
    Observable<LocalizableString> listEventCategoriesAsync();

    
Begins a definition for a new Activity log query.
Returns:
the stage of start time filter definition./**
     * Begins a definition for a new Activity log query.
     *
     * @return the stage of start time filter definition.
     */
    @Method
    ActivityLogsQueryDefinitionStages.WithEventDataStartTimeFilter defineQuery();

    
The entirety of a Activity Logs query definition.
/**
     * The entirety of a Activity Logs query definition.
     */
    interface ActivityLogsQueryDefinition extends
            ActivityLogsQueryDefinitionStages.WithEventDataStartTimeFilter,
            ActivityLogsQueryDefinitionStages.WithEventDataEndFilter,
            ActivityLogsQueryDefinitionStages.WithEventDataFieldFilter,
            ActivityLogsQueryDefinitionStages.WithActivityLogsSelectFilter,
            ActivityLogsQueryDefinitionStages.WithActivityLogsQueryExecute {
    }

    
Grouping of Activity log query stages.
/**
     * Grouping of Activity log query stages.
     */
    interface ActivityLogsQueryDefinitionStages {

        
The stage of a Activity Log query allowing to specify start time filter.
/**
         * The stage of a Activity Log query allowing to specify start time filter.
         */
        interface WithEventDataStartTimeFilter {
            
Sets the start time for Activity Log query filter.
Params:
startTime – specifies start time of cut off filter.
Returns:
the stage of end time filter definition./**
             * Sets the start time for Activity Log query filter.
             *
             * @param startTime specifies start time of cut off filter.
             * @return the stage of end time filter definition.
             */
            WithEventDataEndFilter startingFrom(DateTime startTime);
        }

        
The stage of a Activity Log query allowing to specify end time filter.
/**
         * The stage of a Activity Log query allowing to specify end time filter.
         */
        interface WithEventDataEndFilter {
            
Sets the end time for Activity Log query filter.
Params:
endTime – specifies end time of cut off filter.
Returns:
the stage of optional query parameter definition and query execution./**
             * Sets the end time for Activity Log query filter.
             *
             * @param endTime specifies end time of cut off filter.
             * @return the stage of optional query parameter definition and query execution.
             */
            WithEventDataFieldFilter endsBefore(DateTime endTime);
        }

        
The stage of a Activity Log query allowing to specify data fields in the server response.
/**
         * The stage of a Activity Log query allowing to specify data fields in the server response.
         */
        interface WithEventDataFieldFilter {
            
Selects data fields that will be populated in the server response.
Params:
responseProperties – field names in the server response.
Returns:
the stage of Activity log filtering by type and query execution./**
             * Selects data fields that will be populated in the server response.
             *
             * @param responseProperties field names in the server response.
             * @return the stage of Activity log filtering by type and query execution.
             */
            WithActivityLogsSelectFilter withResponseProperties(EventDataPropertyName... responseProperties);

            
Sets the server response to include all the available properties.
Returns:
the stage of Activity log filtering by type and query execution./**
             * Sets the server response to include all the available properties.
             *
             * @return the stage of Activity log filtering by type and query execution.
             */
            @Method
            WithActivityLogsSelectFilter withAllPropertiesInResponse();
        }

        
The stage of the Activity log filtering by type and query execution.
/**
         * The stage of the Activity log filtering by type and query execution.
         */
        interface WithActivityLogsSelectFilter extends
                WithActivityLogsQueryExecute {

            
Filters events for a given resource group.
Params:
resourceGroupName – Specifies resource group name.
Returns:
the stage of Activity log filtering by type and query execution./**
             * Filters events for a given resource group.
             *
             * @param resourceGroupName Specifies resource group name.
             * @return the stage of Activity log filtering by type and query execution.
             */
            WithActivityLogsQueryExecute filterByResourceGroup(String resourceGroupName);

            
Filters events for a given resource.
Params:
resourceId – Specifies resource Id.
Returns:
the stage of Activity log filtering by type and query execution./**
             * Filters events for a given resource.
             *
             * @param resourceId Specifies resource Id.
             * @return the stage of Activity log filtering by type and query execution.
             */
            WithActivityLogsQueryExecute filterByResource(String resourceId);

            
Filters events for a given resource provider.
Params:
resourceProviderName – Specifies resource provider.
Returns:
the stage of Activity log filtering by type and query execution./**
             * Filters events for a given resource provider.
             *
             * @param resourceProviderName Specifies resource provider.
             * @return the stage of Activity log filtering by type and query execution.
             */
            WithActivityLogsQueryExecute filterByResourceProvider(String resourceProviderName);

            
Filters events for a given correlation id.
Params:
correlationId – Specifies correlation id.
Returns:
the stage of Activity log filtering by type and query execution./**
             * Filters events for a given correlation id.
             *
             * @param correlationId Specifies correlation id.
             * @return the stage of Activity log filtering by type and query execution.
             */
            WithActivityLogsQueryExecute filterByCorrelationId(String correlationId);
        }

        
The stage of the Activity log query execution.
/**
         * The stage of the Activity log query execution.
         */
        interface WithActivityLogsQueryExecute {
            
Executes the query.
Returns:
Activity Log events received after query execution./**
             * Executes the query.
             *
             * @return Activity Log events received after query execution.
             */
            @Method
            PagedList<EventData> execute();

            
Executes the query.
Returns:
a representation of the deferred computation of Activity Log query call./**
             * Executes the query.
             *
             * @return a representation of the deferred computation of Activity Log query call.
             */
            @Method
            Observable<EventData> executeAsync();

            
Filters events that were generated at the Tenant level.
Returns:
the stage of Activity log filtering by Tenant level and query execution./**
             * Filters events that were generated at the Tenant level.
             *
             * @return the stage of Activity log filtering by Tenant level and query execution.
             */
            @Method
            WithActivityLogsQueryExecute filterAtTenantLevel();
        }
    }
}