Class FlowInvocation (0.64.0) 

public final class FlowInvocation extends GeneratedMessageV3 implements FlowInvocationOrBuilder

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

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FlowInvocation

Static Fields

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

INPUT_ACTION_PARAMETERS_FIELD_NUMBER

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()
Returns
Type Description
FlowInvocation

getDescriptor()

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

newBuilder()

public static FlowInvocation.Builder newBuilder()
Returns
Type Description
FlowInvocation.Builder

newBuilder(FlowInvocation prototype)

public static FlowInvocation.Builder newBuilder(FlowInvocation prototype)
Parameter
Name Description
prototype FlowInvocation
Returns
Type Description
FlowInvocation.Builder

parseDelimitedFrom(InputStream input)

public static FlowInvocation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FlowInvocation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FlowInvocation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FlowInvocation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FlowInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FlowInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FlowInvocation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FlowInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FlowInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FlowInvocation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FlowInvocation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FlowInvocation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FlowInvocation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FlowInvocation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FlowInvocation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FlowInvocation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FlowInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FlowInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FlowInvocation> parser()
Returns
Type Description
Parser<FlowInvocation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public FlowInvocation getDefaultInstanceForType()
Returns
Type Description
FlowInvocation

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.

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.

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.

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

getParserForType()

public Parser<FlowInvocation> getParserForType()
Returns
Type Description
Parser<FlowInvocation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FlowInvocation.Builder newBuilderForType()
Returns
Type Description
FlowInvocation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FlowInvocation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FlowInvocation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FlowInvocation.Builder toBuilder()
Returns
Type Description
FlowInvocation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException