com.azure.resourcemanager.sql.models.SqlFailoverGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-sql Show documentation
This package contains Microsoft Azure Sql Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.resourcemanager.sql.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup;
import com.azure.resourcemanager.resources.fluentcore.arm.models.Resource;
import com.azure.resourcemanager.resources.fluentcore.model.Appliable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Refreshable;
import com.azure.resourcemanager.resources.fluentcore.model.Updatable;
import com.azure.resourcemanager.sql.fluent.models.FailoverGroupInner;
import java.util.List;
import reactor.core.publisher.Mono;

/** An immutable client-side representation of an Azure SQL Failover Group. */
@Fluent
public interface SqlFailoverGroup
    extends Resource,
        HasInnerModel,
        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. */
    void delete();

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

    /** The template for a SQL Failover Group update operation, containing all the settings that can be modified. */
    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. */
    interface UpdateStages {
        /** The SQL Failover Group update definition to set the read-write endpoint failover policy. */
        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
             */
            SqlFailoverGroup.Update withManualReadWriteEndpointPolicy();
        }

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

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

        /** The SQL Failover Group update definition to set the partner servers. */
        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
             */
            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);
        }
    }
}