com.google.cloud.dialogflow.cx.v3

Interface Form.ParameterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Form.Parameter, Form.Parameter.Builder

Enclosing class:

Form

public static interface Form.ParameterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AdvancedSettings	getAdvancedSettings() Hierarchical advanced settings for this parameter.
AdvancedSettingsOrBuilder	getAdvancedSettingsOrBuilder() Hierarchical advanced settings for this parameter.
com.google.protobuf.Value	getDefaultValue() The default value of an optional parameter.
com.google.protobuf.ValueOrBuilder	getDefaultValueOrBuilder() The default value of an optional parameter.
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.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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getDisplayName

String getDisplayName()

 Required. The human-readable name of the parameter, unique within the
 form.
 

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

Returns:

The displayName.

getDisplayNameBytes

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

Returns:

The bytes for displayName.

getRequired

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;

Returns:

The required.

getEntityType

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) = { ... }

Returns:

The entityType.

getEntityTypeBytes

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) = { ... }

Returns:

The bytes for entityType.

getIsList

boolean getIsList()

 Indicates whether the parameter represents a list of values.
 

bool is_list = 4;

Returns:

The isList.

hasFillBehavior

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

Returns:

Whether the fillBehavior field is set.

getFillBehavior

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

Returns:

The fillBehavior.

getFillBehaviorOrBuilder

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

hasDefaultValue

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;

Returns:

Whether the defaultValue field is set.

getDefaultValue

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;

Returns:

The defaultValue.

getDefaultValueOrBuilder

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;

getRedact

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;

Returns:

The redact.

hasAdvancedSettings

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;

Returns:

Whether the advancedSettings field is set.

getAdvancedSettings

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;

Returns:

The advancedSettings.

getAdvancedSettingsOrBuilder

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;