Class Template.TemplateMetadata (0.1.0)

public static final class Template.TemplateMetadata extends GeneratedMessageV3 implements Template.TemplateMetadataOrBuilder

Message describing TemplateMetadata

Protobuf type google.cloud.modelarmor.v1.Template.TemplateMetadata

Static Fields

CUSTOM_LLM_RESPONSE_SAFETY_ERROR_CODE_FIELD_NUMBER

public static final int CUSTOM_LLM_RESPONSE_SAFETY_ERROR_CODE_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_LLM_RESPONSE_SAFETY_ERROR_MESSAGE_FIELD_NUMBER

public static final int CUSTOM_LLM_RESPONSE_SAFETY_ERROR_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_PROMPT_SAFETY_ERROR_CODE_FIELD_NUMBER

public static final int CUSTOM_PROMPT_SAFETY_ERROR_CODE_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_PROMPT_SAFETY_ERROR_MESSAGE_FIELD_NUMBER

public static final int CUSTOM_PROMPT_SAFETY_ERROR_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

IGNORE_PARTIAL_INVOCATION_FAILURES_FIELD_NUMBER

public static final int IGNORE_PARTIAL_INVOCATION_FAILURES_FIELD_NUMBER
Field Value
Type Description
int

LOG_SANITIZE_OPERATIONS_FIELD_NUMBER

public static final int LOG_SANITIZE_OPERATIONS_FIELD_NUMBER
Field Value
Type Description
int

LOG_TEMPLATE_OPERATIONS_FIELD_NUMBER

public static final int LOG_TEMPLATE_OPERATIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Template.TemplateMetadata getDefaultInstance()
Returns
Type Description
Template.TemplateMetadata

getDescriptor()

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

newBuilder()

public static Template.TemplateMetadata.Builder newBuilder()
Returns
Type Description
Template.TemplateMetadata.Builder

newBuilder(Template.TemplateMetadata prototype)

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

parseDelimitedFrom(InputStream input)

public static Template.TemplateMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Template.TemplateMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Template.TemplateMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Template.TemplateMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Template.TemplateMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Template.TemplateMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Template.TemplateMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Template.TemplateMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Template.TemplateMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Template.TemplateMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Template.TemplateMetadata> parser()
Returns
Type Description
Parser<TemplateMetadata>

Methods

equals(Object obj)

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

getCustomLlmResponseSafetyErrorCode()

public int getCustomLlmResponseSafetyErrorCode()

Optional. Indicates the custom error code set by the user to be returned to the end user if the LLM response trips Model Armor filters.

int32 custom_llm_response_safety_error_code = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The customLlmResponseSafetyErrorCode.

getCustomLlmResponseSafetyErrorMessage()

public String getCustomLlmResponseSafetyErrorMessage()

Optional. Indicates the custom error message set by the user to be returned to the end user if the LLM response trips Model Armor filters.

string custom_llm_response_safety_error_message = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The customLlmResponseSafetyErrorMessage.

getCustomLlmResponseSafetyErrorMessageBytes()

public ByteString getCustomLlmResponseSafetyErrorMessageBytes()

Optional. Indicates the custom error message set by the user to be returned to the end user if the LLM response trips Model Armor filters.

string custom_llm_response_safety_error_message = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for customLlmResponseSafetyErrorMessage.

getCustomPromptSafetyErrorCode()

public int getCustomPromptSafetyErrorCode()

Optional. Indicates the custom error code set by the user to be returned to the end user by the service extension if the prompt trips Model Armor filters.

int32 custom_prompt_safety_error_code = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The customPromptSafetyErrorCode.

getCustomPromptSafetyErrorMessage()

public String getCustomPromptSafetyErrorMessage()

Optional. Indicates the custom error message set by the user to be returned to the end user if the prompt trips Model Armor filters.

string custom_prompt_safety_error_message = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The customPromptSafetyErrorMessage.

getCustomPromptSafetyErrorMessageBytes()

public ByteString getCustomPromptSafetyErrorMessageBytes()

Optional. Indicates the custom error message set by the user to be returned to the end user if the prompt trips Model Armor filters.

string custom_prompt_safety_error_message = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for customPromptSafetyErrorMessage.

getDefaultInstanceForType()

public Template.TemplateMetadata getDefaultInstanceForType()
Returns
Type Description
Template.TemplateMetadata

getIgnorePartialInvocationFailures()

public boolean getIgnorePartialInvocationFailures()

Optional. If true, partial detector failures should be ignored.

bool ignore_partial_invocation_failures = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The ignorePartialInvocationFailures.

getLogSanitizeOperations()

public boolean getLogSanitizeOperations()

Optional. If true, log sanitize operations.

bool log_sanitize_operations = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The logSanitizeOperations.

getLogTemplateOperations()

public boolean getLogTemplateOperations()

Optional. If true, log template crud operations.

bool log_template_operations = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The logTemplateOperations.

getParserForType()

public Parser<Template.TemplateMetadata> getParserForType()
Returns
Type Description
Parser<TemplateMetadata>
Overrides

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 Template.TemplateMetadata.Builder newBuilderForType()
Returns
Type Description
Template.TemplateMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Template.TemplateMetadata.Builder toBuilder()
Returns
Type Description
Template.TemplateMetadata.Builder

writeTo(CodedOutputStream output)

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