Class AnswerQueryRequest.SafetySpec.Builder (0.58.0)

public static final class AnswerQueryRequest.SafetySpec.Builder extends GeneratedMessageV3.Builder<AnswerQueryRequest.SafetySpec.Builder> implements AnswerQueryRequest.SafetySpecOrBuilder

Safety specification. There are two use cases:

  1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories.
  2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.

Protobuf type google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec

Static Methods

getDescriptor()

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

Methods

addAllSafetySettings(Iterable<? extends AnswerQueryRequest.SafetySpec.SafetySetting> values)

public AnswerQueryRequest.SafetySpec.Builder addAllSafetySettings(Iterable<? extends AnswerQueryRequest.SafetySpec.SafetySetting> values)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting>
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addSafetySettings(AnswerQueryRequest.SafetySpec.SafetySetting value)

public AnswerQueryRequest.SafetySpec.Builder addSafetySettings(AnswerQueryRequest.SafetySpec.SafetySetting value)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AnswerQueryRequest.SafetySpec.SafetySetting
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

addSafetySettings(AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)

public AnswerQueryRequest.SafetySpec.Builder addSafetySettings(AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AnswerQueryRequest.SafetySpec.SafetySetting.Builder
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

addSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting value)

public AnswerQueryRequest.SafetySpec.Builder addSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting value)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AnswerQueryRequest.SafetySpec.SafetySetting
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

addSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)

public AnswerQueryRequest.SafetySpec.Builder addSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AnswerQueryRequest.SafetySpec.SafetySetting.Builder
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

addSafetySettingsBuilder()

public AnswerQueryRequest.SafetySpec.SafetySetting.Builder addSafetySettingsBuilder()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnswerQueryRequest.SafetySpec.SafetySetting.Builder

addSafetySettingsBuilder(int index)

public AnswerQueryRequest.SafetySpec.SafetySetting.Builder addSafetySettingsBuilder(int index)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SafetySpec.SafetySetting.Builder

build()

public AnswerQueryRequest.SafetySpec build()
Returns
Type Description
AnswerQueryRequest.SafetySpec

buildPartial()

public AnswerQueryRequest.SafetySpec buildPartial()
Returns
Type Description
AnswerQueryRequest.SafetySpec

clear()

public AnswerQueryRequest.SafetySpec.Builder clear()
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder
Overrides

clearEnable()

public AnswerQueryRequest.SafetySpec.Builder clearEnable()

Enable the safety filtering on the answer response. It is false by default.

bool enable = 1;

Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSafetySettings()

public AnswerQueryRequest.SafetySpec.Builder clearSafetySettings()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

clone()

public AnswerQueryRequest.SafetySpec.Builder clone()
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder
Overrides

getDefaultInstanceForType()

public AnswerQueryRequest.SafetySpec getDefaultInstanceForType()
Returns
Type Description
AnswerQueryRequest.SafetySpec

getDescriptorForType()

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

getEnable()

public boolean getEnable()

Enable the safety filtering on the answer response. It is false by default.

bool enable = 1;

Returns
Type Description
boolean

The enable.

getSafetySettings(int index)

public AnswerQueryRequest.SafetySpec.SafetySetting getSafetySettings(int index)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SafetySpec.SafetySetting

getSafetySettingsBuilder(int index)

public AnswerQueryRequest.SafetySpec.SafetySetting.Builder getSafetySettingsBuilder(int index)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SafetySpec.SafetySetting.Builder

getSafetySettingsBuilderList()

public List<AnswerQueryRequest.SafetySpec.SafetySetting.Builder> getSafetySettingsBuilderList()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getSafetySettingsCount()

public int getSafetySettingsCount()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSafetySettingsList()

public List<AnswerQueryRequest.SafetySpec.SafetySetting> getSafetySettingsList()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SafetySetting>

getSafetySettingsOrBuilder(int index)

public AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder

getSafetySettingsOrBuilderList()

public List<? extends AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder> getSafetySettingsOrBuilderList()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AnswerQueryRequest.SafetySpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeSafetySettings(int index)

public AnswerQueryRequest.SafetySpec.Builder removeSafetySettings(int index)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

setEnable(boolean value)

public AnswerQueryRequest.SafetySpec.Builder setEnable(boolean value)

Enable the safety filtering on the answer response. It is false by default.

bool enable = 1;

Parameter
Name Description
value boolean

The enable to set.

Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting value)

public AnswerQueryRequest.SafetySpec.Builder setSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting value)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AnswerQueryRequest.SafetySpec.SafetySetting
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

setSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)

public AnswerQueryRequest.SafetySpec.Builder setSafetySettings(int index, AnswerQueryRequest.SafetySpec.SafetySetting.Builder builderForValue)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AnswerQueryRequest.SafetySpec.SafetySetting.Builder
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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