Class Fulfillment (4.18.0) 

public final class Fulfillment extends GeneratedMessageV3 implements FulfillmentOrBuilder

By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the fulfillment guide.

Protobuf type google.cloud.dialogflow.v2.Fulfillment

Inheritance

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

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER
Field Value
Type Description
int

GENERIC_WEB_SERVICE_FIELD_NUMBER

public static final int GENERIC_WEB_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Fulfillment getDefaultInstance()
Returns
Type Description
Fulfillment

getDescriptor()

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

newBuilder()

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

newBuilder(Fulfillment prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Fulfillment getDefaultInstanceForType()
Returns
Type Description
Fulfillment

getDisplayName()

public String getDisplayName()

Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEnabled()

public boolean getEnabled()

Optional. Whether fulfillment is enabled.

bool enabled = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enabled.

getFeatures(int index)

public Fulfillment.Feature getFeatures(int index)

Optional. The field defines whether the fulfillment is enabled for certain features.

repeated .google.cloud.dialogflow.v2.Fulfillment.Feature features = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Fulfillment.Feature

getFeaturesCount()

public int getFeaturesCount()

Optional. The field defines whether the fulfillment is enabled for certain features.

repeated .google.cloud.dialogflow.v2.Fulfillment.Feature features = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getFeaturesList()

public List<Fulfillment.Feature> getFeaturesList()

Optional. The field defines whether the fulfillment is enabled for certain features.

repeated .google.cloud.dialogflow.v2.Fulfillment.Feature features = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Feature>

getFeaturesOrBuilder(int index)

public Fulfillment.FeatureOrBuilder getFeaturesOrBuilder(int index)

Optional. The field defines whether the fulfillment is enabled for certain features.

repeated .google.cloud.dialogflow.v2.Fulfillment.Feature features = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Fulfillment.FeatureOrBuilder

getFeaturesOrBuilderList()

public List<? extends Fulfillment.FeatureOrBuilder> getFeaturesOrBuilderList()

Optional. The field defines whether the fulfillment is enabled for certain features.

repeated .google.cloud.dialogflow.v2.Fulfillment.Feature features = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.Fulfillment.FeatureOrBuilder>

getFulfillmentCase()

public Fulfillment.FulfillmentCase getFulfillmentCase()
Returns
Type Description
Fulfillment.FulfillmentCase

getGenericWebService()

public Fulfillment.GenericWebService getGenericWebService()

Configuration for a generic web service.

.google.cloud.dialogflow.v2.Fulfillment.GenericWebService generic_web_service = 3;

Returns
Type Description
Fulfillment.GenericWebService

The genericWebService.

getGenericWebServiceOrBuilder()

public Fulfillment.GenericWebServiceOrBuilder getGenericWebServiceOrBuilder()

Configuration for a generic web service.

.google.cloud.dialogflow.v2.Fulfillment.GenericWebService generic_web_service = 3;

Returns
Type Description
Fulfillment.GenericWebServiceOrBuilder

getName()

public String getName()

Required. The unique identifier of the fulfillment. Supported formats:

  • projects/<Project ID>/agent/fulfillment
  • projects/<Project ID>/locations/<Location ID>/agent/fulfillment This field is not used for Fulfillment in an Environment.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The unique identifier of the fulfillment. Supported formats:

  • projects/<Project ID>/agent/fulfillment
  • projects/<Project ID>/locations/<Location ID>/agent/fulfillment This field is not used for Fulfillment in an Environment.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasGenericWebService()

public boolean hasGenericWebService()

Configuration for a generic web service.

.google.cloud.dialogflow.v2.Fulfillment.GenericWebService generic_web_service = 3;

Returns
Type Description
boolean

Whether the genericWebService 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 Fulfillment.Builder newBuilderForType()
Returns
Type Description
Fulfillment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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