com.azure.resourcemanager.datafactory.models.CredentialResource Maven / Gradle / Ivy

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

package com.azure.resourcemanager.datafactory.models;

import com.azure.core.util.Context;
import com.azure.resourcemanager.datafactory.fluent.models.CredentialResourceInner;

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

    /**
     * Gets the properties property: Properties of credentials.
     * 
     * @return the properties value.
     */
    Credential properties();

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

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

    /**
     * Gets the etag property: Etag identifies change in the resource.
     * 
     * @return the etag value.
     */
    String etag();

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

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

    /**
     * The entirety of the CredentialResource definition.
     */
    interface Definition extends DefinitionStages.Blank, DefinitionStages.WithParentResource,
        DefinitionStages.WithProperties, DefinitionStages.WithCreate {
    }

    /**
     * The CredentialResource definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of the CredentialResource definition.
         */
        interface Blank extends WithParentResource {
        }

        /**
         * The stage of the CredentialResource definition allowing to specify parent resource.
         */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, factoryName.
             * 
             * @param resourceGroupName The resource group name.
             * @param factoryName The factory name.
             * @return the next definition stage.
             */
            WithProperties withExistingFactory(String resourceGroupName, String factoryName);
        }

        /**
         * The stage of the CredentialResource definition allowing to specify properties.
         */
        interface WithProperties {
            /**
             * Specifies the properties property: Properties of credentials..
             * 
             * @param properties Properties of credentials.
             * @return the next definition stage.
             */
            WithCreate withProperties(Credential properties);
        }

        /**
         * The stage of the CredentialResource 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.WithIfMatch {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            CredentialResource create();

            /**
             * Executes the create request.
             * 
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            CredentialResource create(Context context);
        }

        /**
         * The stage of the CredentialResource definition allowing to specify ifMatch.
         */
        interface WithIfMatch {
            /**
             * Specifies the ifMatch property: ETag of the credential entity. Should only be specified for update, for
             * which it should match existing entity or can be * for unconditional update..
             * 
             * @param ifMatch ETag of the credential entity. Should only be specified for update, for which it should
             * match existing entity or can be * for unconditional update.
             * @return the next definition stage.
             */
            WithCreate withIfMatch(String ifMatch);
        }
    }

    /**
     * Begins update for the CredentialResource resource.
     * 
     * @return the stage of resource update.
     */
    CredentialResource.Update update();

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

        /**
         * Executes the update request.
         * 
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        CredentialResource apply(Context context);
    }

    /**
     * The CredentialResource update stages.
     */
    interface UpdateStages {
        /**
         * The stage of the CredentialResource update allowing to specify properties.
         */
        interface WithProperties {
            /**
             * Specifies the properties property: Properties of credentials..
             * 
             * @param properties Properties of credentials.
             * @return the next definition stage.
             */
            Update withProperties(Credential properties);
        }

        /**
         * The stage of the CredentialResource update allowing to specify ifMatch.
         */
        interface WithIfMatch {
            /**
             * Specifies the ifMatch property: ETag of the credential entity. Should only be specified for update, for
             * which it should match existing entity or can be * for unconditional update..
             * 
             * @param ifMatch ETag of the credential entity. Should only be specified for update, for which it should
             * match existing entity or can be * for unconditional update.
             * @return the next definition stage.
             */
            Update withIfMatch(String ifMatch);
        }
    }

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @return the refreshed resource.
     */
    CredentialResource refresh();

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