com.backblaze.b2.client.structures.B2UploadState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of b2-sdk-core Show documentation

The core logic for B2 SDK for Java. Does not include any implementations of B2WebApiClient.

There is a newer version: 6.3.0

/*
 * Copyright 2017, Backblaze Inc. All Rights Reserved.
 * License https://www.backblaze.com/using_b2_code.html
 */
package com.backblaze.b2.client.structures;

/**
 * 
 * Generally, uploads follow this state diagram:
 * 
 * *   WAITING_TO_START--|
 *           |         |
 *           |         |
 *           v         |
 *        STARTING ----|
 *           |         |
 *           |         |
 *           v         |
 *        UPLOADING    |
 *        |       |    |
 *        |       |    |
 *        v       v    v
 *  SUCCEEDED     FAILED
 * 
 *  Generally, the purpose of these updates is to provide high-level
 *  progress information.  Don't count on the rate at which you get the
 *  updates and don't count on seeing all of them.  For instance, if a
 *  part of an upload succeeded previously, you may only see an update
 *  for state SUCCEEDED.  Similarly, if the upload is canceled violently
 *  somehow you might not get any more updates.
 *
 *  If the upload hits retryable errors, it may jump back to an earlier state
 *  and the bytesSoFar may go back to zero.  Attempt count will be incremented.
 */
public enum B2UploadState {
    WAITING_TO_START,
    STARTING,
    UPLOADING,
    FAILED,
    SUCCEEDED
}