Send feedback
Class FlowInvocation (0.87.0)
Stay organized with collections
Save and categorize content based on your preferences.
public final class FlowInvocation extends GeneratedMessageV3 implements FlowInvocationOrBuilder
Stores metadata of the invocation of a CX flow.
Protobuf type google.cloud.dialogflow.cx.v3beta1.FlowInvocation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
FLOW_FIELD_NUMBER
public static final int FLOW_FIELD_NUMBER
Field Value
Type Description
int
FLOW_STATE_FIELD_NUMBER
public static final int FLOW_STATE_FIELD_NUMBER
Field Value
Type Description
int
public static final int INPUT_ACTION_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int
OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER
public static final int OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static FlowInvocation getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static FlowInvocation . Builder newBuilder ()
newBuilder(FlowInvocation prototype)
public static FlowInvocation . Builder newBuilder ( FlowInvocation prototype )
public static FlowInvocation parseDelimitedFrom ( InputStream input )
public static FlowInvocation parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static FlowInvocation parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FlowInvocation parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static FlowInvocation parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FlowInvocation parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static FlowInvocation parseFrom ( CodedInputStream input )
public static FlowInvocation parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static FlowInvocation parseFrom ( InputStream input )
public static FlowInvocation parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static FlowInvocation parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FlowInvocation parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<FlowInvocation> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public FlowInvocation getDefaultInstanceForType ()
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()
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];
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.
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.
public StructOrBuilder getInputActionParametersOrBuilder ()
Optional. A list of input parameters for the flow.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
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.
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];
getParserForType()
public Parser<FlowInvocation> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public FlowInvocation . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FlowInvocation . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public FlowInvocation . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
