Class ArtifactChunk (0.19.0)

public final class ArtifactChunk extends GeneratedMessage implements ArtifactChunkOrBuilder

A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the GCS URI once the file has been persisted.

Protobuf type google.cloud.ces.v1beta.ArtifactChunk

Static Fields

ARTIFACT_ID_FIELD_NUMBER

public static final int ARTIFACT_ID_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_DELTA_FIELD_NUMBER

public static final int CONTENT_DELTA_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER
Field Value
Type Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ArtifactChunk getDefaultInstance()
Returns
Type Description
ArtifactChunk

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

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

newBuilder(ArtifactChunk prototype)

public static ArtifactChunk.Builder newBuilder(ArtifactChunk prototype)
Parameter
Name Description
prototype ArtifactChunk
Returns
Type Description
ArtifactChunk.Builder

parseDelimitedFrom(InputStream input)

public static ArtifactChunk parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ArtifactChunk parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ArtifactChunk parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ArtifactChunk parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ArtifactChunk parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ArtifactChunk parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ArtifactChunk parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ArtifactChunk parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ArtifactChunk parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ArtifactChunk parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ArtifactChunk parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ArtifactChunk parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ArtifactChunk
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ArtifactChunk> parser()
Returns
Type Description
Parser<ArtifactChunk>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArtifactId()

public String getArtifactId()

Identifier of the artifact, stable across all chunks of one artifact within the stream.

string artifact_id = 1;

Returns
Type Description
String

The artifactId.

getArtifactIdBytes()

public ByteString getArtifactIdBytes()

Identifier of the artifact, stable across all chunks of one artifact within the stream.

string artifact_id = 1;

Returns
Type Description
ByteString

The bytes for artifactId.

getContentDelta()

public String getContentDelta()

Incremental artifact content. Set on DELTA chunks.

string content_delta = 4;

Returns
Type Description
String

The contentDelta.

getContentDeltaBytes()

public ByteString getContentDeltaBytes()

Incremental artifact content. Set on DELTA chunks.

string content_delta = 4;

Returns
Type Description
ByteString

The bytes for contentDelta.

getDefaultInstanceForType()

public ArtifactChunk getDefaultInstanceForType()
Returns
Type Description
ArtifactChunk

getDisplayName()

public String getDisplayName()

The file name shown to the user, e.g. "hotel_booking_tdd.md". Set on STARTED (and repeated on FINALIZED).

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The file name shown to the user, e.g. "hotel_booking_tdd.md". Set on STARTED (and repeated on FINALIZED).

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getGcsUri()

public String getGcsUri()

The GCS object the artifact was persisted to. Set on FINALIZED chunks.

string gcs_uri = 5;

Returns
Type Description
String

The gcsUri.

getGcsUriBytes()

public ByteString getGcsUriBytes()

The GCS object the artifact was persisted to. Set on FINALIZED chunks.

string gcs_uri = 5;

Returns
Type Description
ByteString

The bytes for gcsUri.

getMimeType()

public String getMimeType()

The IANA media type of the artifact content, e.g. "text/markdown".

string mime_type = 3;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

The IANA media type of the artifact content, e.g. "text/markdown".

string mime_type = 3;

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

public Parser<ArtifactChunk> getParserForType()
Returns
Type Description
Parser<ArtifactChunk>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public ArtifactChunk.State getState()

Lifecycle position of this chunk.

.google.cloud.ces.v1beta.ArtifactChunk.State state = 6;

Returns
Type Description
ArtifactChunk.State

The state.

getStateValue()

public int getStateValue()

Lifecycle position of this chunk.

.google.cloud.ces.v1beta.ArtifactChunk.State state = 6;

Returns
Type Description
int

The enum numeric value on the wire for state.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ArtifactChunk.Builder newBuilderForType()
Returns
Type Description
ArtifactChunk.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ArtifactChunk.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ArtifactChunk.Builder
Overrides

toBuilder()

public ArtifactChunk.Builder toBuilder()
Returns
Type Description
ArtifactChunk.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException