Interface SharesClient


public interface SharesClient
An instance of this class provides access to all the operations defined in SharesClient.
  • Method Summary

    Modifier and Type
    Method
    Description
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ShareInner>,ShareInner>
    beginCreateOrUpdate(String deviceName, String name, String resourceGroupName, ShareInner share)
    Creates a new share or updates an existing share on the device.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ShareInner>,ShareInner>
    beginCreateOrUpdate(String deviceName, String name, String resourceGroupName, ShareInner share, com.azure.core.util.Context context)
    Creates a new share or updates an existing share on the device.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginDelete(String deviceName, String name, String resourceGroupName)
    Deletes the share on the Data Box Edge/Data Box Gateway device.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginDelete(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
    Deletes the share on the Data Box Edge/Data Box Gateway device.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginRefresh(String deviceName, String name, String resourceGroupName)
    Refreshes the share metadata with the data from the cloud.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginRefresh(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
    Refreshes the share metadata with the data from the cloud.
    createOrUpdate(String deviceName, String name, String resourceGroupName, ShareInner share)
    Creates a new share or updates an existing share on the device.
    createOrUpdate(String deviceName, String name, String resourceGroupName, ShareInner share, com.azure.core.util.Context context)
    Creates a new share or updates an existing share on the device.
    void
    delete(String deviceName, String name, String resourceGroupName)
    Deletes the share on the Data Box Edge/Data Box Gateway device.
    void
    delete(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
    Deletes the share on the Data Box Edge/Data Box Gateway device.
    get(String deviceName, String name, String resourceGroupName)
    Gets a share by name.
    com.azure.core.http.rest.Response<ShareInner>
    getWithResponse(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
    Gets a share by name.
    com.azure.core.http.rest.PagedIterable<ShareInner>
    listByDataBoxEdgeDevice(String deviceName, String resourceGroupName)
    Lists all the shares in a Data Box Edge/Data Box Gateway device.
    com.azure.core.http.rest.PagedIterable<ShareInner>
    listByDataBoxEdgeDevice(String deviceName, String resourceGroupName, com.azure.core.util.Context context)
    Lists all the shares in a Data Box Edge/Data Box Gateway device.
    void
    refresh(String deviceName, String name, String resourceGroupName)
    Refreshes the share metadata with the data from the cloud.
    void
    refresh(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
    Refreshes the share metadata with the data from the cloud.
  • Method Details

    • listByDataBoxEdgeDevice

      com.azure.core.http.rest.PagedIterable<ShareInner> listByDataBoxEdgeDevice(String deviceName, String resourceGroupName)
      Lists all the shares in a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      Returns:
      collection of all the shares on the Data Box Edge/Gateway device 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.
    • listByDataBoxEdgeDevice

      com.azure.core.http.rest.PagedIterable<ShareInner> listByDataBoxEdgeDevice(String deviceName, String resourceGroupName, com.azure.core.util.Context context)
      Lists all the shares in a Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      Returns:
      collection of all the shares on the Data Box Edge/Gateway device 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.
    • getWithResponse

      com.azure.core.http.rest.Response<ShareInner> getWithResponse(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
      Gets a share by name.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      Returns:
      a share by name 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.
    • get

      ShareInner get(String deviceName, String name, String resourceGroupName)
      Gets a share by name.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      Returns:
      a share by 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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ShareInner>,ShareInner> beginCreateOrUpdate(String deviceName, String name, String resourceGroupName, ShareInner share)
      Creates a new share or updates an existing share on the device.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      share - The share properties.
      Returns:
      the SyncPoller for polling of represents a share on the Data Box Edge/Gateway device.
      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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ShareInner>,ShareInner> beginCreateOrUpdate(String deviceName, String name, String resourceGroupName, ShareInner share, com.azure.core.util.Context context)
      Creates a new share or updates an existing share on the device.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      share - The share properties.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of represents a share on the Data Box Edge/Gateway device.
      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.
    • createOrUpdate

      ShareInner createOrUpdate(String deviceName, String name, String resourceGroupName, ShareInner share)
      Creates a new share or updates an existing share on the device.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      share - The share properties.
      Returns:
      represents a share on the Data Box Edge/Gateway device.
      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.
    • createOrUpdate

      ShareInner createOrUpdate(String deviceName, String name, String resourceGroupName, ShareInner share, com.azure.core.util.Context context)
      Creates a new share or updates an existing share on the device.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      share - The share properties.
      context - The context to associate with this operation.
      Returns:
      represents a share on the Data Box Edge/Gateway device.
      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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String deviceName, String name, String resourceGroupName)
      Deletes the share on the Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
      Deletes the share on the Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      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 deviceName, String name, String resourceGroupName)
      Deletes the share on the Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group 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.
    • delete

      void delete(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
      Deletes the share on the Data Box Edge/Data Box Gateway device.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      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.
    • beginRefresh

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginRefresh(String deviceName, String name, String resourceGroupName)
      Refreshes the share metadata with the data from the cloud.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.
    • beginRefresh

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginRefresh(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
      Refreshes the share metadata with the data from the cloud.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.
    • refresh

      void refresh(String deviceName, String name, String resourceGroupName)
      Refreshes the share metadata with the data from the cloud.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group 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.
    • refresh

      void refresh(String deviceName, String name, String resourceGroupName, com.azure.core.util.Context context)
      Refreshes the share metadata with the data from the cloud.
      Parameters:
      deviceName - The device name.
      name - The share name.
      resourceGroupName - The resource group name.
      context - The context to associate with this operation.
      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.