public static final class Form.Parameter.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder> implements Form.ParameterOrBuilder
Represents a form parameter.Protobuf type
google.cloud.dialogflow.cx.v3.Form.Parameter| Modifier and Type | Method and Description |
|---|---|
Form.Parameter.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Form.Parameter |
build() |
Form.Parameter |
buildPartial() |
Form.Parameter.Builder |
clear() |
Form.Parameter.Builder |
clearAdvancedSettings()
Hierarchical advanced settings for this parameter.
|
Form.Parameter.Builder |
clearDefaultValue()
The default value of an optional parameter.
|
Form.Parameter.Builder |
clearDisplayName()
Required.
|
Form.Parameter.Builder |
clearEntityType()
Required.
|
Form.Parameter.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Form.Parameter.Builder |
clearFillBehavior()
Required.
|
Form.Parameter.Builder |
clearIsList()
Indicates whether the parameter represents a list of values.
|
Form.Parameter.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Form.Parameter.Builder |
clearRedact()
Indicates whether the parameter content should be redacted in log.
|
Form.Parameter.Builder |
clearRequired()
Indicates whether the parameter is required.
|
Form.Parameter.Builder |
clone() |
AdvancedSettings |
getAdvancedSettings()
Hierarchical advanced settings for this parameter.
|
AdvancedSettings.Builder |
getAdvancedSettingsBuilder()
Hierarchical advanced settings for this parameter.
|
AdvancedSettingsOrBuilder |
getAdvancedSettingsOrBuilder()
Hierarchical advanced settings for this parameter.
|
Form.Parameter |
getDefaultInstanceForType() |
com.google.protobuf.Value |
getDefaultValue()
The default value of an optional parameter.
|
com.google.protobuf.Value.Builder |
getDefaultValueBuilder()
The default value of an optional parameter.
|
com.google.protobuf.ValueOrBuilder |
getDefaultValueOrBuilder()
The default value of an optional parameter.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
String |
getEntityType()
Required.
|
com.google.protobuf.ByteString |
getEntityTypeBytes()
Required.
|
Form.Parameter.FillBehavior |
getFillBehavior()
Required.
|
Form.Parameter.FillBehavior.Builder |
getFillBehaviorBuilder()
Required.
|
Form.Parameter.FillBehaviorOrBuilder |
getFillBehaviorOrBuilder()
Required.
|
boolean |
getIsList()
Indicates whether the parameter represents a list of values.
|
boolean |
getRedact()
Indicates whether the parameter content should be redacted in log.
|
boolean |
getRequired()
Indicates whether the parameter is required.
|
boolean |
hasAdvancedSettings()
Hierarchical advanced settings for this parameter.
|
boolean |
hasDefaultValue()
The default value of an optional parameter.
|
boolean |
hasFillBehavior()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Form.Parameter.Builder |
mergeAdvancedSettings(AdvancedSettings value)
Hierarchical advanced settings for this parameter.
|
Form.Parameter.Builder |
mergeDefaultValue(com.google.protobuf.Value value)
The default value of an optional parameter.
|
Form.Parameter.Builder |
mergeFillBehavior(Form.Parameter.FillBehavior value)
Required.
|
Form.Parameter.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Form.Parameter.Builder |
mergeFrom(Form.Parameter other) |
Form.Parameter.Builder |
mergeFrom(com.google.protobuf.Message other) |
Form.Parameter.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Form.Parameter.Builder |
setAdvancedSettings(AdvancedSettings.Builder builderForValue)
Hierarchical advanced settings for this parameter.
|
Form.Parameter.Builder |
setAdvancedSettings(AdvancedSettings value)
Hierarchical advanced settings for this parameter.
|
Form.Parameter.Builder |
setDefaultValue(com.google.protobuf.Value.Builder builderForValue)
The default value of an optional parameter.
|
Form.Parameter.Builder |
setDefaultValue(com.google.protobuf.Value value)
The default value of an optional parameter.
|
Form.Parameter.Builder |
setDisplayName(String value)
Required.
|
Form.Parameter.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
Required.
|
Form.Parameter.Builder |
setEntityType(String value)
Required.
|
Form.Parameter.Builder |
setEntityTypeBytes(com.google.protobuf.ByteString value)
Required.
|
Form.Parameter.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Form.Parameter.Builder |
setFillBehavior(Form.Parameter.FillBehavior.Builder builderForValue)
Required.
|
Form.Parameter.Builder |
setFillBehavior(Form.Parameter.FillBehavior value)
Required.
|
Form.Parameter.Builder |
setIsList(boolean value)
Indicates whether the parameter represents a list of values.
|
Form.Parameter.Builder |
setRedact(boolean value)
Indicates whether the parameter content should be redacted in log.
|
Form.Parameter.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Form.Parameter.Builder |
setRequired(boolean value)
Indicates whether the parameter is required.
|
Form.Parameter.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Form.Parameter build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Form.Parameter buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Form.Parameter.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Form.Parameter.Builder>public Form.Parameter.Builder mergeFrom(Form.Parameter other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public Form.Parameter.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Form.Parameter.Builder>IOExceptionpublic String getDisplayName()
Required. The human-readable name of the parameter, unique within the form.
string display_name = 1 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface Form.ParameterOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The human-readable name of the parameter, unique within the form.
string display_name = 1 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface Form.ParameterOrBuilderpublic Form.Parameter.Builder setDisplayName(String value)
Required. The human-readable name of the parameter, unique within the form.
string display_name = 1 [(.google.api.field_behavior) = REQUIRED];value - The displayName to set.public Form.Parameter.Builder clearDisplayName()
Required. The human-readable name of the parameter, unique within the form.
string display_name = 1 [(.google.api.field_behavior) = REQUIRED];public Form.Parameter.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
Required. The human-readable name of the parameter, unique within the form.
string display_name = 1 [(.google.api.field_behavior) = REQUIRED];value - The bytes for displayName to set.public boolean getRequired()
Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
bool required = 2;getRequired in interface Form.ParameterOrBuilderpublic Form.Parameter.Builder setRequired(boolean value)
Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
bool required = 2;value - The required to set.public Form.Parameter.Builder clearRequired()
Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
bool required = 2;public String getEntityType()
Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>` for developer entity types.
string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getEntityType in interface Form.ParameterOrBuilderpublic com.google.protobuf.ByteString getEntityTypeBytes()
Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>` for developer entity types.
string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getEntityTypeBytes in interface Form.ParameterOrBuilderpublic Form.Parameter.Builder setEntityType(String value)
Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>` for developer entity types.
string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The entityType to set.public Form.Parameter.Builder clearEntityType()
Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>` for developer entity types.
string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
public Form.Parameter.Builder setEntityTypeBytes(com.google.protobuf.ByteString value)
Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID>` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>` for developer entity types.
string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The bytes for entityType to set.public boolean getIsList()
Indicates whether the parameter represents a list of values.
bool is_list = 4;getIsList in interface Form.ParameterOrBuilderpublic Form.Parameter.Builder setIsList(boolean value)
Indicates whether the parameter represents a list of values.
bool is_list = 4;value - The isList to set.public Form.Parameter.Builder clearIsList()
Indicates whether the parameter represents a list of values.
bool is_list = 4;public boolean hasFillBehavior()
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
hasFillBehavior in interface Form.ParameterOrBuilderpublic Form.Parameter.FillBehavior getFillBehavior()
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
getFillBehavior in interface Form.ParameterOrBuilderpublic Form.Parameter.Builder setFillBehavior(Form.Parameter.FillBehavior value)
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
public Form.Parameter.Builder setFillBehavior(Form.Parameter.FillBehavior.Builder builderForValue)
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
public Form.Parameter.Builder mergeFillBehavior(Form.Parameter.FillBehavior value)
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
public Form.Parameter.Builder clearFillBehavior()
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
public Form.Parameter.FillBehavior.Builder getFillBehaviorBuilder()
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
public Form.Parameter.FillBehaviorOrBuilder getFillBehaviorOrBuilder()
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
getFillBehaviorOrBuilder in interface Form.ParameterOrBuilderpublic boolean hasDefaultValue()
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
.google.protobuf.Value default_value = 9;hasDefaultValue in interface Form.ParameterOrBuilderpublic com.google.protobuf.Value getDefaultValue()
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
.google.protobuf.Value default_value = 9;getDefaultValue in interface Form.ParameterOrBuilderpublic Form.Parameter.Builder setDefaultValue(com.google.protobuf.Value value)
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
.google.protobuf.Value default_value = 9;public Form.Parameter.Builder setDefaultValue(com.google.protobuf.Value.Builder builderForValue)
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
.google.protobuf.Value default_value = 9;public Form.Parameter.Builder mergeDefaultValue(com.google.protobuf.Value value)
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
.google.protobuf.Value default_value = 9;public Form.Parameter.Builder clearDefaultValue()
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
.google.protobuf.Value default_value = 9;public com.google.protobuf.Value.Builder getDefaultValueBuilder()
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
.google.protobuf.Value default_value = 9;public com.google.protobuf.ValueOrBuilder getDefaultValueOrBuilder()
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
.google.protobuf.Value default_value = 9;getDefaultValueOrBuilder in interface Form.ParameterOrBuilderpublic boolean getRedact()
Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or [entity type level redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
bool redact = 11;getRedact in interface Form.ParameterOrBuilderpublic Form.Parameter.Builder setRedact(boolean value)
Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or [entity type level redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
bool redact = 11;value - The redact to set.public Form.Parameter.Builder clearRedact()
Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or [entity type level redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
bool redact = 11;public boolean hasAdvancedSettings()
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 12;hasAdvancedSettings in interface Form.ParameterOrBuilderpublic AdvancedSettings getAdvancedSettings()
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 12;getAdvancedSettings in interface Form.ParameterOrBuilderpublic Form.Parameter.Builder setAdvancedSettings(AdvancedSettings value)
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 12;public Form.Parameter.Builder setAdvancedSettings(AdvancedSettings.Builder builderForValue)
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 12;public Form.Parameter.Builder mergeAdvancedSettings(AdvancedSettings value)
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 12;public Form.Parameter.Builder clearAdvancedSettings()
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 12;public AdvancedSettings.Builder getAdvancedSettingsBuilder()
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 12;public AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 12;getAdvancedSettingsOrBuilder in interface Form.ParameterOrBuilderpublic final Form.Parameter.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>public final Form.Parameter.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>Copyright © 2025 Google LLC. All rights reserved.