Class ModelArmorConfig (3.73.0)

public final class ModelArmorConfig extends GeneratedMessageV3 implements ModelArmorConfigOrBuilder

Configuration for Model Armor integrations of prompt and responses.

Protobuf type google.cloud.aiplatform.v1.ModelArmorConfig

Static Fields

PROMPT_TEMPLATE_NAME_FIELD_NUMBER

public static final int PROMPT_TEMPLATE_NAME_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_TEMPLATE_NAME_FIELD_NUMBER

public static final int RESPONSE_TEMPLATE_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelArmorConfig getDefaultInstance()
Returns
Type Description
ModelArmorConfig

getDescriptor()

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

newBuilder()

public static ModelArmorConfig.Builder newBuilder()
Returns
Type Description
ModelArmorConfig.Builder

newBuilder(ModelArmorConfig prototype)

public static ModelArmorConfig.Builder newBuilder(ModelArmorConfig prototype)
Parameter
Name Description
prototype ModelArmorConfig
Returns
Type Description
ModelArmorConfig.Builder

parseDelimitedFrom(InputStream input)

public static ModelArmorConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelArmorConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ModelArmorConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ModelArmorConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ModelArmorConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ModelArmorConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ModelArmorConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelArmorConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ModelArmorConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelArmorConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ModelArmorConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ModelArmorConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelArmorConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ModelArmorConfig> parser()
Returns
Type Description
Parser<ModelArmorConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ModelArmorConfig getDefaultInstanceForType()
Returns
Type Description
ModelArmorConfig

getParserForType()

public Parser<ModelArmorConfig> getParserForType()
Returns
Type Description
Parser<ModelArmorConfig>
Overrides

getPromptTemplateName()

public String getPromptTemplateName()

Optional. The name of the Model Armor template to use for prompt sanitization.

string prompt_template_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The promptTemplateName.

getPromptTemplateNameBytes()

public ByteString getPromptTemplateNameBytes()

Optional. The name of the Model Armor template to use for prompt sanitization.

string prompt_template_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for promptTemplateName.

getResponseTemplateName()

public String getResponseTemplateName()

Optional. The name of the Model Armor template to use for response sanitization.

string response_template_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The responseTemplateName.

getResponseTemplateNameBytes()

public ByteString getResponseTemplateNameBytes()

Optional. The name of the Model Armor template to use for response sanitization.

string response_template_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for responseTemplateName.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ModelArmorConfig.Builder newBuilderForType()
Returns
Type Description
ModelArmorConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ModelArmorConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ModelArmorConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ModelArmorConfig.Builder toBuilder()
Returns
Type Description
ModelArmorConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException