Class Template.TemplateMetadata.Builder (0.36.0)

public static final class Template.TemplateMetadata.Builder extends GeneratedMessage.Builder<Template.TemplateMetadata.Builder> implements Template.TemplateMetadataOrBuilder

Message describing TemplateMetadata

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

Static Methods

getDescriptor()

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

Methods

addAllModalities(Iterable<? extends Modality> values)

public Template.TemplateMetadata.Builder addAllModalities(Iterable<? extends Modality> values)

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.modelarmor.v1.Modality>

The modalities to add.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

addAllModalitiesValue(Iterable<Integer> values)

public Template.TemplateMetadata.Builder addAllModalitiesValue(Iterable<Integer> values)

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for modalities to add.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

addModalities(Modality value)

public Template.TemplateMetadata.Builder addModalities(Modality value)

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Modality

The modalities to add.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

addModalitiesValue(int value)

public Template.TemplateMetadata.Builder addModalitiesValue(int value)

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for modalities to add.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

build()

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

buildPartial()

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

clear()

public Template.TemplateMetadata.Builder clear()
Returns
Type Description
Template.TemplateMetadata.Builder
Overrides

clearCustomLlmResponseSafetyErrorCode()

public Template.TemplateMetadata.Builder clearCustomLlmResponseSafetyErrorCode()

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
Template.TemplateMetadata.Builder

This builder for chaining.

clearCustomLlmResponseSafetyErrorMessage()

public Template.TemplateMetadata.Builder clearCustomLlmResponseSafetyErrorMessage()

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
Template.TemplateMetadata.Builder

This builder for chaining.

clearCustomPromptSafetyErrorCode()

public Template.TemplateMetadata.Builder clearCustomPromptSafetyErrorCode()

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
Template.TemplateMetadata.Builder

This builder for chaining.

clearCustomPromptSafetyErrorMessage()

public Template.TemplateMetadata.Builder clearCustomPromptSafetyErrorMessage()

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
Template.TemplateMetadata.Builder

This builder for chaining.

clearEnforcementType()

public Template.TemplateMetadata.Builder clearEnforcementType()

Optional. Enforcement type for Model Armor filters.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.EnforcementType enforcement_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

clearIgnorePartialInvocationFailures()

public Template.TemplateMetadata.Builder clearIgnorePartialInvocationFailures()

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

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

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

clearLogSanitizeOperations()

public Template.TemplateMetadata.Builder clearLogSanitizeOperations()

Optional. If true, log sanitize operations.

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

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

clearLogTemplateOperations()

public Template.TemplateMetadata.Builder clearLogTemplateOperations()

Optional. If true, log template crud operations.

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

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

clearModalities()

public Template.TemplateMetadata.Builder clearModalities()

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

clearMultiLanguageDetection()

public Template.TemplateMetadata.Builder clearMultiLanguageDetection()

Optional. Metadata for multi language detection.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Template.TemplateMetadata.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnforcementType()

public Template.TemplateMetadata.EnforcementType getEnforcementType()

Optional. Enforcement type for Model Armor filters.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.EnforcementType enforcement_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Template.TemplateMetadata.EnforcementType

The enforcementType.

getEnforcementTypeValue()

public int getEnforcementTypeValue()

Optional. Enforcement type for Model Armor filters.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.EnforcementType enforcement_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for enforcementType.

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.

getModalities(int index)

public Modality getModalities(int index)

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Modality

The modalities at the given index.

getModalitiesCount()

public int getModalitiesCount()

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of modalities.

getModalitiesList()

public List<Modality> getModalitiesList()

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Modality>

A list containing the modalities.

getModalitiesValue(int index)

public int getModalitiesValue(int index)

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of modalities at the given index.

getModalitiesValueList()

public List<Integer> getModalitiesValueList()

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for modalities.

getMultiLanguageDetection()

public Template.TemplateMetadata.MultiLanguageDetection getMultiLanguageDetection()

Optional. Metadata for multi language detection.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Template.TemplateMetadata.MultiLanguageDetection

The multiLanguageDetection.

getMultiLanguageDetectionBuilder()

public Template.TemplateMetadata.MultiLanguageDetection.Builder getMultiLanguageDetectionBuilder()

Optional. Metadata for multi language detection.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Template.TemplateMetadata.MultiLanguageDetection.Builder

getMultiLanguageDetectionOrBuilder()

public Template.TemplateMetadata.MultiLanguageDetectionOrBuilder getMultiLanguageDetectionOrBuilder()

Optional. Metadata for multi language detection.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Template.TemplateMetadata.MultiLanguageDetectionOrBuilder

hasMultiLanguageDetection()

public boolean hasMultiLanguageDetection()

Optional. Metadata for multi language detection.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the multiLanguageDetection field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Template.TemplateMetadata other)

public Template.TemplateMetadata.Builder mergeFrom(Template.TemplateMetadata other)
Parameter
Name Description
other Template.TemplateMetadata
Returns
Type Description
Template.TemplateMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Template.TemplateMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Template.TemplateMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Template.TemplateMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Template.TemplateMetadata.Builder
Overrides

mergeMultiLanguageDetection(Template.TemplateMetadata.MultiLanguageDetection value)

public Template.TemplateMetadata.Builder mergeMultiLanguageDetection(Template.TemplateMetadata.MultiLanguageDetection value)

Optional. Metadata for multi language detection.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Template.TemplateMetadata.MultiLanguageDetection
Returns
Type Description
Template.TemplateMetadata.Builder

setCustomLlmResponseSafetyErrorCode(int value)

public Template.TemplateMetadata.Builder setCustomLlmResponseSafetyErrorCode(int value)

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

Parameter
Name Description
value int

The customLlmResponseSafetyErrorCode to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setCustomLlmResponseSafetyErrorMessage(String value)

public Template.TemplateMetadata.Builder setCustomLlmResponseSafetyErrorMessage(String value)

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

Parameter
Name Description
value String

The customLlmResponseSafetyErrorMessage to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setCustomLlmResponseSafetyErrorMessageBytes(ByteString value)

public Template.TemplateMetadata.Builder setCustomLlmResponseSafetyErrorMessageBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for customLlmResponseSafetyErrorMessage to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setCustomPromptSafetyErrorCode(int value)

public Template.TemplateMetadata.Builder setCustomPromptSafetyErrorCode(int value)

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

Parameter
Name Description
value int

The customPromptSafetyErrorCode to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setCustomPromptSafetyErrorMessage(String value)

public Template.TemplateMetadata.Builder setCustomPromptSafetyErrorMessage(String value)

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

Parameter
Name Description
value String

The customPromptSafetyErrorMessage to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setCustomPromptSafetyErrorMessageBytes(ByteString value)

public Template.TemplateMetadata.Builder setCustomPromptSafetyErrorMessageBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for customPromptSafetyErrorMessage to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setEnforcementType(Template.TemplateMetadata.EnforcementType value)

public Template.TemplateMetadata.Builder setEnforcementType(Template.TemplateMetadata.EnforcementType value)

Optional. Enforcement type for Model Armor filters.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.EnforcementType enforcement_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Template.TemplateMetadata.EnforcementType

The enforcementType to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setEnforcementTypeValue(int value)

public Template.TemplateMetadata.Builder setEnforcementTypeValue(int value)

Optional. Enforcement type for Model Armor filters.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.EnforcementType enforcement_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for enforcementType to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setIgnorePartialInvocationFailures(boolean value)

public Template.TemplateMetadata.Builder setIgnorePartialInvocationFailures(boolean value)

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

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

Parameter
Name Description
value boolean

The ignorePartialInvocationFailures to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setLogSanitizeOperations(boolean value)

public Template.TemplateMetadata.Builder setLogSanitizeOperations(boolean value)

Optional. If true, log sanitize operations.

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

Parameter
Name Description
value boolean

The logSanitizeOperations to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setLogTemplateOperations(boolean value)

public Template.TemplateMetadata.Builder setLogTemplateOperations(boolean value)

Optional. If true, log template crud operations.

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

Parameter
Name Description
value boolean

The logTemplateOperations to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setModalities(int index, Modality value)

public Template.TemplateMetadata.Builder setModalities(int index, Modality value)

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value Modality

The modalities to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setModalitiesValue(int index, int value)

public Template.TemplateMetadata.Builder setModalitiesValue(int index, int value)

Optional. Specifies the modalities to scan. If empty, only text modality will be scanned.

repeated .google.cloud.modelarmor.v1.Modality modalities = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for modalities to set.

Returns
Type Description
Template.TemplateMetadata.Builder

This builder for chaining.

setMultiLanguageDetection(Template.TemplateMetadata.MultiLanguageDetection value)

public Template.TemplateMetadata.Builder setMultiLanguageDetection(Template.TemplateMetadata.MultiLanguageDetection value)

Optional. Metadata for multi language detection.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Template.TemplateMetadata.MultiLanguageDetection
Returns
Type Description
Template.TemplateMetadata.Builder

setMultiLanguageDetection(Template.TemplateMetadata.MultiLanguageDetection.Builder builderForValue)

public Template.TemplateMetadata.Builder setMultiLanguageDetection(Template.TemplateMetadata.MultiLanguageDetection.Builder builderForValue)

Optional. Metadata for multi language detection.

.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Template.TemplateMetadata.MultiLanguageDetection.Builder
Returns
Type Description
Template.TemplateMetadata.Builder