com.google.cloud.discoveryengine.v1

Class AnswerQueryRequest.SafetySpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec

All Implemented Interfaces:

AnswerQueryRequest.SafetySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

AnswerQueryRequest

public static final class AnswerQueryRequest.SafetySpec
extends com.google.protobuf.GeneratedMessage
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnswerQueryRequest.SafetySpec.Builder Safety specification.
static class	AnswerQueryRequest.SafetySpec.SafetySetting Safety settings.
static interface	AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENABLE_FIELD_NUMBER
static int	SAFETY_SETTINGS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static AnswerQueryRequest.SafetySpec	getDefaultInstance()
AnswerQueryRequest.SafetySpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEnable() Enable the safety filtering on the answer response.
com.google.protobuf.Parser<AnswerQueryRequest.SafetySpec>	getParserForType()
AnswerQueryRequest.SafetySpec.SafetySetting	getSafetySettings(int index) Optional.
int	getSafetySettingsCount() Optional.
List<AnswerQueryRequest.SafetySpec.SafetySetting>	getSafetySettingsList() Optional.
AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder	getSafetySettingsOrBuilder(int index) Optional.
List<? extends AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder>	getSafetySettingsOrBuilderList() Optional.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AnswerQueryRequest.SafetySpec.Builder	newBuilder()
static AnswerQueryRequest.SafetySpec.Builder	newBuilder(AnswerQueryRequest.SafetySpec prototype)
AnswerQueryRequest.SafetySpec.Builder	newBuilderForType()
protected AnswerQueryRequest.SafetySpec.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static AnswerQueryRequest.SafetySpec	parseDelimitedFrom(InputStream input)
static AnswerQueryRequest.SafetySpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.SafetySpec	parseFrom(byte[] data)
static AnswerQueryRequest.SafetySpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.SafetySpec	parseFrom(ByteBuffer data)
static AnswerQueryRequest.SafetySpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.SafetySpec	parseFrom(com.google.protobuf.ByteString data)
static AnswerQueryRequest.SafetySpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.SafetySpec	parseFrom(com.google.protobuf.CodedInputStream input)
static AnswerQueryRequest.SafetySpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.SafetySpec	parseFrom(InputStream input)
static AnswerQueryRequest.SafetySpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AnswerQueryRequest.SafetySpec>	parser()
AnswerQueryRequest.SafetySpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ENABLE_FIELD_NUMBER

public static final int ENABLE_FIELD_NUMBER

See Also:

Constant Field Values

SAFETY_SETTINGS_FIELD_NUMBER

public static final int SAFETY_SETTINGS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getEnable

public boolean getEnable()

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

bool enable = 1;

Specified by:

getEnable in interface AnswerQueryRequest.SafetySpecOrBuilder

Returns:

The enable.

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

Specified by:

getSafetySettingsList in interface AnswerQueryRequest.SafetySpecOrBuilder

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

Specified by:

getSafetySettingsOrBuilderList in interface AnswerQueryRequest.SafetySpecOrBuilder

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

Specified by:

getSafetySettingsCount in interface AnswerQueryRequest.SafetySpecOrBuilder

getSafetySettings

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

Specified by:

getSafetySettings in interface AnswerQueryRequest.SafetySpecOrBuilder

getSafetySettingsOrBuilder

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

Specified by:

getSafetySettingsOrBuilder in interface AnswerQueryRequest.SafetySpecOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnswerQueryRequest.SafetySpec parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnswerQueryRequest.SafetySpec parseDelimitedFrom(InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest.SafetySpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public AnswerQueryRequest.SafetySpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AnswerQueryRequest.SafetySpec.Builder newBuilder()

newBuilder

public static AnswerQueryRequest.SafetySpec.Builder newBuilder(AnswerQueryRequest.SafetySpec prototype)

toBuilder

public AnswerQueryRequest.SafetySpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AnswerQueryRequest.SafetySpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static AnswerQueryRequest.SafetySpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<AnswerQueryRequest.SafetySpec> parser()

getParserForType

public com.google.protobuf.Parser<AnswerQueryRequest.SafetySpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public AnswerQueryRequest.SafetySpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder