Package com.google.api.gax.resumable

Class QueryStatusResponse<ResponseT>

java.lang.Object

com.google.api.gax.resumable.QueryStatusResponse<ResponseT>

Type Parameters:

ResponseT - response type of the upload operation

@NullMarked
@BetaApi
@InternalApi
public abstract class QueryStatusResponse<ResponseT>
extends Object

Response value object representing the status and committed offset of a resumable upload session.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryStatusResponse.Builder<ResponseT>

Constructor Summary

Constructors

Constructor	Description
QueryStatusResponse()

Method Summary

Modifier and Type	Method	Description
abstract @Nullable Long	getCommittedOffset()	The total number of bytes successfully received and committed by the server so far, or null if the server did not return a committed offset (e.g. if the upload is already finalized).
abstract @Nullable ResponseT	getResponse()	The response object returned by the server upon final completion (e.g. metadata of the uploaded resource), or null if the upload is still in progress.
abstract boolean	isComplete()	Whether the resumable upload session has finalized and completed on the server.
static <ResponseT> QueryStatusResponse.Builder<ResponseT>	newBuilder()
abstract QueryStatusResponse.Builder<ResponseT>	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QueryStatusResponse

public QueryStatusResponse()

Method Details

getCommittedOffset

public abstract @Nullable Long getCommittedOffset()

The total number of bytes successfully received and committed by the server so far, or null if the server did not return a committed offset (e.g. if the upload is already finalized).

When isComplete() is false, this value is guaranteed to be non-null and represents the starting offset for resuming the upload.

isComplete

public abstract boolean isComplete()

Whether the resumable upload session has finalized and completed on the server.

getResponse

public abstract @Nullable ResponseT getResponse()

The response object returned by the server upon final completion (e.g. metadata of the uploaded resource), or null if the upload is still in progress.

toBuilder

public abstract QueryStatusResponse.Builder<ResponseT> toBuilder()

newBuilder

public static <ResponseT>
QueryStatusResponse.Builder<ResponseT> newBuilder()