Class FlowInvocation (0.75.0)

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

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

FLOW_FIELD_NUMBER

public static final int FLOW_FIELD_NUMBER
Field Value
TypeDescription
int

FLOW_STATE_FIELD_NUMBER

public static final int FLOW_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_ACTION_PARAMETERS_FIELD_NUMBER

public static final int INPUT_ACTION_PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER

public static final int OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FlowInvocation getDefaultInstance()
Returns
TypeDescription
FlowInvocation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FlowInvocation.Builder newBuilder()
Returns
TypeDescription
FlowInvocation.Builder

newBuilder(FlowInvocation )

public static FlowInvocation.Builder newBuilder(FlowInvocation )
Parameter
NameDescription
FlowInvocation
Returns
TypeDescription
FlowInvocation.Builder

parseDelimitedFrom(InputStream input)

public static FlowInvocation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FlowInvocation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FlowInvocation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FlowInvocation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FlowInvocation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FlowInvocation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FlowInvocation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FlowInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FlowInvocation> parser()
Returns
TypeDescription
Parser<FlowInvocation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public FlowInvocation getDefaultInstanceForType()
Returns
TypeDescription
FlowInvocation

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.

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.

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

getParserForType()

public Parser<FlowInvocation> getParserForType()
Returns
TypeDescription
Parser<FlowInvocation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FlowInvocation.Builder newBuilderForType()
Returns
TypeDescription
FlowInvocation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FlowInvocation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FlowInvocation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FlowInvocation.Builder toBuilder()
Returns
TypeDescription
FlowInvocation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException