Package com.azure.resourcemanager.databox.models

Interface JobResource

public interface JobResource
An immutable client-side representation of JobResource.

  • Method Details

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • name

      String name()
      Gets the name property: Name of the object.
      Returns:
      the name value.

    • id

      String id()
      Gets the id property: Id of the object.
      Returns:
      the id value.

    • type

      String type()
      Gets the type property: Type of the object.
      Returns:
      the type value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.

    • sku

      Sku sku()
      Gets the sku property: The sku type.
      Returns:
      the sku value.

    • identity

      ResourceIdentity identity()
      Gets the identity property: Msi identity of the resource.
      Returns:
      the identity value.

    • transferType

      TransferType transferType()
      Gets the transferType property: Type of the data transfer.
      Returns:
      the transferType value.

    • isCancellable

      Boolean isCancellable()
      Gets the isCancellable property: Describes whether the job is cancellable or not.
      Returns:
      the isCancellable value.

    • isDeletable

      Boolean isDeletable()
      Gets the isDeletable property: Describes whether the job is deletable or not.
      Returns:
      the isDeletable value.

    • isShippingAddressEditable

      Boolean isShippingAddressEditable()
      Gets the isShippingAddressEditable property: Describes whether the shipping address is editable or not.
      Returns:
      the isShippingAddressEditable value.

    • isPrepareToShipEnabled

      Boolean isPrepareToShipEnabled()
      Gets the isPrepareToShipEnabled property: Is Prepare To Ship Enabled on this job.
      Returns:
      the isPrepareToShipEnabled value.

    • status

      StageName status()
      Gets the status property: Name of the stage which is in progress.
      Returns:
      the status value.

    • startTime

      OffsetDateTime startTime()
      Gets the startTime property: Time at which the job was started in UTC ISO 8601 format.
      Returns:
      the startTime value.

    • error

      CloudError error()
      Gets the error property: Top level error for the job.
      Returns:
      the error value.

    • details

      JobDetails details()
      Gets the details property: Details of a job run. This field will only be sent for expand details filter.
      Returns:
      the details value.

    • cancellationReason

      String cancellationReason()
      Gets the cancellationReason property: Reason for cancellation.
      Returns:
      the cancellationReason value.

    • deliveryType

      JobDeliveryType deliveryType()
      Gets the deliveryType property: Delivery type of Job.
      Returns:
      the deliveryType value.

    • deliveryInfo

      JobDeliveryInfo deliveryInfo()
      Gets the deliveryInfo property: Delivery Info of Job.
      Returns:
      the deliveryInfo value.

    • isCancellableWithoutFee

      Boolean isCancellableWithoutFee()
      Gets the isCancellableWithoutFee property: Flag to indicate cancellation of scheduled job.
      Returns:
      the isCancellableWithoutFee value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      JobResourceInner innerModel()
      Gets the inner com.azure.resourcemanager.databox.fluent.models.JobResourceInner object.
      Returns:
      the inner object.

    • update

      JobResource.Update update()
      Begins update for the JobResource resource.
      Returns:
      the stage of resource update.

    • refresh

      JobResource refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      JobResource refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • bookShipmentPickUpWithResponse

      com.azure.core.http.rest.Response<ShipmentPickUpResponse> bookShipmentPickUpWithResponse(ShipmentPickUpRequest shipmentPickUpRequest, com.azure.core.util.Context context)
      Book shipment pick up.
      Parameters:
      shipmentPickUpRequest - Details of shipment pick up request.
      context - The context to associate with this operation.
      Returns:
      shipment pick up response 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.

    • bookShipmentPickUp

      ShipmentPickUpResponse bookShipmentPickUp(ShipmentPickUpRequest shipmentPickUpRequest)
      Book shipment pick up.
      Parameters:
      shipmentPickUpRequest - Details of shipment pick up request.
      Returns:
      shipment pick up 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.

    • cancelWithResponse

      com.azure.core.http.rest.Response<Void> cancelWithResponse(CancellationReason cancellationReason, com.azure.core.util.Context context)
      CancelJob.
      Parameters:
      cancellationReason - Reason for cancellation.
      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.

    • cancel

      void cancel(CancellationReason cancellationReason)
      CancelJob.
      Parameters:
      cancellationReason - Reason for cancellation.
      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.

    • listCredentials

      com.azure.core.http.rest.PagedIterable<UnencryptedCredentials> listCredentials()
      This method gets the unencrypted secrets related to the job.
      Returns:
      list of unencrypted credentials for accessing device as paginated response with PagedIterable.
      Throws:
      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.

    • listCredentials

      com.azure.core.http.rest.PagedIterable<UnencryptedCredentials> listCredentials(com.azure.core.util.Context context)
      This method gets the unencrypted secrets related to the job.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      list of unencrypted credentials for accessing 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.