Class BaseWriteChannel<ServiceOptionsT,EntityT> (2.37.0)

Version 2.37.0

• 2.47.0 (latest)
• 2.45.0
• 2.44.1
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.1
• 2.37.0
• 2.36.1
• 2.35.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.1
• 2.23.0
• 2.22.1
• 2.21.1
• 2.20.1
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.4
• 2.8.27
• 2.7.1
• 2.6.1
• 2.5.11
• 2.4.0
• 2.3.5

public abstract class BaseWriteChannel<ServiceOptionsT,EntityT> implements WriteChannel

Base implementation for a WriteChannel.

Inheritance

java.lang.Object > BaseWriteChannel<ServiceOptionsT,EntityT>

Implements

WriteChannel

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameters
Name	Description
ServiceOptionsT
EntityT

Constructors

BaseWriteChannel(ServiceOptionsT options, EntityT entity, String uploadId)

protected BaseWriteChannel(ServiceOptionsT options, EntityT entity, String uploadId)

Internal Only: This feature is not stable for application use.

This class should only be extended within google-cloud-java

Parameters
Name	Description
options	ServiceOptionsT
entity	EntityT
uploadId	String

Methods

capture()

public RestorableState<WriteChannel> capture()

Captures the write channel state so that it can be saved and restored afterwards. The original WriteChannel and the restored one should not both be used. Closing one channel causes the other channel to close; subsequent writes will fail.

Returns
Type	Description
RestorableState<WriteChannel>

close()

public final void close()

Exceptions
Type	Description
IOException

flushBuffer(int length, boolean last)

protected abstract void flushBuffer(int length, boolean last)

Writes length bytes of #getBuffer() to the #getUploadId() URL.

Parameters
Name	Description
length	int the number of bytes to write from #getBuffer()
last	boolean if true the resumable session is closed

getBuffer()

protected byte[] getBuffer()

Returns
Type	Description
byte[]

getChunkSize()

protected int getChunkSize()

Returns
Type	Description
int

getDefaultChunkSize()

protected int getDefaultChunkSize()

Returns
Type	Description
int

getEntity()

protected EntityT getEntity()

Returns
Type	Description
EntityT

getLimit()

protected int getLimit()

Returns
Type	Description
int

getMinChunkSize()

protected int getMinChunkSize()

Returns
Type	Description
int

getOptions()

protected ServiceOptionsT getOptions()

Returns
Type	Description
ServiceOptionsT

getPosition()

protected long getPosition()

Returns
Type	Description
long

getUploadId()

protected String getUploadId()

Returns
Type	Description
String

isOpen()

public boolean isOpen()

Returns
Type	Description
boolean

restore(BaseWriteChannel.BaseState state)

protected void restore(BaseWriteChannel.BaseState state)

Restores the state of the current write channel given a BaseState object.

Parameter
Name	Description
state	BaseState

setChunkSize(int chunkSize)

public final void setChunkSize(int chunkSize)

Sets the minimum size that will be written by a single RPC. Written data will be buffered and only flushed upon reaching this size or closing the channel.

Parameter
Name	Description
chunkSize	int

stateBuilder()

protected abstract BaseWriteChannel.BaseState.Builder<ServiceOptionsT,EntityT> stateBuilder()

Creates a BaseState.Builder for the current write channel.

Returns
Type	Description
Builder<ServiceOptionsT,EntityT>

write(ByteBuffer byteBuffer)

public final int write(ByteBuffer byteBuffer)

Parameter
Name	Description
byteBuffer	ByteBuffer

Returns
Type	Description
int

Exceptions
Type	Description
IOException