com.azure.resourcemanager.deviceupdate.models.PrivateEndpointConnectionProxy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-deviceupdate Show documentation
This package contains Microsoft Azure SDK for DeviceUpdate Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Microsoft Device Update resource provider. Package tag package-2023-07-01.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.deviceupdate.models;

import com.azure.core.http.rest.Response;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.deviceupdate.fluent.models.PrivateEndpointConnectionProxyInner;

/**
 * An immutable client-side representation of PrivateEndpointConnectionProxy.
 */
public interface PrivateEndpointConnectionProxy {
    /**
     * 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 etag property: ETag from NRP.
     * 
     * @return the etag value.
     */
    String etag();

    /**
     * Gets the remotePrivateEndpoint property: Remote private endpoint details.
     * 
     * @return the remotePrivateEndpoint value.
     */
    RemotePrivateEndpoint remotePrivateEndpoint();

    /**
     * Gets the status property: Operation status.
     * 
     * @return the status value.
     */
    String status();

    /**
     * Gets the provisioningState property: The provisioning state of the private endpoint connection proxy resource.
     * 
     * @return the provisioningState value.
     */
    PrivateEndpointConnectionProxyProvisioningState provisioningState();

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

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

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

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

        /**
         * The stage of the PrivateEndpointConnectionProxy definition allowing to specify parent resource.
         */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, accountName.
             * 
             * @param resourceGroupName The resource group name.
             * @param accountName Account name.
             * @return the next definition stage.
             */
            WithCreate withExistingAccount(String resourceGroupName, String accountName);
        }

        /**
         * The stage of the PrivateEndpointConnectionProxy 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.WithRemotePrivateEndpoint, DefinitionStages.WithStatus {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            PrivateEndpointConnectionProxy create();

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

        /**
         * The stage of the PrivateEndpointConnectionProxy definition allowing to specify remotePrivateEndpoint.
         */
        interface WithRemotePrivateEndpoint {
            /**
             * Specifies the remotePrivateEndpoint property: Remote private endpoint details..
             * 
             * @param remotePrivateEndpoint Remote private endpoint details.
             * @return the next definition stage.
             */
            WithCreate withRemotePrivateEndpoint(RemotePrivateEndpoint remotePrivateEndpoint);
        }

        /**
         * The stage of the PrivateEndpointConnectionProxy definition allowing to specify status.
         */
        interface WithStatus {
            /**
             * Specifies the status property: Operation status..
             * 
             * @param status Operation status.
             * @return the next definition stage.
             */
            WithCreate withStatus(String status);
        }
    }

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

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

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

    /**
     * The PrivateEndpointConnectionProxy update stages.
     */
    interface UpdateStages {
        /**
         * The stage of the PrivateEndpointConnectionProxy update allowing to specify remotePrivateEndpoint.
         */
        interface WithRemotePrivateEndpoint {
            /**
             * Specifies the remotePrivateEndpoint property: Remote private endpoint details..
             * 
             * @param remotePrivateEndpoint Remote private endpoint details.
             * @return the next definition stage.
             */
            Update withRemotePrivateEndpoint(RemotePrivateEndpoint remotePrivateEndpoint);
        }

        /**
         * The stage of the PrivateEndpointConnectionProxy update allowing to specify status.
         */
        interface WithStatus {
            /**
             * Specifies the status property: Operation status..
             * 
             * @param status Operation status.
             * @return the next definition stage.
             */
            Update withStatus(String status);
        }
    }

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

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

    /**
     * (INTERNAL - DO NOT USE) Validates a private endpoint connection proxy object.
     * 
     * @param privateEndpointConnectionProxy The parameters for creating a private endpoint connection proxy.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link Response}.
     */
    Response validateWithResponse(PrivateEndpointConnectionProxyInner privateEndpointConnectionProxy,
        Context context);

    /**
     * (INTERNAL - DO NOT USE) Validates a private endpoint connection proxy object.
     * 
     * @param privateEndpointConnectionProxy The parameters for creating a private endpoint connection proxy.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void validate(PrivateEndpointConnectionProxyInner privateEndpointConnectionProxy);

    /**
     * (INTERNAL - DO NOT USE) Updates a private endpoint inside the private endpoint connection proxy object.
     * 
     * @param privateEndpointUpdate The parameters for updating a private endpoint connection proxy.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link Response}.
     */
    Response updatePrivateEndpointPropertiesWithResponse(PrivateEndpointUpdate privateEndpointUpdate,
        Context context);

    /**
     * (INTERNAL - DO NOT USE) Updates a private endpoint inside the private endpoint connection proxy object.
     * 
     * @param privateEndpointUpdate The parameters for updating a private endpoint connection proxy.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void updatePrivateEndpointProperties(PrivateEndpointUpdate privateEndpointUpdate);
}