Class ResumableUploadOptions (2.87.0)

public abstract class ResumableUploadOptions

Options to configure a resumable upload invocation on a ResumableUploadCallable. Encapsulates protocol options such as payload chunk size and global upload timeout.

Inheritance

java.lang.Object > ResumableUploadOptions

Static Methods

newBuilder()

public static ResumableUploadOptions.Builder newBuilder()
Returns
Type Description
ResumableUploadOptions.Builder

Constructors

ResumableUploadOptions()

public ResumableUploadOptions()

Methods

getChunkSize()

public abstract int getChunkSize()

Returns the configured chunk size in bytes (defaults to 8 MB / 8,388,608 bytes).

Returns
Type Description
int

getGlobalTimeout()

public abstract @Nullable Duration getGlobalTimeout()

Returns the global upload timeout governing the entire upload duration, or null if disabled.

Returns
Type Description
@org.jspecify.annotations.Nullable java.time.Duration

getProgressListener()

public abstract @Nullable ResumableUploadProgressListener getProgressListener()

Returns the listener notified of upload progress and state transitions, or null if not set.

Returns
Type Description
@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ResumableUploadProgressListener

merge(@Nullable ResumableUploadOptions other)

public ResumableUploadOptions merge(@Nullable ResumableUploadOptions other)

Merges another ResumableUploadOptions instance with this one. Fields set in other override fields in this instance.

Parameter
Name Description
other @org.jspecify.annotations.Nullable com.google.api.gax.rpc.ResumableUploadOptions

options to overlay; may be null

Returns
Type Description
ResumableUploadOptions

a new, resolved ResumableUploadOptions instance

toBuilder()

public abstract ResumableUploadOptions.Builder toBuilder()
Returns
Type Description
ResumableUploadOptions.Builder