Class Fulfillment.Builder (4.35.0)

public static final class Fulfillment.Builder extends GeneratedMessageV3.Builder<Fulfillment.Builder> 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

Static Methods

getDescriptor()

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

Methods

addAllFeatures(Iterable<? extends Fulfillment.Feature> values)

public Fulfillment.Builder addAllFeatures(Iterable<? extends Fulfillment.Feature> values)

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
values Iterable<? extends com.google.cloud.dialogflow.v2.Fulfillment.Feature>
Returns
Type Description
Fulfillment.Builder

addFeatures(Fulfillment.Feature value)

public Fulfillment.Builder addFeatures(Fulfillment.Feature value)

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
value Fulfillment.Feature
Returns
Type Description
Fulfillment.Builder

addFeatures(Fulfillment.Feature.Builder builderForValue)

public Fulfillment.Builder addFeatures(Fulfillment.Feature.Builder builderForValue)

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
builderForValue Fulfillment.Feature.Builder
Returns
Type Description
Fulfillment.Builder

addFeatures(int index, Fulfillment.Feature value)

public Fulfillment.Builder addFeatures(int index, Fulfillment.Feature value)

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];

Parameters
Name Description
index int
value Fulfillment.Feature
Returns
Type Description
Fulfillment.Builder

addFeatures(int index, Fulfillment.Feature.Builder builderForValue)

public Fulfillment.Builder addFeatures(int index, Fulfillment.Feature.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Fulfillment.Feature.Builder
Returns
Type Description
Fulfillment.Builder

addFeaturesBuilder()

public Fulfillment.Feature.Builder addFeaturesBuilder()

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
Fulfillment.Feature.Builder

addFeaturesBuilder(int index)

public Fulfillment.Feature.Builder addFeaturesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Fulfillment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Fulfillment.Builder
Overrides

build()

public Fulfillment build()
Returns
Type Description
Fulfillment

buildPartial()

public Fulfillment buildPartial()
Returns
Type Description
Fulfillment

clear()

public Fulfillment.Builder clear()
Returns
Type Description
Fulfillment.Builder
Overrides

clearDisplayName()

public Fulfillment.Builder clearDisplayName()

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
Fulfillment.Builder

This builder for chaining.

clearEnabled()

public Fulfillment.Builder clearEnabled()

Optional. Whether fulfillment is enabled.

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

Returns
Type Description
Fulfillment.Builder

This builder for chaining.

clearFeatures()

public Fulfillment.Builder clearFeatures()

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
Fulfillment.Builder

clearField(Descriptors.FieldDescriptor field)

public Fulfillment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Fulfillment.Builder
Overrides

clearFulfillment()

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

clearGenericWebService()

public Fulfillment.Builder clearGenericWebService()

Configuration for a generic web service.

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

Returns
Type Description
Fulfillment.Builder

clearName()

public Fulfillment.Builder clearName()

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
Fulfillment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Fulfillment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Fulfillment.Builder
Overrides

clone()

public Fulfillment.Builder clone()
Returns
Type Description
Fulfillment.Builder
Overrides

getDefaultInstanceForType()

public Fulfillment getDefaultInstanceForType()
Returns
Type Description
Fulfillment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getFeaturesBuilder(int index)

public Fulfillment.Feature.Builder getFeaturesBuilder(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.Builder

getFeaturesBuilderList()

public List<Fulfillment.Feature.Builder> getFeaturesBuilderList()

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<Builder>

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.

getGenericWebServiceBuilder()

public Fulfillment.GenericWebService.Builder getGenericWebServiceBuilder()

Configuration for a generic web service.

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

Returns
Type Description
Fulfillment.GenericWebService.Builder

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Fulfillment other)

public Fulfillment.Builder mergeFrom(Fulfillment other)
Parameter
Name Description
other Fulfillment
Returns
Type Description
Fulfillment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Fulfillment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Fulfillment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Fulfillment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Fulfillment.Builder
Overrides

mergeGenericWebService(Fulfillment.GenericWebService value)

public Fulfillment.Builder mergeGenericWebService(Fulfillment.GenericWebService value)

Configuration for a generic web service.

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

Parameter
Name Description
value Fulfillment.GenericWebService
Returns
Type Description
Fulfillment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Fulfillment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Fulfillment.Builder
Overrides

removeFeatures(int index)

public Fulfillment.Builder removeFeatures(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.Builder

setDisplayName(String value)

public Fulfillment.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Fulfillment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Fulfillment.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Fulfillment.Builder

This builder for chaining.

setEnabled(boolean value)

public Fulfillment.Builder setEnabled(boolean value)

Optional. Whether fulfillment is enabled.

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

Parameter
Name Description
value boolean

The enabled to set.

Returns
Type Description
Fulfillment.Builder

This builder for chaining.

setFeatures(int index, Fulfillment.Feature value)

public Fulfillment.Builder setFeatures(int index, Fulfillment.Feature value)

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];

Parameters
Name Description
index int
value Fulfillment.Feature
Returns
Type Description
Fulfillment.Builder

setFeatures(int index, Fulfillment.Feature.Builder builderForValue)

public Fulfillment.Builder setFeatures(int index, Fulfillment.Feature.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Fulfillment.Feature.Builder
Returns
Type Description
Fulfillment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Fulfillment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Fulfillment.Builder
Overrides

setGenericWebService(Fulfillment.GenericWebService value)

public Fulfillment.Builder setGenericWebService(Fulfillment.GenericWebService value)

Configuration for a generic web service.

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

Parameter
Name Description
value Fulfillment.GenericWebService
Returns
Type Description
Fulfillment.Builder

setGenericWebService(Fulfillment.GenericWebService.Builder builderForValue)

public Fulfillment.Builder setGenericWebService(Fulfillment.GenericWebService.Builder builderForValue)

Configuration for a generic web service.

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

Parameter
Name Description
builderForValue Fulfillment.GenericWebService.Builder
Returns
Type Description
Fulfillment.Builder

setName(String value)

public Fulfillment.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Fulfillment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Fulfillment.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Fulfillment.Builder

This builder for chaining.

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

public Fulfillment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Fulfillment.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Fulfillment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Fulfillment.Builder
Overrides