Class OperationCompletedEvent.Builder (0.19.0)

public static final class OperationCompletedEvent.Builder extends GeneratedMessage.Builder<OperationCompletedEvent.Builder> 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 Methods

getDescriptor()

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

Methods

build()

public OperationCompletedEvent build()
Returns
Type Description
OperationCompletedEvent

buildPartial()

public OperationCompletedEvent buildPartial()
Returns
Type Description
OperationCompletedEvent

clear()

public OperationCompletedEvent.Builder clear()
Returns
Type Description
OperationCompletedEvent.Builder
Overrides

clearDeduplicationToken()

public OperationCompletedEvent.Builder clearDeduplicationToken()

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

string deduplication_token = 5;

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

clearError()

public OperationCompletedEvent.Builder clearError()

Optional canonical error status if the operation failed.

.google.rpc.Status error = 6;

Returns
Type Description
OperationCompletedEvent.Builder

clearMetadata()

public OperationCompletedEvent.Builder clearMetadata()

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

.google.protobuf.Struct metadata = 7;

Returns
Type Description
OperationCompletedEvent.Builder

clearOperationName()

public OperationCompletedEvent.Builder clearOperationName()

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

string operation_name = 1;

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

clearOperationType()

public OperationCompletedEvent.Builder clearOperationType()

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

string operation_type = 3;

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

clearStatus()

public OperationCompletedEvent.Builder clearStatus()

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

string status = 4;

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

clearTargetResourceName()

public OperationCompletedEvent.Builder clearTargetResourceName()

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
OperationCompletedEvent.Builder

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getErrorBuilder()

public Status.Builder getErrorBuilder()

Optional canonical error status if the operation failed.

.google.rpc.Status error = 6;

Returns
Type Description
com.google.rpc.Status.Builder

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.

getMetadataBuilder()

public Struct.Builder getMetadataBuilder()

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

.google.protobuf.Struct metadata = 7;

Returns
Type Description
Builder

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeError(Status value)

public OperationCompletedEvent.Builder mergeError(Status value)

Optional canonical error status if the operation failed.

.google.rpc.Status error = 6;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
OperationCompletedEvent.Builder

mergeFrom(OperationCompletedEvent other)

public OperationCompletedEvent.Builder mergeFrom(OperationCompletedEvent other)
Parameter
Name Description
other OperationCompletedEvent
Returns
Type Description
OperationCompletedEvent.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OperationCompletedEvent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationCompletedEvent.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public OperationCompletedEvent.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
OperationCompletedEvent.Builder
Overrides

mergeMetadata(Struct value)

public OperationCompletedEvent.Builder mergeMetadata(Struct value)

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

.google.protobuf.Struct metadata = 7;

Parameter
Name Description
value Struct
Returns
Type Description
OperationCompletedEvent.Builder

setDeduplicationToken(String value)

public OperationCompletedEvent.Builder setDeduplicationToken(String value)

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

string deduplication_token = 5;

Parameter
Name Description
value String

The deduplicationToken to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setDeduplicationTokenBytes(ByteString value)

public OperationCompletedEvent.Builder setDeduplicationTokenBytes(ByteString value)

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

string deduplication_token = 5;

Parameter
Name Description
value ByteString

The bytes for deduplicationToken to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setError(Status value)

public OperationCompletedEvent.Builder setError(Status value)

Optional canonical error status if the operation failed.

.google.rpc.Status error = 6;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
OperationCompletedEvent.Builder

setError(Status.Builder builderForValue)

public OperationCompletedEvent.Builder setError(Status.Builder builderForValue)

Optional canonical error status if the operation failed.

.google.rpc.Status error = 6;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
OperationCompletedEvent.Builder

setMetadata(Struct value)

public OperationCompletedEvent.Builder setMetadata(Struct value)

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

.google.protobuf.Struct metadata = 7;

Parameter
Name Description
value Struct
Returns
Type Description
OperationCompletedEvent.Builder

setMetadata(Struct.Builder builderForValue)

public OperationCompletedEvent.Builder setMetadata(Struct.Builder builderForValue)

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

.google.protobuf.Struct metadata = 7;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OperationCompletedEvent.Builder

setOperationName(String value)

public OperationCompletedEvent.Builder setOperationName(String value)

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

string operation_name = 1;

Parameter
Name Description
value String

The operationName to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setOperationNameBytes(ByteString value)

public OperationCompletedEvent.Builder setOperationNameBytes(ByteString value)

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

string operation_name = 1;

Parameter
Name Description
value ByteString

The bytes for operationName to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setOperationType(String value)

public OperationCompletedEvent.Builder setOperationType(String value)

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

string operation_type = 3;

Parameter
Name Description
value String

The operationType to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setOperationTypeBytes(ByteString value)

public OperationCompletedEvent.Builder setOperationTypeBytes(ByteString value)

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

string operation_type = 3;

Parameter
Name Description
value ByteString

The bytes for operationType to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setStatus(String value)

public OperationCompletedEvent.Builder setStatus(String value)

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

string status = 4;

Parameter
Name Description
value String

The status to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setStatusBytes(ByteString value)

public OperationCompletedEvent.Builder setStatusBytes(ByteString value)

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

string status = 4;

Parameter
Name Description
value ByteString

The bytes for status to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setTargetResourceName(String value)

public OperationCompletedEvent.Builder setTargetResourceName(String value)

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

string target_resource_name = 2;

Parameter
Name Description
value String

The targetResourceName to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.

setTargetResourceNameBytes(ByteString value)

public OperationCompletedEvent.Builder setTargetResourceNameBytes(ByteString value)

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

string target_resource_name = 2;

Parameter
Name Description
value ByteString

The bytes for targetResourceName to set.

Returns
Type Description
OperationCompletedEvent.Builder

This builder for chaining.