Class Form.Parameter.Builder (0.11.5)

public static final class Form.Parameter.Builder extends GeneratedMessageV3.Builder<Form.Parameter.Builder> implements Form.ParameterOrBuilder

Represents a form parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Form.Parameter

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Form.Parameter build()
Returns
Type Description
Form.Parameter

buildPartial()

public Form.Parameter buildPartial()
Returns
Type Description
Form.Parameter

clear()

public Form.Parameter.Builder clear()
Returns
Type Description
Form.Parameter.Builder
Overrides

clearDefaultValue()

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;

Returns
Type Description
Form.Parameter.Builder

clearDisplayName()

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

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

clearEntityType()

public Form.Parameter.Builder clearEntityType()

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFillBehavior()

public Form.Parameter.Builder clearFillBehavior()

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Form.Parameter.Builder

clearIsList()

public Form.Parameter.Builder clearIsList()

Indicates whether the parameter represents a list of values.

bool is_list = 4;

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRedact()

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 is enabled.

bool redact = 11;

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

clearRequired()

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;

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

clone()

public Form.Parameter.Builder clone()
Returns
Type Description
Form.Parameter.Builder
Overrides

getDefaultInstanceForType()

public Form.Parameter getDefaultInstanceForType()
Returns
Type Description
Form.Parameter

getDefaultValue()

public 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
Type Description
Value

The defaultValue.

getDefaultValueBuilder()

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

Returns
Type Description
Builder

getDefaultValueOrBuilder()

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

Returns
Type Description
ValueOrBuilder

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

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

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for displayName.

getEntityType()

public String getEntityType()

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The entityType.

getEntityTypeBytes()

public ByteString getEntityTypeBytes()

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for entityType.

getFillBehavior()

public Form.Parameter.FillBehavior getFillBehavior()

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Form.Parameter.FillBehavior

The fillBehavior.

getFillBehaviorBuilder()

public Form.Parameter.FillBehavior.Builder getFillBehaviorBuilder()

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Form.Parameter.FillBehavior.Builder

getFillBehaviorOrBuilder()

public Form.Parameter.FillBehaviorOrBuilder getFillBehaviorOrBuilder()

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Form.Parameter.FillBehaviorOrBuilder

getIsList()

public boolean getIsList()

Indicates whether the parameter represents a list of values.

bool is_list = 4;

Returns
Type Description
boolean

The isList.

getRedact()

public 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 is enabled.

bool redact = 11;

Returns
Type Description
boolean

The redact.

getRequired()

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;

Returns
Type Description
boolean

The required.

hasDefaultValue()

public 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
Type Description
boolean

Whether the defaultValue field is set.

hasFillBehavior()

public boolean hasFillBehavior()

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the fillBehavior field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDefaultValue(Value value)

public Form.Parameter.Builder mergeDefaultValue(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;

Parameter
Name Description
value Value
Returns
Type Description
Form.Parameter.Builder

mergeFillBehavior(Form.Parameter.FillBehavior value)

public Form.Parameter.Builder mergeFillBehavior(Form.Parameter.FillBehavior value)

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Form.Parameter.FillBehavior
Returns
Type Description
Form.Parameter.Builder

mergeFrom(Form.Parameter other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDefaultValue(Value value)

public Form.Parameter.Builder setDefaultValue(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;

Parameter
Name Description
value Value
Returns
Type Description
Form.Parameter.Builder

setDefaultValue(Value.Builder builderForValue)

public Form.Parameter.Builder setDefaultValue(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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Form.Parameter.Builder

setDisplayName(String value)

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Form.Parameter.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

setEntityType(String value)

public Form.Parameter.Builder setEntityType(String value)

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The entityType to set.

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

setEntityTypeBytes(ByteString value)

public Form.Parameter.Builder setEntityTypeBytes(ByteString value)

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for entityType to set.

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFillBehavior(Form.Parameter.FillBehavior value)

public Form.Parameter.Builder setFillBehavior(Form.Parameter.FillBehavior value)

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Form.Parameter.FillBehavior
Returns
Type Description
Form.Parameter.Builder

setFillBehavior(Form.Parameter.FillBehavior.Builder builderForValue)

public Form.Parameter.Builder setFillBehavior(Form.Parameter.FillBehavior.Builder builderForValue)

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Form.Parameter.FillBehavior.Builder
Returns
Type Description
Form.Parameter.Builder

setIsList(boolean value)

public Form.Parameter.Builder setIsList(boolean value)

Indicates whether the parameter represents a list of values.

bool is_list = 4;

Parameter
Name Description
value boolean

The isList to set.

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

setRedact(boolean value)

public 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 is enabled.

bool redact = 11;

Parameter
Name Description
value boolean

The redact to set.

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

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

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

setRequired(boolean value)

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

Parameter
Name Description
value boolean

The required to set.

Returns
Type Description
Form.Parameter.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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