Class FlowInvocation.Builder (0.74.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FlowInvocation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
FlowInvocation.Builder
Overrides

build()

public FlowInvocation build()
Returns
TypeDescription
FlowInvocation

buildPartial()

public FlowInvocation buildPartial()
Returns
TypeDescription
FlowInvocation

clear()

public FlowInvocation.Builder clear()
Returns
TypeDescription
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
TypeDescription
FlowInvocation.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FlowInvocation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
FlowInvocation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public FlowInvocation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
FlowInvocation.Builder

clone()

public FlowInvocation.Builder clone()
Returns
TypeDescription
FlowInvocation.Builder
Overrides

getDefaultInstanceForType()

public FlowInvocation getDefaultInstanceForType()
Returns
TypeDescription
FlowInvocation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the outputActionParameters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(FlowInvocation other)

public FlowInvocation.Builder mergeFrom(FlowInvocation other)
Parameter
NameDescription
otherFlowInvocation
Returns
TypeDescription
FlowInvocation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FlowInvocation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlowInvocation.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public FlowInvocation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
FlowInvocation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FlowInvocation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
FlowInvocation.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FlowInvocation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The flow to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for flow to set.

Returns
TypeDescription
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
NameDescription
valueOutputState

The flowState to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
FlowInvocation.Builder

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

public FlowInvocation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
FlowInvocation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FlowInvocation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
FlowInvocation.Builder
Overrides