Class FlowInvocation.Builder (0.94.0)

public static final class FlowInvocation.Builder extends GeneratedMessage.Builder<FlowInvocation.Builder> implements FlowInvocationOrBuilder

Stores metadata of the invocation of a CX flow.

Protobuf type google.cloud.dialogflow.cx.v3.FlowInvocation

Static Methods

getDescriptor()

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

Methods

build()

public FlowInvocation build()
Returns
Type Description
FlowInvocation

buildPartial()

public FlowInvocation buildPartial()
Returns
Type Description
FlowInvocation

clear()

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

clearDisplayName()

public FlowInvocation.Builder clearDisplayName()

Output only. The display name of the flow.

string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

clearFlow()

public FlowInvocation.Builder clearFlow()

Required. The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

string flow = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

clearFlowState()

public FlowInvocation.Builder clearFlowState()

Required. Flow invocation's output state.

.google.cloud.dialogflow.cx.v3.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

getDefaultInstanceForType()

public FlowInvocation getDefaultInstanceForType()
Returns
Type Description
FlowInvocation

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Output only. The display name of the flow.

string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The display name of the flow.

string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getFlow()

public String getFlow()

Required. The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

string flow = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The flow.

getFlowBytes()

public ByteString getFlowBytes()

Required. The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

string flow = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for flow.

getFlowState()

public OutputState getFlowState()

Required. Flow invocation's output state.

.google.cloud.dialogflow.cx.v3.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputState

The flowState.

getFlowStateValue()

public int getFlowStateValue()

Required. Flow invocation's output state.

.google.cloud.dialogflow.cx.v3.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for flowState.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FlowInvocation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setDisplayName(String value)

public FlowInvocation.Builder setDisplayName(String value)

Output only. The display name of the flow.

string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public FlowInvocation.Builder setDisplayNameBytes(ByteString value)

Output only. The display name of the flow.

string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

setFlow(String value)

public FlowInvocation.Builder setFlow(String value)

Required. The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

string flow = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The flow to set.

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

setFlowBytes(ByteString value)

public FlowInvocation.Builder setFlowBytes(ByteString value)

Required. The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

string flow = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for flow to set.

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

setFlowState(OutputState value)

public FlowInvocation.Builder setFlowState(OutputState value)

Required. Flow invocation's output state.

.google.cloud.dialogflow.cx.v3.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value OutputState

The flowState to set.

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

setFlowStateValue(int value)

public FlowInvocation.Builder setFlowStateValue(int value)

Required. Flow invocation's output state.

.google.cloud.dialogflow.cx.v3.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

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

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.