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.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.LangMethodDefinition;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.monitor.implementation.DiagnosticSettingsResourceInner;
import com.microsoft.azure.management.monitor.implementation.MonitorManager;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasId;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasName;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Indexable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import org.joda.time.Period;

import java.util.List;

An immutable client-side representation of an Azure diagnostic settings.
/**
 * An immutable client-side representation of an Azure diagnostic settings.
 */
@Beta(Beta.SinceVersion.V1_8_0)
@Fluent
public interface DiagnosticSetting extends
        Indexable,
        HasId,
        HasName,
        HasManager<MonitorManager>,
        HasInner<DiagnosticSettingsResourceInner>,
        Refreshable<DiagnosticSetting>,
        Updatable<DiagnosticSetting.Update> {
    
Get the associated resource Id value.
Returns:
the associated resource Id value/**
     * Get the associated resource Id value.
     *
     * @return the associated resource Id value
     */
    @LangMethodDefinition(AsType = LangMethodDefinition.LangMethodType.Property)
    String resourceId();

    
Get the storageAccountId value.
Returns:
the storageAccountId value/**
     * Get the storageAccountId value.
     *
     * @return the storageAccountId value
     */
    @LangMethodDefinition(AsType = LangMethodDefinition.LangMethodType.Property)
    String storageAccountId();

    
Get the eventHubAuthorizationRuleId value.
Returns:
the eventHubAuthorizationRuleId value/**
     * Get the eventHubAuthorizationRuleId value.
     *
     * @return the eventHubAuthorizationRuleId value
     */
    @LangMethodDefinition(AsType = LangMethodDefinition.LangMethodType.Property)
    String eventHubAuthorizationRuleId();

    
Get the eventHubName value.
Returns:
the eventHubName value/**
     * Get the eventHubName value.
     *
     * @return the eventHubName value
     */
    @LangMethodDefinition(AsType = LangMethodDefinition.LangMethodType.Property)
    String eventHubName();

    
Get the metrics value.
Returns:
the metrics value/**
     * Get the metrics value.
     *
     * @return the metrics value
     */
    @LangMethodDefinition(AsType = LangMethodDefinition.LangMethodType.Property)
    List<MetricSettings> metrics();

    
Get the logs value.
Returns:
the logs value/**
     * Get the logs value.
     *
     * @return the logs value
     */
    @LangMethodDefinition(AsType = LangMethodDefinition.LangMethodType.Property)
    List<LogSettings> logs();

    
Get the workspaceId value.
Returns:
the workspaceId value/**
     * Get the workspaceId value.
     *
     * @return the workspaceId value
     */
    @LangMethodDefinition(AsType = LangMethodDefinition.LangMethodType.Property)
    String workspaceId();

    
The entirety of a diagnostic settings definition.
/**
     * The entirety of a diagnostic settings definition.
     */
    interface Definition extends
            DefinitionStages.Blank,
            DefinitionStages.WithDiagnosticLogRecipient,
            DefinitionStages.WithCreate {
    }

    
Grouping of diagnostic settings definition stages.
/**
     * Grouping of diagnostic settings definition stages.
     */
    interface DefinitionStages {
        
The first stage of a diagnostic setting definition.
/**
         * The first stage of a diagnostic setting definition.
         */
        interface Blank {
            
Sets the resource for which Diagnostic Settings will be created.
Params:
resourceId – of the resource.
Returns:
the stage of selecting data recipient./**
             * Sets the resource for which Diagnostic Settings will be created.
             *
             * @param resourceId of the resource.
             * @return the stage of selecting data recipient.
             */
            WithDiagnosticLogRecipient withResource(String resourceId);
        }

        
The stage of the definition which contains minimum required properties to be specified for
Diagnostic Settings creation.
/**
         * The stage of the definition which contains minimum required properties to be specified for
         * Diagnostic Settings creation.
         */
        interface WithDiagnosticLogRecipient {
            
Sets Log Analytics workspace for data transfer.
Params:
workspaceId – of Log Analytics that should exist in the same region as resource.
Returns:
the stage of creating Diagnostic Settings./**
             * Sets Log Analytics workspace for data transfer.
             *
             * @param workspaceId of Log Analytics that should exist in the same region as resource.
             * @return the stage of creating Diagnostic Settings.
             */
            WithCreate withLogAnalytics(String workspaceId);

            
Sets Storage Account for data transfer.
Params:
storageAccountId – of storage account that should exist in the same region as resource.
Returns:
the stage of creating Diagnostic Settings./**
             * Sets Storage Account for data transfer.
             *
             * @param storageAccountId of storage account that should exist in the same region as resource.
             * @return the stage of creating Diagnostic Settings.
             */
            WithCreate withStorageAccount(String storageAccountId);

            
Sets EventHub Namespace Authorization Rule for data transfer.
Params:
eventHubAuthorizationRuleId – of EventHub namespace authorization rule that should exist in
                                   the same region as resource.
Returns:
the stage of creating Diagnostic Settings./**
             * Sets EventHub Namespace Authorization Rule for data transfer.
             *
             * @param eventHubAuthorizationRuleId of EventHub namespace authorization rule that should exist in
             *                                    the same region as resource.
             * @return the stage of creating Diagnostic Settings.
             */
            WithCreate withEventHub(String eventHubAuthorizationRuleId);

            
Sets EventHub Namespace Authorization Rule for data transfer.
Params:
eventHubAuthorizationRuleId – of EventHub namespace authorization rule that should exist in
                                   the same region as resource.
eventHubName – name of the EventHub. If none is specified, the default EventHub will be selected.
Returns:
the stage of creating Diagnostic Settings./**
             * Sets EventHub Namespace Authorization Rule for data transfer.
             *
             * @param eventHubAuthorizationRuleId of EventHub namespace authorization rule that should exist in
             *                                    the same region as resource.
             * @param eventHubName name of the EventHub. If none is specified, the default EventHub will be selected.
             * @return the stage of creating Diagnostic Settings.
             */
            WithCreate withEventHub(String eventHubAuthorizationRuleId, String eventHubName);
        }

        
The stage of the definition which contains all the minimum required inputs for the resource to be created
but also allows for any other optional settings to be specified.
/**
         * The stage of the definition which contains all the minimum required inputs for the resource to be created
         * but also allows for any other optional settings to be specified.
         */
        interface WithCreate extends
                WithDiagnosticLogRecipient,
                Creatable<DiagnosticSetting> {
            
Adds a Metric Setting to the list of Metric Settings for the current Diagnostic Settings.
Params:
category – name of a Metric category for a resource type this setting is applied to.
timeGrain – the timegrain of the metric in ISO8601 format.
retentionDays – the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Returns:
the stage of creating Diagnostic Settings./**
             * Adds a Metric Setting to the list of Metric Settings for the current Diagnostic Settings.
             *
             * @param category name of a Metric category for a resource type this setting is applied to.
             * @param timeGrain the timegrain of the metric in ISO8601 format.
             * @param retentionDays the number of days for the retention in days. A value of 0 will retain the events indefinitely.
             * @return the stage of creating Diagnostic Settings.
             */
            WithCreate withMetric(String category, Period timeGrain, int retentionDays);

            
Adds a Log Setting to the list of Log Settings for the current Diagnostic Settings.
Params:
category – name of a Log category for a resource type this setting is applied to.
retentionDays – the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Returns:
the stage of creating Diagnostic Settings./**
             * Adds a Log Setting to the list of Log Settings for the current Diagnostic Settings.
             *
             * @param category name of a Log category for a resource type this setting is applied to.
             * @param retentionDays the number of days for the retention in days. A value of 0 will retain the events indefinitely.
             * @return the stage of creating Diagnostic Settings.
             */
            WithCreate withLog(String category, int retentionDays);

            
Adds a Log and Metric Settings to the list Log and Metric Settings for the current Diagnostic Settings.
Params:
categories – a list of diagnostic settings category.
timeGrain – the timegrain of the metric in ISO8601 format for all Metrics in the categories list.
retentionDays – the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Returns:
the stage of creating Diagnostic Settings./**
             * Adds a Log and Metric Settings to the list Log and Metric Settings for the current Diagnostic Settings.
             *
             * @param categories a list of diagnostic settings category.
             * @param timeGrain the timegrain of the metric in ISO8601 format for all Metrics in the {@code categories} list.
             * @param retentionDays the number of days for the retention in days. A value of 0 will retain the events indefinitely.
             * @return the stage of creating Diagnostic Settings.
             */
            WithCreate withLogsAndMetrics(List<DiagnosticSettingsCategory> categories, Period timeGrain, int retentionDays);
        }
    }

    
Grouping of diagnostic setting update stages.
/**
     * Grouping of diagnostic setting update stages.
     */
    interface UpdateStages {
        
The stage of a Diagnostic Settings update allowing to modify Storage Account settings.
/**
         * The stage of a Diagnostic Settings update allowing to modify Storage Account settings.
         */
        interface WithStorageAccount {
            
Sets Storage Account for data transfer.
Params:
storageAccountId – of storage account that should exist in the same region as resource.
Returns:
the next stage of the Diagnostic Settings update./**
             * Sets Storage Account for data transfer.
             *
             * @param storageAccountId of storage account that should exist in the same region as resource.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withStorageAccount(String storageAccountId);

            
Removes the Storage Account from the Diagnostic Settings.
Returns:
the next stage of the Diagnostic Settings update./**
             * Removes the Storage Account from the Diagnostic Settings.
             *
             * @return the next stage of the Diagnostic Settings update.
             */
            @Method
            Update withoutStorageAccount();
        }

        
The stage of a Diagnostic Settings update allowing to modify EventHub settings.
/**
         * The stage of a Diagnostic Settings update allowing to modify EventHub settings.
         */
        interface WithEventHub {
            
Sets EventHub Namespace Authorization Rule for data transfer.
Params:
eventHubAuthorizationRuleId – of EventHub namespace authorization rule that should exist in
                                   the same region as resource.
Returns:
the next stage of the Diagnostic Settings update./**
             * Sets EventHub Namespace Authorization Rule for data transfer.
             *
             * @param eventHubAuthorizationRuleId of EventHub namespace authorization rule that should exist in
             *                                    the same region as resource.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withEventHub(String eventHubAuthorizationRuleId);

            
Sets EventHub Namespace Authorization Rule for data transfer.
Params:
eventHubAuthorizationRuleId – of EventHub namespace authorization rule that should exist in
                                   the same region as resource.
eventHubName – name of the EventHub. If none is specified, the default EventHub will be selected.
Returns:
the next stage of the Diagnostic Settings update./**
             * Sets EventHub Namespace Authorization Rule for data transfer.
             *
             * @param eventHubAuthorizationRuleId of EventHub namespace authorization rule that should exist in
             *                                    the same region as resource.
             * @param eventHubName name of the EventHub. If none is specified, the default EventHub will be selected.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withEventHub(String eventHubAuthorizationRuleId, String eventHubName);

            
Removes the EventHub from the Diagnostic Settings.
Returns:
the next stage of the Diagnostic Settings update./**
             * Removes the EventHub from the Diagnostic Settings.
             *
             * @return the next stage of the Diagnostic Settings update.
             */
            @Method
            Update withoutEventHub();
        }

        
The stage of a Diagnostic Settings update allowing to modify Log Analytics settings.
/**
         * The stage of a Diagnostic Settings update allowing to modify Log Analytics settings.
         */
        interface WithLogAnalytics {
            
Sets Log Analytics workspace for data transfer.
Params:
workspaceId – of Log Analytics that should exist in the same region as resource.
Returns:
the next stage of the Diagnostic Settings update./**
             * Sets Log Analytics workspace for data transfer.
             *
             * @param workspaceId of Log Analytics that should exist in the same region as resource.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withLogAnalytics(String workspaceId);

            
Removes the Log Analytics from the Diagnostic Settings.
Returns:
the next stage of the Diagnostic Settings update./**
             * Removes the Log Analytics from the Diagnostic Settings.
             *
             * @return the next stage of the Diagnostic Settings update.
             */
            @Method
            Update withoutLogAnalytics();
        }

        interface WithMetricAndLogs {
            
Adds a Metric Setting to the list of Metric Settings for the current Diagnostic Settings.
Params:
category – name of a Metric category for a resource type this setting is applied to.
timeGrain – the timegrain of the metric in ISO8601 format.
retentionDays – the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Returns:
the next stage of the Diagnostic Settings update./**
             * Adds a Metric Setting to the list of Metric Settings for the current Diagnostic Settings.
             *
             * @param category name of a Metric category for a resource type this setting is applied to.
             * @param timeGrain the timegrain of the metric in ISO8601 format.
             * @param retentionDays the number of days for the retention in days. A value of 0 will retain the events indefinitely.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withMetric(String category, Period timeGrain, int retentionDays);

            
Adds a Log Setting to the list of Log Settings for the current Diagnostic Settings.
Params:
category – name of a Log category for a resource type this setting is applied to.
retentionDays – the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Returns:
the next stage of the Diagnostic Settings update./**
             * Adds a Log Setting to the list of Log Settings for the current Diagnostic Settings.
             *
             * @param category name of a Log category for a resource type this setting is applied to.
             * @param retentionDays the number of days for the retention in days. A value of 0 will retain the events indefinitely.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withLog(String category, int retentionDays);

            
Adds a Log and Metric Settings to the list Log and Metric Settings for the current Diagnostic Settings.
Params:
categories – a list of diagnostic settings category.
timeGrain – the timegrain of the metric in ISO8601 format for all Metrics in the categories list.
retentionDays – the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Returns:
the next stage of the Diagnostic Settings update./**
             * Adds a Log and Metric Settings to the list Log and Metric Settings for the current Diagnostic Settings.
             *
             * @param categories a list of diagnostic settings category.
             * @param timeGrain the timegrain of the metric in ISO8601 format for all Metrics in the {@code categories} list.
             * @param retentionDays the number of days for the retention in days. A value of 0 will retain the events indefinitely.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withLogsAndMetrics(List<DiagnosticSettingsCategory> categories, Period timeGrain, int retentionDays);

            
Removes the Metric Setting from the Diagnostic Setting.
Params:
category – name of a Metric category to remove.
Returns:
the next stage of the Diagnostic Settings update./**
             * Removes the Metric Setting from the Diagnostic Setting.
             *
             * @param category name of a Metric category to remove.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withoutMetric(String category);

            
Removes the Log Setting from the Diagnostic Setting.
Params:
category – name of a Log category to remove.
Returns:
the next stage of the Diagnostic Settings update./**
             * Removes the Log Setting from the Diagnostic Setting.
             *
             * @param category name of a Log category to remove.
             * @return the next stage of the Diagnostic Settings update.
             */
            Update withoutLog(String category);

            
Removes all the Log Settings from the Diagnostic Setting.
Returns:
the next stage of the Diagnostic Settings update./**
             * Removes all the Log Settings from the Diagnostic Setting.
             *
             * @return the next stage of the Diagnostic Settings update.
             */
            @Method
            Update withoutLogs();

            
Removes all the Metric Settings from the Diagnostic Setting.
Returns:
the next stage of the Diagnostic Settings update./**
             * Removes all the Metric Settings from the Diagnostic Setting.
             *
             * @return the next stage of the Diagnostic Settings update.
             */
            @Method
            Update withoutMetrics();
        }
    }

    
The template for an update operation, containing all the settings that can be modified.
/**
     * The template for an update operation, containing all the settings that can be modified.
     */
    interface Update extends
            Appliable<DiagnosticSetting>,
            UpdateStages.WithStorageAccount,
            UpdateStages.WithEventHub,
            UpdateStages.WithLogAnalytics,
            UpdateStages.WithMetricAndLogs {
    }
}