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 Guardrail.LlmPromptSecurity (0.1.0)

public static final class Guardrail.LlmPromptSecurity extends GeneratedMessage implements Guardrail.LlmPromptSecurityOrBuilder

Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.

Protobuf type google.cloud.ces.v1.Guardrail.LlmPromptSecurity

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Guardrail.LlmPromptSecurity

Implements

Guardrail.LlmPromptSecurityOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CUSTOM_POLICY_FIELD_NUMBER

public static final int CUSTOM_POLICY_FIELD_NUMBER

Field Value
Type	Description
`int`

DEFAULT_SETTINGS_FIELD_NUMBER

public static final int DEFAULT_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
`int`

FAIL_OPEN_FIELD_NUMBER

public static final int FAIL_OPEN_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Guardrail.LlmPromptSecurity getDefaultInstance()

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Guardrail.LlmPromptSecurity.Builder newBuilder()

Returns
Type	Description
`Guardrail.LlmPromptSecurity.Builder`

newBuilder(Guardrail.LlmPromptSecurity prototype)

public static Guardrail.LlmPromptSecurity.Builder newBuilder(Guardrail.LlmPromptSecurity prototype)

Parameter
Name	Description
`prototype`	`Guardrail.LlmPromptSecurity`

Returns
Type	Description
`Guardrail.LlmPromptSecurity.Builder`

parseDelimitedFrom(InputStream input)

public static Guardrail.LlmPromptSecurity parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Guardrail.LlmPromptSecurity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Guardrail.LlmPromptSecurity parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Guardrail.LlmPromptSecurity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Guardrail.LlmPromptSecurity parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Guardrail.LlmPromptSecurity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Guardrail.LlmPromptSecurity parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Guardrail.LlmPromptSecurity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Guardrail.LlmPromptSecurity parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Guardrail.LlmPromptSecurity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Guardrail.LlmPromptSecurity parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Guardrail.LlmPromptSecurity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Guardrail.LlmPromptSecurity> parser()

Returns
Type	Description
`Parser<LlmPromptSecurity>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getCustomPolicy()

public Guardrail.LlmPolicy getCustomPolicy()

Optional. Use a user-defined LlmPolicy to configure the security guardrail.

.google.cloud.ces.v1.Guardrail.LlmPolicy custom_policy = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Guardrail.LlmPolicy`	The customPolicy.

getCustomPolicyOrBuilder()

public Guardrail.LlmPolicyOrBuilder getCustomPolicyOrBuilder()

Optional. Use a user-defined LlmPolicy to configure the security guardrail.

.google.cloud.ces.v1.Guardrail.LlmPolicy custom_policy = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Guardrail.LlmPolicyOrBuilder`

getDefaultInstanceForType()

public Guardrail.LlmPromptSecurity getDefaultInstanceForType()

Returns
Type	Description
`Guardrail.LlmPromptSecurity`

getDefaultSettings()

public Guardrail.LlmPromptSecurity.DefaultSecuritySettings getDefaultSettings()

Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response.

.google.cloud.ces.v1.Guardrail.LlmPromptSecurity.DefaultSecuritySettings default_settings = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Guardrail.LlmPromptSecurity.DefaultSecuritySettings`	The defaultSettings.

getDefaultSettingsOrBuilder()

public Guardrail.LlmPromptSecurity.DefaultSecuritySettingsOrBuilder getDefaultSettingsOrBuilder()

.google.cloud.ces.v1.Guardrail.LlmPromptSecurity.DefaultSecuritySettings default_settings = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Guardrail.LlmPromptSecurity.DefaultSecuritySettingsOrBuilder`

getFailOpen()

public boolean getFailOpen()

Optional. Determines the behavior when the guardrail encounters an LLM error.

If true: the guardrail is bypassed.
If false (default): the guardrail triggers/blocks.

Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration.

bool fail_open = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The failOpen.

getParserForType()

public Parser<Guardrail.LlmPromptSecurity> getParserForType()

Returns
Type	Description
`Parser<LlmPromptSecurity>`

Overrides

GeneratedMessage.getParserForType()

getSecurityConfigCase()

public Guardrail.LlmPromptSecurity.SecurityConfigCase getSecurityConfigCase()

Returns
Type	Description
`Guardrail.LlmPromptSecurity.SecurityConfigCase`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

hasCustomPolicy()

public boolean hasCustomPolicy()

Optional. Use a user-defined LlmPolicy to configure the security guardrail.

.google.cloud.ces.v1.Guardrail.LlmPolicy custom_policy = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the customPolicy field is set.

hasDefaultSettings()

public boolean hasDefaultSettings()

.google.cloud.ces.v1.Guardrail.LlmPromptSecurity.DefaultSecuritySettings default_settings = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the defaultSettings field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Guardrail.LlmPromptSecurity.Builder newBuilderForType()

Returns
Type	Description
`Guardrail.LlmPromptSecurity.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Guardrail.LlmPromptSecurity.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Guardrail.LlmPromptSecurity.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Guardrail.LlmPromptSecurity.Builder toBuilder()

Returns
Type	Description
`Guardrail.LlmPromptSecurity.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`