All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.azure.resourcemanager.mediaservices.models.Asset Maven / Gradle / Ivy

Go to download

This package contains Microsoft Azure SDK for MediaServices Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. This Swagger was generated by the API Framework. Package tag package-account-2023-01.

There is a newer version: 2.4.0-beta.2
Show 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.mediaservices.models;

import com.azure.core.http.rest.Response;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.mediaservices.fluent.models.AssetInner;
import java.time.OffsetDateTime;
import java.util.UUID;

/** An immutable client-side representation of Asset. */
public interface Asset {
    /**
     * 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: The system metadata relating to this resource.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the assetId property: The Asset ID.
     *
     * @return the assetId value.
     */
    UUID assetId();

    /**
     * Gets the created property: The creation date of the Asset.
     *
     * @return the created value.
     */
    OffsetDateTime created();

    /**
     * Gets the lastModified property: The last modified date of the Asset.
     *
     * @return the lastModified value.
     */
    OffsetDateTime lastModified();

    /**
     * Gets the alternateId property: The alternate ID of the Asset.
     *
     * @return the alternateId value.
     */
    String alternateId();

    /**
     * Gets the description property: The Asset description.
     *
     * @return the description value.
     */
    String description();

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

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

    /**
     * Gets the storageEncryptionFormat property: The Asset encryption format. One of None or MediaStorageEncryption.
     *
     * @return the storageEncryptionFormat value.
     */
    AssetStorageEncryptionFormat storageEncryptionFormat();

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

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

    /** The entirety of the Asset definition. */
    interface Definition
        extends DefinitionStages.Blank, DefinitionStages.WithParentResource, DefinitionStages.WithCreate {
    }
    /** The Asset definition stages. */
    interface DefinitionStages {
        /** The first stage of the Asset definition. */
        interface Blank extends WithParentResource {
        }
        /** The stage of the Asset definition allowing to specify parent resource. */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, accountName.
             *
             * @param resourceGroupName The name of the resource group within the Azure subscription.
             * @param accountName The Media Services account name.
             * @return the next definition stage.
             */
            WithCreate withExistingMediaService(String resourceGroupName, String accountName);
        }
        /**
         * The stage of the Asset 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.WithAlternateId,
                DefinitionStages.WithDescription,
                DefinitionStages.WithContainer,
                DefinitionStages.WithStorageAccountName {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            Asset create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            Asset create(Context context);
        }
        /** The stage of the Asset definition allowing to specify alternateId. */
        interface WithAlternateId {
            /**
             * Specifies the alternateId property: The alternate ID of the Asset..
             *
             * @param alternateId The alternate ID of the Asset.
             * @return the next definition stage.
             */
            WithCreate withAlternateId(String alternateId);
        }
        /** The stage of the Asset definition allowing to specify description. */
        interface WithDescription {
            /**
             * Specifies the description property: The Asset description..
             *
             * @param description The Asset description.
             * @return the next definition stage.
             */
            WithCreate withDescription(String description);
        }
        /** The stage of the Asset definition allowing to specify container. */
        interface WithContainer {
            /**
             * Specifies the container property: The name of the asset blob container..
             *
             * @param container The name of the asset blob container.
             * @return the next definition stage.
             */
            WithCreate withContainer(String container);
        }
        /** The stage of the Asset definition allowing to specify storageAccountName. */
        interface WithStorageAccountName {
            /**
             * Specifies the storageAccountName property: The name of the storage account..
             *
             * @param storageAccountName The name of the storage account.
             * @return the next definition stage.
             */
            WithCreate withStorageAccountName(String storageAccountName);
        }
    }
    /**
     * Begins update for the Asset resource.
     *
     * @return the stage of resource update.
     */
    Asset.Update update();

    /** The template for Asset update. */
    interface Update
        extends UpdateStages.WithAlternateId,
            UpdateStages.WithDescription,
            UpdateStages.WithContainer,
            UpdateStages.WithStorageAccountName {
        /**
         * Executes the update request.
         *
         * @return the updated resource.
         */
        Asset apply();

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        Asset apply(Context context);
    }
    /** The Asset update stages. */
    interface UpdateStages {
        /** The stage of the Asset update allowing to specify alternateId. */
        interface WithAlternateId {
            /**
             * Specifies the alternateId property: The alternate ID of the Asset..
             *
             * @param alternateId The alternate ID of the Asset.
             * @return the next definition stage.
             */
            Update withAlternateId(String alternateId);
        }
        /** The stage of the Asset update allowing to specify description. */
        interface WithDescription {
            /**
             * Specifies the description property: The Asset description..
             *
             * @param description The Asset description.
             * @return the next definition stage.
             */
            Update withDescription(String description);
        }
        /** The stage of the Asset update allowing to specify container. */
        interface WithContainer {
            /**
             * Specifies the container property: The name of the asset blob container..
             *
             * @param container The name of the asset blob container.
             * @return the next definition stage.
             */
            Update withContainer(String container);
        }
        /** The stage of the Asset update allowing to specify storageAccountName. */
        interface WithStorageAccountName {
            /**
             * Specifies the storageAccountName property: The name of the storage account..
             *
             * @param storageAccountName The name of the storage account.
             * @return the next definition stage.
             */
            Update withStorageAccountName(String storageAccountName);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    Asset refresh();

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

    /**
     * Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The
     * signatures are derived from the storage account keys.
     *
     * @param parameters The request parameters.
     * @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 Asset Storage container SAS URLs.
     */
    AssetContainerSas listContainerSas(ListContainerSasInput parameters);

    /**
     * Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The
     * signatures are derived from the storage account keys.
     *
     * @param parameters The request parameters.
     * @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 Asset Storage container SAS URLs along with {@link Response}.
     */
    Response listContainerSasWithResponse(ListContainerSasInput parameters, Context context);

    /**
     * Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API.
     *
     * @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 Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API.
     */
    StorageEncryptedAssetDecryptionData getEncryptionKey();

    /**
     * Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API.
     *
     * @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 Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API
     *     along with {@link Response}.
     */
    Response getEncryptionKeyWithResponse(Context context);

    /**
     * Lists Streaming Locators which are associated with this asset.
     *
     * @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 Streaming Locators associated with this Asset.
     */
    ListStreamingLocatorsResponse listStreamingLocators();

    /**
     * Lists Streaming Locators which are associated with this asset.
     *
     * @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 Streaming Locators associated with this Asset along with {@link Response}.
     */
    Response listStreamingLocatorsWithResponse(Context context);
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy