Class FlowInvocation.Builder (0.53.0)

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

Stores metadata of the invocation of a CX flow. Next Id: 7

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

Static Methods

getDescriptor()

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

Methods

addAllInputParameters(Iterable<? extends ActionParameter> values)

public FlowInvocation.Builder addAllInputParameters(Iterable<? extends ActionParameter> values)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameter>
Returns
Type Description
FlowInvocation.Builder

addAllOutputParameters(Iterable<? extends ActionParameter> values)

public FlowInvocation.Builder addAllOutputParameters(Iterable<? extends ActionParameter> values)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameter>
Returns
Type Description
FlowInvocation.Builder

addInputParameters(ActionParameter value)

public FlowInvocation.Builder addInputParameters(ActionParameter value)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameter
Name Description
value ActionParameter
Returns
Type Description
FlowInvocation.Builder

addInputParameters(ActionParameter.Builder builderForValue)

public FlowInvocation.Builder addInputParameters(ActionParameter.Builder builderForValue)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameter
Name Description
builderForValue ActionParameter.Builder
Returns
Type Description
FlowInvocation.Builder

addInputParameters(int index, ActionParameter value)

public FlowInvocation.Builder addInputParameters(int index, ActionParameter value)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameters
Name Description
index int
value ActionParameter
Returns
Type Description
FlowInvocation.Builder

addInputParameters(int index, ActionParameter.Builder builderForValue)

public FlowInvocation.Builder addInputParameters(int index, ActionParameter.Builder builderForValue)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameters
Name Description
index int
builderForValue ActionParameter.Builder
Returns
Type Description
FlowInvocation.Builder

addInputParametersBuilder()

public ActionParameter.Builder addInputParametersBuilder()

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Returns
Type Description
ActionParameter.Builder

addInputParametersBuilder(int index)

public ActionParameter.Builder addInputParametersBuilder(int index)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameter
Name Description
index int
Returns
Type Description
ActionParameter.Builder

addOutputParameters(ActionParameter value)

public FlowInvocation.Builder addOutputParameters(ActionParameter value)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameter
Name Description
value ActionParameter
Returns
Type Description
FlowInvocation.Builder

addOutputParameters(ActionParameter.Builder builderForValue)

public FlowInvocation.Builder addOutputParameters(ActionParameter.Builder builderForValue)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameter
Name Description
builderForValue ActionParameter.Builder
Returns
Type Description
FlowInvocation.Builder

addOutputParameters(int index, ActionParameter value)

public FlowInvocation.Builder addOutputParameters(int index, ActionParameter value)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameters
Name Description
index int
value ActionParameter
Returns
Type Description
FlowInvocation.Builder

addOutputParameters(int index, ActionParameter.Builder builderForValue)

public FlowInvocation.Builder addOutputParameters(int index, ActionParameter.Builder builderForValue)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameters
Name Description
index int
builderForValue ActionParameter.Builder
Returns
Type Description
FlowInvocation.Builder

addOutputParametersBuilder()

public ActionParameter.Builder addOutputParametersBuilder()

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Returns
Type Description
ActionParameter.Builder

addOutputParametersBuilder(int index)

public ActionParameter.Builder addOutputParametersBuilder(int index)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionParameter.Builder

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/<Project ID>/locations/<Location ID>/agents/<Agent flows/<Flow ID>.

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.

clearInputParameters()

public FlowInvocation.Builder clearInputParameters()

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

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

clearOutputParameters()

public FlowInvocation.Builder clearOutputParameters()

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

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/<Project ID>/locations/<Location ID>/agents/<Agent flows/<Flow ID>.

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/<Project ID>/locations/<Location ID>/agents/<Agent flows/<Flow ID>.

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.

getInputParameters(int index)

public ActionParameter getInputParameters(int index)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameter
Name Description
index int
Returns
Type Description
ActionParameter

getInputParametersBuilder(int index)

public ActionParameter.Builder getInputParametersBuilder(int index)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameter
Name Description
index int
Returns
Type Description
ActionParameter.Builder

getInputParametersBuilderList()

public List<ActionParameter.Builder> getInputParametersBuilderList()

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Returns
Type Description
List<Builder>

getInputParametersCount()

public int getInputParametersCount()

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Returns
Type Description
int

getInputParametersList()

public List<ActionParameter> getInputParametersList()

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Returns
Type Description
List<ActionParameter>

getInputParametersOrBuilder(int index)

public ActionParameterOrBuilder getInputParametersOrBuilder(int index)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameter
Name Description
index int
Returns
Type Description
ActionParameterOrBuilder

getInputParametersOrBuilderList()

public List<? extends ActionParameterOrBuilder> getInputParametersOrBuilderList()

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameterOrBuilder>

getOutputParameters(int index)

public ActionParameter getOutputParameters(int index)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionParameter

getOutputParametersBuilder(int index)

public ActionParameter.Builder getOutputParametersBuilder(int index)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionParameter.Builder

getOutputParametersBuilderList()

public List<ActionParameter.Builder> getOutputParametersBuilderList()

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Returns
Type Description
List<Builder>

getOutputParametersCount()

public int getOutputParametersCount()

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Returns
Type Description
int

getOutputParametersList()

public List<ActionParameter> getOutputParametersList()

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Returns
Type Description
List<ActionParameter>

getOutputParametersOrBuilder(int index)

public ActionParameterOrBuilder getOutputParametersOrBuilder(int index)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionParameterOrBuilder

getOutputParametersOrBuilderList()

public List<? extends ActionParameterOrBuilder> getOutputParametersOrBuilderList()

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameterOrBuilder>

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeInputParameters(int index)

public FlowInvocation.Builder removeInputParameters(int index)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameter
Name Description
index int
Returns
Type Description
FlowInvocation.Builder

removeOutputParameters(int index)

public FlowInvocation.Builder removeOutputParameters(int index)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameter
Name Description
index int
Returns
Type Description
FlowInvocation.Builder

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/<Project ID>/locations/<Location ID>/agents/<Agent flows/<Flow ID>.

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/<Project ID>/locations/<Location ID>/agents/<Agent flows/<Flow ID>.

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.

setInputParameters(int index, ActionParameter value)

public FlowInvocation.Builder setInputParameters(int index, ActionParameter value)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameters
Name Description
index int
value ActionParameter
Returns
Type Description
FlowInvocation.Builder

setInputParameters(int index, ActionParameter.Builder builderForValue)

public FlowInvocation.Builder setInputParameters(int index, ActionParameter.Builder builderForValue)

A list of input parameters for the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 2;

Parameters
Name Description
index int
builderForValue ActionParameter.Builder
Returns
Type Description
FlowInvocation.Builder

setOutputParameters(int index, ActionParameter value)

public FlowInvocation.Builder setOutputParameters(int index, ActionParameter value)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameters
Name Description
index int
value ActionParameter
Returns
Type Description
FlowInvocation.Builder

setOutputParameters(int index, ActionParameter.Builder builderForValue)

public FlowInvocation.Builder setOutputParameters(int index, ActionParameter.Builder builderForValue)

A list of output parameters generated by the flow invocation.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 3;

Parameters
Name Description
index int
builderForValue ActionParameter.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