Class ShareFileCopyInfo

java.lang.Object
com.azure.storage.file.share.models.ShareFileCopyInfo

public final class ShareFileCopyInfo extends Object
Contains copy information about a File in the storage File service.
See Also:
  • Constructor Details

    • ShareFileCopyInfo

      public ShareFileCopyInfo(String copySource, String copyId, CopyStatusType copyStatus, String eTag, OffsetDateTime lastModified, String error)
      Creates an instance of copy information about a specific File.
      Parameters:
      eTag - If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy.
      lastModified - The date/time that the copy operation to the destination file completed.
      copyId - String identifier for this copy operation.
      copyStatus - State of the copy operation with these values:
      • success: the copy completed successfully.
      • pending: the copy is still in progress.
      copySource - The url of the source file.
      error - An error message for the copy operation. null if there are no errors.
  • Method Details

    • getETag

      public String getETag()
      If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy.
      Returns:
      The ETag for the copy.
    • getLastModified

      public OffsetDateTime getLastModified()
      Gets the date/time that the copy operation to the destination file completed.
      Returns:
      Gets the date/time that the copy operation to the destination file completed.
    • getCopyId

      public String getCopyId()
      Gets the string identifier for this copy operation.
      Returns:
      String identifier for this copy operation.
    • getCopyStatus

      public CopyStatusType getCopyStatus()
      Gets the status of the copy operation. The status could be:
      1. success: The copy completed successfully.
      2. pending: The copy is still in progress.
      Returns:
      Status of the copy operation.
    • getCopySourceUrl

      public String getCopySourceUrl()
      Gets the the source file used in the last attempted copy file operation.
      Returns:
      The url of the source file.
    • getError

      public String getError()
      Gets an error description associated with the copy operation.
      Returns:
      An error description associated with the copy, or null if there is no error associated with this copy operation.