Class TurnMetadata.Builder (0.19.0)

public static final class TurnMetadata.Builder extends GeneratedMessage.Builder<TurnMetadata.Builder> implements TurnMetadataOrBuilder

Turn-level metadata and intent categorization.

Protobuf type google.cloud.ces.v1beta.TurnMetadata

Static Methods

getDescriptor()

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

Methods

build()

public TurnMetadata build()
Returns
Type Description
TurnMetadata

buildPartial()

public TurnMetadata buildPartial()
Returns
Type Description
TurnMetadata

clear()

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

clearContractDraftComplete()

public TurnMetadata.Builder clearContractDraftComplete()

Set on the terminal event of a contract draft whose every placeholder is resolved (contract_progress is 100%), whether or not the draft was published. Clients complete and dismiss the contract progress display on it; publication is reported separately by contract_finalized.

bool contract_draft_complete = 5;

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.

clearContractFinalized()

public TurnMetadata.Builder clearContractFinalized()

Set on the final artifact event of a turn whose contract draft was published (a revision was activated). Terminal for the clarification flow of this draft: contract_progress is authoritative and complete.

bool contract_finalized = 3;

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.

clearContractRelated()

public TurnMetadata.Builder clearContractRelated()

Indicates whether this assistant turn was contract-related (e.g. contract drafting, alignment, extraction, or revision).

bool contract_related = 1;

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.

clearContractStreamingPhase()

public TurnMetadata.Builder clearContractStreamingPhase()

Set only on in-flight progress estimates emitted while a contract artifact fence is streaming, and on the revision-turn-start event. Unset on authoritative payloads.

.google.cloud.ces.v1beta.TurnMetadata.ContractStreamingPhase contract_streaming_phase = 4;

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.

getContractDraftComplete()

public boolean getContractDraftComplete()

Set on the terminal event of a contract draft whose every placeholder is resolved (contract_progress is 100%), whether or not the draft was published. Clients complete and dismiss the contract progress display on it; publication is reported separately by contract_finalized.

bool contract_draft_complete = 5;

Returns
Type Description
boolean

The contractDraftComplete.

getContractFinalized()

public boolean getContractFinalized()

Set on the final artifact event of a turn whose contract draft was published (a revision was activated). Terminal for the clarification flow of this draft: contract_progress is authoritative and complete.

bool contract_finalized = 3;

Returns
Type Description
boolean

The contractFinalized.

getContractRelated()

public boolean getContractRelated()

Indicates whether this assistant turn was contract-related (e.g. contract drafting, alignment, extraction, or revision).

bool contract_related = 1;

Returns
Type Description
boolean

The contractRelated.

getContractStreamingPhase()

public TurnMetadata.ContractStreamingPhase getContractStreamingPhase()

Set only on in-flight progress estimates emitted while a contract artifact fence is streaming, and on the revision-turn-start event. Unset on authoritative payloads.

.google.cloud.ces.v1beta.TurnMetadata.ContractStreamingPhase contract_streaming_phase = 4;

Returns
Type Description
TurnMetadata.ContractStreamingPhase

The contractStreamingPhase.

getContractStreamingPhaseValue()

public int getContractStreamingPhaseValue()

Set only on in-flight progress estimates emitted while a contract artifact fence is streaming, and on the revision-turn-start event. Unset on authoritative payloads.

.google.cloud.ces.v1beta.TurnMetadata.ContractStreamingPhase contract_streaming_phase = 4;

Returns
Type Description
int

The enum numeric value on the wire for contractStreamingPhase.

getDefaultInstanceForType()

public TurnMetadata getDefaultInstanceForType()
Returns
Type Description
TurnMetadata

getDescriptorForType()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TurnMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setContractDraftComplete(boolean value)

public TurnMetadata.Builder setContractDraftComplete(boolean value)

Set on the terminal event of a contract draft whose every placeholder is resolved (contract_progress is 100%), whether or not the draft was published. Clients complete and dismiss the contract progress display on it; publication is reported separately by contract_finalized.

bool contract_draft_complete = 5;

Parameter
Name Description
value boolean

The contractDraftComplete to set.

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.

setContractFinalized(boolean value)

public TurnMetadata.Builder setContractFinalized(boolean value)

Set on the final artifact event of a turn whose contract draft was published (a revision was activated). Terminal for the clarification flow of this draft: contract_progress is authoritative and complete.

bool contract_finalized = 3;

Parameter
Name Description
value boolean

The contractFinalized to set.

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.

setContractRelated(boolean value)

public TurnMetadata.Builder setContractRelated(boolean value)

Indicates whether this assistant turn was contract-related (e.g. contract drafting, alignment, extraction, or revision).

bool contract_related = 1;

Parameter
Name Description
value boolean

The contractRelated to set.

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.

setContractStreamingPhase(TurnMetadata.ContractStreamingPhase value)

public TurnMetadata.Builder setContractStreamingPhase(TurnMetadata.ContractStreamingPhase value)

Set only on in-flight progress estimates emitted while a contract artifact fence is streaming, and on the revision-turn-start event. Unset on authoritative payloads.

.google.cloud.ces.v1beta.TurnMetadata.ContractStreamingPhase contract_streaming_phase = 4;

Parameter
Name Description
value TurnMetadata.ContractStreamingPhase

The contractStreamingPhase to set.

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.

setContractStreamingPhaseValue(int value)

public TurnMetadata.Builder setContractStreamingPhaseValue(int value)

Set only on in-flight progress estimates emitted while a contract artifact fence is streaming, and on the revision-turn-start event. Unset on authoritative payloads.

.google.cloud.ces.v1beta.TurnMetadata.ContractStreamingPhase contract_streaming_phase = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for contractStreamingPhase to set.

Returns
Type Description
TurnMetadata.Builder

This builder for chaining.