Class OperationCompletedEvent (0.19.0)

public final class OperationCompletedEvent extends GeneratedMessage implements OperationCompletedEventOrBuilder

Event sent by the client or background worker to resume an assistant session after an asynchronous Long-Running Operation (LRO) completes.

Protobuf type google.cloud.ces.v1beta.OperationCompletedEvent

Static Fields

DEDUPLICATION_TOKEN_FIELD_NUMBER

public static final int DEDUPLICATION_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_NAME_FIELD_NUMBER

public static final int OPERATION_NAME_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_TYPE_FIELD_NUMBER

public static final int OPERATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TARGET_RESOURCE_NAME_FIELD_NUMBER

public static final int TARGET_RESOURCE_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OperationCompletedEvent getDefaultInstance()
Returns
Type Description
OperationCompletedEvent

getDescriptor()

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

newBuilder()

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

newBuilder(OperationCompletedEvent prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDeduplicationToken()

public String getDeduplicationToken()

Optional deduplication token (e.g. UUID) to prevent duplicate turn execution from concurrent browser tabs.

string deduplication_token = 5;

Returns
Type Description
String

The deduplicationToken.

getDeduplicationTokenBytes()

public ByteString getDeduplicationTokenBytes()

Optional deduplication token (e.g. UUID) to prevent duplicate turn execution from concurrent browser tabs.

string deduplication_token = 5;

Returns
Type Description
ByteString

The bytes for deduplicationToken.

getDefaultInstanceForType()

public OperationCompletedEvent getDefaultInstanceForType()
Returns
Type Description
OperationCompletedEvent

getError()

public Status getError()

Optional canonical error status if the operation failed.

.google.rpc.Status error = 6;

Returns
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Optional canonical error status if the operation failed.

.google.rpc.Status error = 6;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getMetadata()

public Struct getMetadata()

Optional structured result metadata (e.g. pass_rate, total_examples, export_uri).

.google.protobuf.Struct metadata = 7;

Returns
Type Description
Struct

The metadata.

getMetadataOrBuilder()

public StructOrBuilder getMetadataOrBuilder()

Optional structured result metadata (e.g. pass_rate, total_examples, export_uri).

.google.protobuf.Struct metadata = 7;

Returns
Type Description
StructOrBuilder

getOperationName()

public String getOperationName()

The operation resource name (e.g. operations/{op}).

string operation_name = 1;

Returns
Type Description
String

The operationName.

getOperationNameBytes()

public ByteString getOperationNameBytes()

The operation resource name (e.g. operations/{op}).

string operation_name = 1;

Returns
Type Description
ByteString

The bytes for operationName.

getOperationType()

public String getOperationType()

The operation type or tool name (e.g. "run_evaluation", "copy_app", "export_app").

string operation_type = 3;

Returns
Type Description
String

The operationType.

getOperationTypeBytes()

public ByteString getOperationTypeBytes()

The operation type or tool name (e.g. "run_evaluation", "copy_app", "export_app").

string operation_type = 3;

Returns
Type Description
ByteString

The bytes for operationType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public String getStatus()

Status of the operation run (e.g. "SUCCEEDED", "FAILED", "CANCELLED").

string status = 4;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

Status of the operation run (e.g. "SUCCEEDED", "FAILED", "CANCELLED").

string status = 4;

Returns
Type Description
ByteString

The bytes for status.

getTargetResourceName()

public String getTargetResourceName()

The primary resource targeted or produced by the operation (e.g. evaluation run ID, app ID, dataset ID).

string target_resource_name = 2;

Returns
Type Description
String

The targetResourceName.

getTargetResourceNameBytes()

public ByteString getTargetResourceNameBytes()

The primary resource targeted or produced by the operation (e.g. evaluation run ID, app ID, dataset ID).

string target_resource_name = 2;

Returns
Type Description
ByteString

The bytes for targetResourceName.

hasError()

public boolean hasError()

Optional canonical error status if the operation failed.

.google.rpc.Status error = 6;

Returns
Type Description
boolean

Whether the error field is set.

hasMetadata()

public boolean hasMetadata()

Optional structured result metadata (e.g. pass_rate, total_examples, export_uri).

.google.protobuf.Struct metadata = 7;

Returns
Type Description
boolean

Whether the metadata field is set.

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 OperationCompletedEvent.Builder newBuilderForType()
Returns
Type Description
OperationCompletedEvent.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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