Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class AnswerQueryRequest.SafetySpec.Builder (0.72.0)

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

Safety specification. There are two use cases:

when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories.
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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AnswerQueryRequest.SafetySpec.Builder

Implements

AnswerQueryRequest.SafetySpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public AnswerQueryRequest.SafetySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`AnswerQueryRequest.SafetySpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public AnswerQueryRequest.SafetySpec getDefaultInstanceForType()

Returns
Type	Description
`AnswerQueryRequest.SafetySpec`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnswerQueryRequest.SafetySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`AnswerQueryRequest.SafetySpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)