// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.communication.models;

import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.communication.fluent.models.SenderUsernameResourceInner;

/** An immutable client-side representation of SenderUsernameResource. */
public interface SenderUsernameResource {
    /**
     * Gets the id property: Fully qualified resource Id for the resource.
     *
     * @return the id value.
     */
    String id();

    /**
     * Gets the name property: The name of the resource.
     *
     * @return the name value.
     */
    String name();

    /**
     * Gets the type property: The type of the resource.
     *
     * @return the type value.
     */
    String type();

    /**
     * Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the dataLocation property: The location where the SenderUsername resource data is stored at rest.
     *
     * @return the dataLocation value.
     */
    String dataLocation();

    /**
     * Gets the username property: A sender senderUsername to be used when sending emails.
     *
     * @return the username value.
     */
    String username();

    /**
     * Gets the displayName property: The display name for the senderUsername.
     *
     * @return the displayName value.
     */
    String displayName();

    /**
     * Gets the provisioningState property: Provisioning state of the resource. Unknown is the default state for
     * Communication Services.
     *
     * @return the provisioningState value.
     */
    ProvisioningState provisioningState();

    /**
     * Gets the name of the resource group.
     *
     * @return the name of the resource group.
     */
    String resourceGroupName();

    /**
     * Gets the inner com.azure.resourcemanager.communication.fluent.models.SenderUsernameResourceInner object.
     *
     * @return the inner object.
     */
    SenderUsernameResourceInner innerModel();

    /** The entirety of the SenderUsernameResource definition. */
    interface Definition
        extends DefinitionStages.Blank, DefinitionStages.WithParentResource, DefinitionStages.WithCreate {
    }
    /** The SenderUsernameResource definition stages. */
    interface DefinitionStages {
        /** The first stage of the SenderUsernameResource definition. */
        interface Blank extends WithParentResource {
        }
        /** The stage of the SenderUsernameResource definition allowing to specify parent resource. */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, emailServiceName, domainName.
             *
             * @param resourceGroupName The name of the resource group. The name is case insensitive.
             * @param emailServiceName The name of the EmailService resource.
             * @param domainName The name of the Domains resource.
             * @return the next definition stage.
             */
            WithCreate withExistingDomain(String resourceGroupName, String emailServiceName, String domainName);
        }
        /**
         * The stage of the SenderUsernameResource definition which contains all the minimum required properties for the
         * resource to be created, but also allows for any other optional properties to be specified.
         */
        interface WithCreate extends DefinitionStages.WithUsername, DefinitionStages.WithDisplayName {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            SenderUsernameResource create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            SenderUsernameResource create(Context context);
        }
        /** The stage of the SenderUsernameResource definition allowing to specify username. */
        interface WithUsername {
            /**
             * Specifies the username property: A sender senderUsername to be used when sending emails..
             *
             * @param username A sender senderUsername to be used when sending emails.
             * @return the next definition stage.
             */
            WithCreate withUsername(String username);
        }
        /** The stage of the SenderUsernameResource definition allowing to specify displayName. */
        interface WithDisplayName {
            /**
             * Specifies the displayName property: The display name for the senderUsername..
             *
             * @param displayName The display name for the senderUsername.
             * @return the next definition stage.
             */
            WithCreate withDisplayName(String displayName);
        }
    }
    /**
     * Begins update for the SenderUsernameResource resource.
     *
     * @return the stage of resource update.
     */
    SenderUsernameResource.Update update();

    /** The template for SenderUsernameResource update. */
    interface Update extends UpdateStages.WithUsername, UpdateStages.WithDisplayName {
        /**
         * Executes the update request.
         *
         * @return the updated resource.
         */
        SenderUsernameResource apply();

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        SenderUsernameResource apply(Context context);
    }
    /** The SenderUsernameResource update stages. */
    interface UpdateStages {
        /** The stage of the SenderUsernameResource update allowing to specify username. */
        interface WithUsername {
            /**
             * Specifies the username property: A sender senderUsername to be used when sending emails..
             *
             * @param username A sender senderUsername to be used when sending emails.
             * @return the next definition stage.
             */
            Update withUsername(String username);
        }
        /** The stage of the SenderUsernameResource update allowing to specify displayName. */
        interface WithDisplayName {
            /**
             * Specifies the displayName property: The display name for the senderUsername..
             *
             * @param displayName The display name for the senderUsername.
             * @return the next definition stage.
             */
            Update withDisplayName(String displayName);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    SenderUsernameResource refresh();

    /**
     * Refreshes the resource to sync with Azure.
     *
     * @param context The context to associate with this operation.
     * @return the refreshed resource.
     */
    SenderUsernameResource refresh(Context context);
}
