Package com.google.cloud.modelarmor.v1beta

Class Template.TemplateMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.modelarmor.v1beta.Template.TemplateMetadata
All Implemented Interfaces:
Template.TemplateMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Template
public static final class Template.TemplateMetadata extends com.google.protobuf.GeneratedMessage implements Template.TemplateMetadataOrBuilder
 Message describing TemplateMetadata
Protobuf type google.cloud.modelarmor.v1beta.Template.TemplateMetadata
See Also:

  • Field Details

    • IGNORE_PARTIAL_INVOCATION_FAILURES_FIELD_NUMBER

      public static final int IGNORE_PARTIAL_INVOCATION_FAILURES_FIELD_NUMBER
      See Also:

    • CUSTOM_PROMPT_SAFETY_ERROR_CODE_FIELD_NUMBER

      public static final int CUSTOM_PROMPT_SAFETY_ERROR_CODE_FIELD_NUMBER
      See Also:

    • CUSTOM_PROMPT_SAFETY_ERROR_MESSAGE_FIELD_NUMBER

      public static final int CUSTOM_PROMPT_SAFETY_ERROR_MESSAGE_FIELD_NUMBER
      See Also:

    • CUSTOM_LLM_RESPONSE_SAFETY_ERROR_CODE_FIELD_NUMBER

      public static final int CUSTOM_LLM_RESPONSE_SAFETY_ERROR_CODE_FIELD_NUMBER
      See Also:

    • CUSTOM_LLM_RESPONSE_SAFETY_ERROR_MESSAGE_FIELD_NUMBER

      public static final int CUSTOM_LLM_RESPONSE_SAFETY_ERROR_MESSAGE_FIELD_NUMBER
      See Also:

    • LOG_TEMPLATE_OPERATIONS_FIELD_NUMBER

      public static final int LOG_TEMPLATE_OPERATIONS_FIELD_NUMBER
      See Also:

    • LOG_SANITIZE_OPERATIONS_FIELD_NUMBER

      public static final int LOG_SANITIZE_OPERATIONS_FIELD_NUMBER
      See Also:

    • ENFORCEMENT_TYPE_FIELD_NUMBER

      public static final int ENFORCEMENT_TYPE_FIELD_NUMBER
      See Also:

    • MULTI_LANGUAGE_DETECTION_FIELD_NUMBER

      public static final int MULTI_LANGUAGE_DETECTION_FIELD_NUMBER
      See Also:

  • Method Details

    • 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

    • getIgnorePartialInvocationFailures

      public boolean getIgnorePartialInvocationFailures()
       Optional. If true, partial detector failures should be ignored.
      bool ignore_partial_invocation_failures = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIgnorePartialInvocationFailures in interface Template.TemplateMetadataOrBuilder
      Returns:
      The ignorePartialInvocationFailures.

    • 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];
      Specified by:
      getCustomPromptSafetyErrorCode in interface Template.TemplateMetadataOrBuilder
      Returns:
      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];
      Specified by:
      getCustomPromptSafetyErrorMessage in interface Template.TemplateMetadataOrBuilder
      Returns:
      The customPromptSafetyErrorMessage.

    • getCustomPromptSafetyErrorMessageBytes

      public com.google.protobuf.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];
      Specified by:
      getCustomPromptSafetyErrorMessageBytes in interface Template.TemplateMetadataOrBuilder
      Returns:
      The bytes for customPromptSafetyErrorMessage.

    • 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];
      Specified by:
      getCustomLlmResponseSafetyErrorCode in interface Template.TemplateMetadataOrBuilder
      Returns:
      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];
      Specified by:
      getCustomLlmResponseSafetyErrorMessage in interface Template.TemplateMetadataOrBuilder
      Returns:
      The customLlmResponseSafetyErrorMessage.

    • getCustomLlmResponseSafetyErrorMessageBytes

      public com.google.protobuf.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];
      Specified by:
      getCustomLlmResponseSafetyErrorMessageBytes in interface Template.TemplateMetadataOrBuilder
      Returns:
      The bytes for customLlmResponseSafetyErrorMessage.

    • getLogTemplateOperations

      public boolean getLogTemplateOperations()
       Optional. If true, log template crud operations.
      bool log_template_operations = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLogTemplateOperations in interface Template.TemplateMetadataOrBuilder
      Returns:
      The logTemplateOperations.

    • getLogSanitizeOperations

      public boolean getLogSanitizeOperations()
       Optional. If true, log sanitize operations.
      bool log_sanitize_operations = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLogSanitizeOperations in interface Template.TemplateMetadataOrBuilder
      Returns:
      The logSanitizeOperations.

    • getEnforcementTypeValue

      public int getEnforcementTypeValue()
       Optional. Enforcement type for Model Armor filters.
      .google.cloud.modelarmor.v1beta.Template.TemplateMetadata.EnforcementType enforcement_type = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnforcementTypeValue in interface Template.TemplateMetadataOrBuilder
      Returns:
      The enum numeric value on the wire for enforcementType.

    • getEnforcementType

      public Template.TemplateMetadata.EnforcementType getEnforcementType()
       Optional. Enforcement type for Model Armor filters.
      .google.cloud.modelarmor.v1beta.Template.TemplateMetadata.EnforcementType enforcement_type = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnforcementType in interface Template.TemplateMetadataOrBuilder
      Returns:
      The enforcementType.

    • hasMultiLanguageDetection

      public boolean hasMultiLanguageDetection()
       Optional. Metadata for multi language detection.
      .google.cloud.modelarmor.v1beta.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasMultiLanguageDetection in interface Template.TemplateMetadataOrBuilder
      Returns:
      Whether the multiLanguageDetection field is set.

    • getMultiLanguageDetection

      public Template.TemplateMetadata.MultiLanguageDetection getMultiLanguageDetection()
       Optional. Metadata for multi language detection.
      .google.cloud.modelarmor.v1beta.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMultiLanguageDetection in interface Template.TemplateMetadataOrBuilder
      Returns:
      The multiLanguageDetection.

    • getMultiLanguageDetectionOrBuilder

      public Template.TemplateMetadata.MultiLanguageDetectionOrBuilder getMultiLanguageDetectionOrBuilder()
       Optional. Metadata for multi language detection.
      .google.cloud.modelarmor.v1beta.Template.TemplateMetadata.MultiLanguageDetection multi_language_detection = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMultiLanguageDetectionOrBuilder in interface Template.TemplateMetadataOrBuilder

    • 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 Template.TemplateMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Template.TemplateMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Template.TemplateMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Template.TemplateMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Template.TemplateMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Template.TemplateMetadata.Builder newBuilder()

    • newBuilder

      public static Template.TemplateMetadata.Builder newBuilder(Template.TemplateMetadata prototype)

    • toBuilder

      public Template.TemplateMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Template.TemplateMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Template.TemplateMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Template.TemplateMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<Template.TemplateMetadata> 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 Template.TemplateMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder