Interface Videos


  • public interface Videos
    Resource collection API of Videos.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      VideoEntity.DefinitionStages.Blank define​(String name)
      Begins definition for a new VideoEntity resource.
      void delete​(String resourceGroupName, String accountName, String videoName)
      Deletes an existing video resource and its underlying data.
      void deleteById​(String id)
      Deletes an existing video resource and its underlying data.
      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id, com.azure.core.util.Context context)
      Deletes an existing video resource and its underlying data.
      com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName, String accountName, String videoName, com.azure.core.util.Context context)
      Deletes an existing video resource and its underlying data.
      VideoEntity get​(String resourceGroupName, String accountName, String videoName)
      Retrieves an existing video resource with the given name.
      VideoEntity getById​(String id)
      Retrieves an existing video resource with the given name.
      com.azure.core.http.rest.Response<VideoEntity> getByIdWithResponse​(String id, com.azure.core.util.Context context)
      Retrieves an existing video resource with the given name.
      com.azure.core.http.rest.Response<VideoEntity> getWithResponse​(String resourceGroupName, String accountName, String videoName, com.azure.core.util.Context context)
      Retrieves an existing video resource with the given name.
      com.azure.core.http.rest.PagedIterable<VideoEntity> list​(String resourceGroupName, String accountName)
      Retrieves a list of video resources that have been created, along with their JSON representations.
      com.azure.core.http.rest.PagedIterable<VideoEntity> list​(String resourceGroupName, String accountName, Integer top, com.azure.core.util.Context context)
      Retrieves a list of video resources that have been created, along with their JSON representations.
      VideoContentToken listContentToken​(String resourceGroupName, String accountName, String videoName)
      Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name.
      com.azure.core.http.rest.Response<VideoContentToken> listContentTokenWithResponse​(String resourceGroupName, String accountName, String videoName, com.azure.core.util.Context context)
      Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<VideoEntity> list​(String resourceGroupName,
                                                                 String accountName)
        Retrieves a list of video resources that have been created, along with their JSON representations.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        Returns:
        a collection of VideoEntity items as paginated response with PagedIterable.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • list

        com.azure.core.http.rest.PagedIterable<VideoEntity> list​(String resourceGroupName,
                                                                 String accountName,
                                                                 Integer top,
                                                                 com.azure.core.util.Context context)
        Retrieves a list of video resources that have been created, along with their JSON representations.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        top - Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.
        context - The context to associate with this operation.
        Returns:
        a collection of VideoEntity items as paginated response with PagedIterable.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • get

        VideoEntity get​(String resourceGroupName,
                        String accountName,
                        String videoName)
        Retrieves an existing video resource with the given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        videoName - The Video name.
        Returns:
        represents a video resource within Azure Video Analyzer.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWithResponse

        com.azure.core.http.rest.Response<VideoEntity> getWithResponse​(String resourceGroupName,
                                                                       String accountName,
                                                                       String videoName,
                                                                       com.azure.core.util.Context context)
        Retrieves an existing video resource with the given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        videoName - The Video name.
        context - The context to associate with this operation.
        Returns:
        represents a video resource within Azure Video Analyzer along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • delete

        void delete​(String resourceGroupName,
                    String accountName,
                    String videoName)
        Deletes an existing video resource and its underlying data. This operation is irreversible.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        videoName - The Video name.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                                   String accountName,
                                                                   String videoName,
                                                                   com.azure.core.util.Context context)
        Deletes an existing video resource and its underlying data. This operation is irreversible.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        videoName - The Video name.
        context - The context to associate with this operation.
        Returns:
        the Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listContentToken

        VideoContentToken listContentToken​(String resourceGroupName,
                                           String accountName,
                                           String videoName)
        Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        videoName - The Video name.
        Returns:
        "Video content token grants access to the video content URLs.".
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listContentTokenWithResponse

        com.azure.core.http.rest.Response<VideoContentToken> listContentTokenWithResponse​(String resourceGroupName,
                                                                                          String accountName,
                                                                                          String videoName,
                                                                                          com.azure.core.util.Context context)
        Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - The Azure Video Analyzer account name.
        videoName - The Video name.
        context - The context to associate with this operation.
        Returns:
        "Video content token grants access to the video content URLs." along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getById

        VideoEntity getById​(String id)
        Retrieves an existing video resource with the given name.
        Parameters:
        id - the resource ID.
        Returns:
        represents a video resource within Azure Video Analyzer along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<VideoEntity> getByIdWithResponse​(String id,
                                                                           com.azure.core.util.Context context)
        Retrieves an existing video resource with the given name.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        represents a video resource within Azure Video Analyzer along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteById

        void deleteById​(String id)
        Deletes an existing video resource and its underlying data. This operation is irreversible.
        Parameters:
        id - the resource ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteByIdWithResponse

        com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id,
                                                                       com.azure.core.util.Context context)
        Deletes an existing video resource and its underlying data. This operation is irreversible.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • define

        VideoEntity.DefinitionStages.Blank define​(String name)
        Begins definition for a new VideoEntity resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new VideoEntity definition.