Class FlowInvocation.Builder (0.66.0)

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

Stores metadata of the invocation of a CX flow.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FlowInvocation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FlowInvocation.Builder
Overrides

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

clearField(Descriptors.FieldDescriptor field)

public FlowInvocation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FlowInvocation.Builder
Overrides

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.v3beta1.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FlowInvocation.Builder

This builder for chaining.

clearInputActionParameters()

public FlowInvocation.Builder clearInputActionParameters()

Optional. A list of input parameters for the flow.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlowInvocation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public FlowInvocation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FlowInvocation.Builder
Overrides

clearOutputActionParameters()

public FlowInvocation.Builder clearOutputActionParameters()

Optional. A list of output parameters generated by the flow invocation.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlowInvocation.Builder

clone()

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

getDefaultInstanceForType()

public FlowInvocation getDefaultInstanceForType()
Returns
Type Description
FlowInvocation

getDescriptorForType()

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

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.v3beta1.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.v3beta1.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for flowState.

getInputActionParameters()

public Struct getInputActionParameters()

Optional. A list of input parameters for the flow.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The inputActionParameters.

getInputActionParametersBuilder()

public Struct.Builder getInputActionParametersBuilder()

Optional. A list of input parameters for the flow.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getInputActionParametersOrBuilder()

public StructOrBuilder getInputActionParametersOrBuilder()

Optional. A list of input parameters for the flow.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getOutputActionParameters()

public Struct getOutputActionParameters()

Optional. A list of output parameters generated by the flow invocation.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The outputActionParameters.

getOutputActionParametersBuilder()

public Struct.Builder getOutputActionParametersBuilder()

Optional. A list of output parameters generated by the flow invocation.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getOutputActionParametersOrBuilder()

public StructOrBuilder getOutputActionParametersOrBuilder()

Optional. A list of output parameters generated by the flow invocation.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

hasInputActionParameters()

public boolean hasInputActionParameters()

Optional. A list of input parameters for the flow.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inputActionParameters field is set.

hasOutputActionParameters()

public boolean hasOutputActionParameters()

Optional. A list of output parameters generated by the flow invocation.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the outputActionParameters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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

mergeInputActionParameters(Struct value)

public FlowInvocation.Builder mergeInputActionParameters(Struct value)

Optional. A list of input parameters for the flow.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
FlowInvocation.Builder

mergeOutputActionParameters(Struct value)

public FlowInvocation.Builder mergeOutputActionParameters(Struct value)

Optional. A list of output parameters generated by the flow invocation.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
FlowInvocation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FlowInvocation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FlowInvocation.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public FlowInvocation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FlowInvocation.Builder
Overrides

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.v3beta1.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.v3beta1.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.

setInputActionParameters(Struct value)

public FlowInvocation.Builder setInputActionParameters(Struct value)

Optional. A list of input parameters for the flow.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
FlowInvocation.Builder

setInputActionParameters(Struct.Builder builderForValue)

public FlowInvocation.Builder setInputActionParameters(Struct.Builder builderForValue)

Optional. A list of input parameters for the flow.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
FlowInvocation.Builder

setOutputActionParameters(Struct value)

public FlowInvocation.Builder setOutputActionParameters(Struct value)

Optional. A list of output parameters generated by the flow invocation.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
FlowInvocation.Builder

setOutputActionParameters(Struct.Builder builderForValue)

public FlowInvocation.Builder setOutputActionParameters(Struct.Builder builderForValue)

Optional. A list of output parameters generated by the flow invocation.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
FlowInvocation.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FlowInvocation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FlowInvocation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FlowInvocation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FlowInvocation.Builder
Overrides