com.microsoft.azure.management.sql.SqlFailoverGroup Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of azure-mgmt-sql Show documentation
This package contains Microsoft Azure Sql Management SDK. A new set of management libraries are now Generally Available. For documentation on how to use the new libraries, please see https://aka.ms/azsdk/java/mgmt
There is a newer version: 1.41.4
Show newest version
/**
 * 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.sql;

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.models.Resource;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import com.microsoft.azure.management.sql.implementation.FailoverGroupInner;
import rx.Completable;

import java.util.List;

/**
 * An immutable client-side representation of an Azure SQL Failover Group.
 */
@Fluent
@Beta(Beta.SinceVersion.V1_8_0)
public interface SqlFailoverGroup
    extends
        Resource,
        HasInner,
        HasResourceGroup,
        Refreshable,
        Updatable {

    /**
     * @return name of the SQL Server to which this Failover Group belongs
     */
    String sqlServerName();

    /**
     * @return the parent SQL server ID
     */
    String parentId();

    /**
     * @return the failover policy of the read-write endpoint for the failover group
     */
    ReadWriteEndpointFailoverPolicy readWriteEndpointPolicy();

    /**
     * @return the grace period before failover with data loss is attempted for the read-write endpoint
     */
    int readWriteEndpointDataLossGracePeriodMinutes();

    /**
     * @return the failover policy of the read-only endpoint for the failover group
     */
    ReadOnlyEndpointFailoverPolicy readOnlyEndpointPolicy();

    /**
     * @return the local replication role of the failover group instance
     */
    FailoverGroupReplicationRole replicationRole();

    /**
     * @return the replication state of the failover group instance
     */
    String replicationState();

    /**
     * @return the list of partner server information for the failover group
     */
    List partnerServers();

    /**
     * @return the list of database IDs in the failover group
     */
    List databases();

    /**
     * Deletes the Failover Group.
     */
    @Method
    void delete();

    /**
     * Deletes the Failover Group asynchronously.
     *
     * @return a representation of the deferred computation of this call
     */
    @Method
    Completable deleteAsync();


    /**
     * The template for a SQL Failover Group update operation, containing all the settings that can be modified.
     */
    @Beta(Beta.SinceVersion.V1_8_0)
    interface Update extends
        SqlFailoverGroup.UpdateStages.WithReadWriteEndpointPolicy,
        SqlFailoverGroup.UpdateStages.WithReadOnlyEndpointPolicy,
        SqlFailoverGroup.UpdateStages.WithDatabase,
        Resource.UpdateWithTags,
        Appliable {
    }

    /**
     * Grouping of all the SQL Virtual Network Rule update stages.
     */
    @Beta(Beta.SinceVersion.V1_8_0)
    interface UpdateStages {
        /**
         * The SQL Failover Group update definition to set the read-write endpoint failover policy.
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface WithReadWriteEndpointPolicy {
            /**
             * Sets the SQL Failover Group read-write endpoint failover policy as "Automatic".
             *
             * @param gracePeriodInMinutes the grace period before failover with data loss is attempted for the read-write endpoint
             * @return the next stage of the definition
             */
            SqlFailoverGroup.Update withAutomaticReadWriteEndpointPolicyAndDataLossGracePeriod(int gracePeriodInMinutes);

            /**
             * Sets the SQL Failover Group read-write endpoint failover policy as "Manual".
             *
             * @return the next stage of the definition
             */
            @Method
            SqlFailoverGroup.Update withManualReadWriteEndpointPolicy();
        }

        /**
         * The SQL Failover Group update definition to set the failover policy of the read-only endpoint.
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface WithReadOnlyEndpointPolicy {
            /**
             * Sets the SQL Failover Group failover policy of the read-only endpoint to "Enabled".
             *
             * @return The next stage of the definition.
             */
            @Method
            SqlFailoverGroup.Update withReadOnlyEndpointPolicyEnabled();

            /**
             * Sets the SQL Failover Group failover policy of the read-only endpoint to "Disabled".
             *
             * @return the next stage of the definition
             */
            @Method
            SqlFailoverGroup.Update withReadOnlyEndpointPolicyDisabled();
        }

        /**
         * The SQL Failover Group update definition to set the partner servers.
         */
        @Beta(Beta.SinceVersion.V1_8_0)
        interface WithDatabase {
            /**
             * Sets the SQL Failover Group database.
             *
             * @param id the ID of the database
             * @return The next stage of the definition.
             */
            SqlFailoverGroup.Update withNewDatabaseId(String id);

            /**
             * Sets the SQL Failover Group partner servers.
             *
             * @param ids the IDs of the databases
             * @return the next stage of the definition
             */
            @Method
            SqlFailoverGroup.Update withDatabaseIds(String... ids);

            /**
             * Removes the SQL Failover Group database.
             *
             * @param id the ID of the database to be removed
             * @return The next stage of the definition.
             */
            SqlFailoverGroup.Update withoutDatabaseId(String id);
        }
    }
}