Package com.google.cloud.modelarmor.v1 (0.17.0)

GitHub Repository

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.modelarmor.v1.ModelArmorClient Service Description: Service describing handlers for resources

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.modelarmor.v1.MaliciousUriFilterSettings

Malicious URI filter settings.
com.google.cloud.modelarmor.v1.ModelArmorSettings Settings class to configure an instance of ModelArmorClient.

The default instance has everything set to sensible defaults:

com.google.cloud.modelarmor.v1.PiAndJailbreakFilterSettings

Prompt injection and Jailbreak Filter settings.
com.google.cloud.modelarmor.v1.RaiFilterSettings

Responsible AI Filter settings.
com.google.cloud.modelarmor.v1.SdpFilterSettings

Sensitive Data Protection settings.

Classes

Class Description
com.google.cloud.modelarmor.v1.AiPlatformFloorSetting message describing AiPlatformFloorSetting
com.google.cloud.modelarmor.v1.AiPlatformFloorSetting.Builder message describing AiPlatformFloorSetting
com.google.cloud.modelarmor.v1.ByteDataItem Represents Byte Data item.
com.google.cloud.modelarmor.v1.ByteDataItem.Builder Represents Byte Data item.
com.google.cloud.modelarmor.v1.CreateTemplateRequest Message for creating a Template
com.google.cloud.modelarmor.v1.CreateTemplateRequest.Builder Message for creating a Template
com.google.cloud.modelarmor.v1.CsamFilterResult CSAM (Child Safety Abuse Material) Filter Result
com.google.cloud.modelarmor.v1.CsamFilterResult.Builder CSAM (Child Safety Abuse Material) Filter Result
com.google.cloud.modelarmor.v1.DataItem Represents Data item
com.google.cloud.modelarmor.v1.DataItem.Builder Represents Data item
com.google.cloud.modelarmor.v1.DeleteTemplateRequest Message for deleting a Template
com.google.cloud.modelarmor.v1.DeleteTemplateRequest.Builder Message for deleting a Template
com.google.cloud.modelarmor.v1.FilterConfig Filters configuration.
com.google.cloud.modelarmor.v1.FilterConfig.Builder Filters configuration.
com.google.cloud.modelarmor.v1.FilterResult Filter Result obtained after Sanitization operations.
com.google.cloud.modelarmor.v1.FilterResult.Builder Filter Result obtained after Sanitization operations.
com.google.cloud.modelarmor.v1.FloorSetting Message describing FloorSetting resource
com.google.cloud.modelarmor.v1.FloorSetting.Builder Message describing FloorSetting resource
com.google.cloud.modelarmor.v1.FloorSetting.FloorSettingMetadata message describing FloorSetting Metadata
com.google.cloud.modelarmor.v1.FloorSetting.FloorSettingMetadata.Builder message describing FloorSetting Metadata
com.google.cloud.modelarmor.v1.FloorSetting.FloorSettingMetadata.MultiLanguageDetection Metadata to enable multi language detection via floor setting.
com.google.cloud.modelarmor.v1.FloorSetting.FloorSettingMetadata.MultiLanguageDetection.Builder Metadata to enable multi language detection via floor setting.
com.google.cloud.modelarmor.v1.FloorSettingName
com.google.cloud.modelarmor.v1.FloorSettingName.Builder Builder for projects/{project}/locations/{location}/floorSetting.
com.google.cloud.modelarmor.v1.FloorSettingName.FolderLocationBuilder Builder for folders/{folder}/locations/{location}/floorSetting.
com.google.cloud.modelarmor.v1.FloorSettingName.OrganizationLocationBuilder Builder for organizations/{organization}/locations/{location}/floorSetting.
com.google.cloud.modelarmor.v1.GetFloorSettingRequest Message for getting a Floor Setting
com.google.cloud.modelarmor.v1.GetFloorSettingRequest.Builder Message for getting a Floor Setting
com.google.cloud.modelarmor.v1.GetTemplateRequest Message for getting a Template
com.google.cloud.modelarmor.v1.GetTemplateRequest.Builder Message for getting a Template
com.google.cloud.modelarmor.v1.ListTemplatesRequest Message for requesting list of Templates
com.google.cloud.modelarmor.v1.ListTemplatesRequest.Builder Message for requesting list of Templates
com.google.cloud.modelarmor.v1.ListTemplatesResponse Message for response to listing Templates
com.google.cloud.modelarmor.v1.ListTemplatesResponse.Builder Message for response to listing Templates
com.google.cloud.modelarmor.v1.LocationName
com.google.cloud.modelarmor.v1.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.modelarmor.v1.MaliciousUriFilterResult Malicious URI Filter Result.
com.google.cloud.modelarmor.v1.MaliciousUriFilterResult.Builder Malicious URI Filter Result.
com.google.cloud.modelarmor.v1.MaliciousUriFilterResult.MaliciousUriMatchedItem Information regarding malicious URI and its location within the input content.
com.google.cloud.modelarmor.v1.MaliciousUriFilterResult.MaliciousUriMatchedItem.Builder Information regarding malicious URI and its location within the input content.
com.google.cloud.modelarmor.v1.MaliciousUriFilterSettings.Builder Malicious URI filter settings.
com.google.cloud.modelarmor.v1.MessageItem Message item to report information, warning or error messages.
com.google.cloud.modelarmor.v1.MessageItem.Builder Message item to report information, warning or error messages.
com.google.cloud.modelarmor.v1.ModelArmorClient.ListLocationsFixedSizeCollection
com.google.cloud.modelarmor.v1.ModelArmorClient.ListLocationsPage
com.google.cloud.modelarmor.v1.ModelArmorClient.ListLocationsPagedResponse
com.google.cloud.modelarmor.v1.ModelArmorClient.ListTemplatesFixedSizeCollection
com.google.cloud.modelarmor.v1.ModelArmorClient.ListTemplatesPage
com.google.cloud.modelarmor.v1.ModelArmorClient.ListTemplatesPagedResponse
com.google.cloud.modelarmor.v1.ModelArmorGrpc Service describing handlers for resources
com.google.cloud.modelarmor.v1.ModelArmorGrpc.ModelArmorImplBase Base class for the server implementation of the service ModelArmor. Service describing handlers for resources
com.google.cloud.modelarmor.v1.ModelArmorSettings.Builder Builder for ModelArmorSettings.
com.google.cloud.modelarmor.v1.MultiLanguageDetectionMetadata Message for Enabling Multi Language Detection.
com.google.cloud.modelarmor.v1.MultiLanguageDetectionMetadata.Builder Message for Enabling Multi Language Detection.
com.google.cloud.modelarmor.v1.PiAndJailbreakFilterResult Prompt injection and Jailbreak Filter Result.
com.google.cloud.modelarmor.v1.PiAndJailbreakFilterResult.Builder Prompt injection and Jailbreak Filter Result.
com.google.cloud.modelarmor.v1.PiAndJailbreakFilterSettings.Builder Prompt injection and Jailbreak Filter settings.
com.google.cloud.modelarmor.v1.RaiFilterResult Responsible AI Result.
com.google.cloud.modelarmor.v1.RaiFilterResult.Builder Responsible AI Result.
com.google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult Detailed Filter result for each of the responsible AI Filter Types.
com.google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult.Builder Detailed Filter result for each of the responsible AI Filter Types.
com.google.cloud.modelarmor.v1.RaiFilterSettings.Builder Responsible AI Filter settings.
com.google.cloud.modelarmor.v1.RaiFilterSettings.RaiFilter Responsible AI filter.
com.google.cloud.modelarmor.v1.RaiFilterSettings.RaiFilter.Builder Responsible AI filter.
com.google.cloud.modelarmor.v1.RangeInfo Half-open range interval [start, end)
com.google.cloud.modelarmor.v1.RangeInfo.Builder Half-open range interval [start, end)
com.google.cloud.modelarmor.v1.SanitizationResult Sanitization result after applying all the filters on input content.
com.google.cloud.modelarmor.v1.SanitizationResult.Builder Sanitization result after applying all the filters on input content.
com.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata Message describing Sanitization metadata.
com.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata.Builder Message describing Sanitization metadata.
com.google.cloud.modelarmor.v1.SanitizeModelResponseRequest Sanitize Model Response request.
com.google.cloud.modelarmor.v1.SanitizeModelResponseRequest.Builder Sanitize Model Response request.
com.google.cloud.modelarmor.v1.SanitizeModelResponseResponse Sanitized Model Response Response.
com.google.cloud.modelarmor.v1.SanitizeModelResponseResponse.Builder Sanitized Model Response Response.
com.google.cloud.modelarmor.v1.SanitizeUserPromptRequest Sanitize User Prompt request.
com.google.cloud.modelarmor.v1.SanitizeUserPromptRequest.Builder Sanitize User Prompt request.
com.google.cloud.modelarmor.v1.SanitizeUserPromptResponse Sanitized User Prompt Response.
com.google.cloud.modelarmor.v1.SanitizeUserPromptResponse.Builder Sanitized User Prompt Response.
com.google.cloud.modelarmor.v1.SdpAdvancedConfig Sensitive Data Protection Advanced configuration.
com.google.cloud.modelarmor.v1.SdpAdvancedConfig.Builder Sensitive Data Protection Advanced configuration.
com.google.cloud.modelarmor.v1.SdpBasicConfig Sensitive Data Protection basic configuration.
com.google.cloud.modelarmor.v1.SdpBasicConfig.Builder Sensitive Data Protection basic configuration.
com.google.cloud.modelarmor.v1.SdpDeidentifyResult Sensitive Data Protection Deidentification Result.
com.google.cloud.modelarmor.v1.SdpDeidentifyResult.Builder Sensitive Data Protection Deidentification Result.
com.google.cloud.modelarmor.v1.SdpFilterResult Sensitive Data Protection filter result.
com.google.cloud.modelarmor.v1.SdpFilterResult.Builder Sensitive Data Protection filter result.
com.google.cloud.modelarmor.v1.SdpFilterSettings.Builder Sensitive Data Protection settings.
com.google.cloud.modelarmor.v1.SdpFinding Finding corresponding to Sensitive Data Protection filter.
com.google.cloud.modelarmor.v1.SdpFinding.Builder Finding corresponding to Sensitive Data Protection filter.
com.google.cloud.modelarmor.v1.SdpFinding.SdpFindingLocation Location of this Sensitive Data Protection Finding within input content.
com.google.cloud.modelarmor.v1.SdpFinding.SdpFindingLocation.Builder Location of this Sensitive Data Protection Finding within input content.
com.google.cloud.modelarmor.v1.SdpInspectResult Sensitive Data Protection Inspection Result.
com.google.cloud.modelarmor.v1.SdpInspectResult.Builder Sensitive Data Protection Inspection Result.
com.google.cloud.modelarmor.v1.Template Message describing Template resource
com.google.cloud.modelarmor.v1.Template.Builder Message describing Template resource
com.google.cloud.modelarmor.v1.Template.TemplateMetadata Message describing TemplateMetadata
com.google.cloud.modelarmor.v1.Template.TemplateMetadata.Builder Message describing TemplateMetadata
com.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection Metadata to enable multi language detection via template.
com.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetection.Builder Metadata to enable multi language detection via template.
com.google.cloud.modelarmor.v1.TemplateName
com.google.cloud.modelarmor.v1.TemplateName.Builder Builder for projects/{project}/locations/{location}/templates/{template}.
com.google.cloud.modelarmor.v1.UpdateFloorSettingRequest Message for Updating a Floor Setting
com.google.cloud.modelarmor.v1.UpdateFloorSettingRequest.Builder Message for Updating a Floor Setting
com.google.cloud.modelarmor.v1.UpdateTemplateRequest Message for updating a Template
com.google.cloud.modelarmor.v1.UpdateTemplateRequest.Builder Message for updating a Template
com.google.cloud.modelarmor.v1.V1mainProto
com.google.cloud.modelarmor.v1.VirusDetail Details of an identified virus
com.google.cloud.modelarmor.v1.VirusDetail.Builder Details of an identified virus
com.google.cloud.modelarmor.v1.VirusScanFilterResult Virus scan results.
com.google.cloud.modelarmor.v1.VirusScanFilterResult.Builder Virus scan results.

Interfaces

Interface Description
com.google.cloud.modelarmor.v1.AiPlatformFloorSettingOrBuilder
com.google.cloud.modelarmor.v1.ByteDataItemOrBuilder
com.google.cloud.modelarmor.v1.CreateTemplateRequestOrBuilder
com.google.cloud.modelarmor.v1.CsamFilterResultOrBuilder
com.google.cloud.modelarmor.v1.DataItemOrBuilder
com.google.cloud.modelarmor.v1.DeleteTemplateRequestOrBuilder
com.google.cloud.modelarmor.v1.FilterConfigOrBuilder
com.google.cloud.modelarmor.v1.FilterResultOrBuilder
com.google.cloud.modelarmor.v1.FloorSetting.FloorSettingMetadata.MultiLanguageDetectionOrBuilder
com.google.cloud.modelarmor.v1.FloorSetting.FloorSettingMetadataOrBuilder
com.google.cloud.modelarmor.v1.FloorSettingOrBuilder
com.google.cloud.modelarmor.v1.GetFloorSettingRequestOrBuilder
com.google.cloud.modelarmor.v1.GetTemplateRequestOrBuilder
com.google.cloud.modelarmor.v1.ListTemplatesRequestOrBuilder
com.google.cloud.modelarmor.v1.ListTemplatesResponseOrBuilder
com.google.cloud.modelarmor.v1.MaliciousUriFilterResult.MaliciousUriMatchedItemOrBuilder
com.google.cloud.modelarmor.v1.MaliciousUriFilterResultOrBuilder
com.google.cloud.modelarmor.v1.MaliciousUriFilterSettingsOrBuilder
com.google.cloud.modelarmor.v1.MessageItemOrBuilder
com.google.cloud.modelarmor.v1.ModelArmorGrpc.AsyncService Service describing handlers for resources
com.google.cloud.modelarmor.v1.MultiLanguageDetectionMetadataOrBuilder
com.google.cloud.modelarmor.v1.PiAndJailbreakFilterResultOrBuilder
com.google.cloud.modelarmor.v1.PiAndJailbreakFilterSettingsOrBuilder
com.google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResultOrBuilder
com.google.cloud.modelarmor.v1.RaiFilterResultOrBuilder
com.google.cloud.modelarmor.v1.RaiFilterSettings.RaiFilterOrBuilder
com.google.cloud.modelarmor.v1.RaiFilterSettingsOrBuilder
com.google.cloud.modelarmor.v1.RangeInfoOrBuilder
com.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadataOrBuilder
com.google.cloud.modelarmor.v1.SanitizationResultOrBuilder
com.google.cloud.modelarmor.v1.SanitizeModelResponseRequestOrBuilder
com.google.cloud.modelarmor.v1.SanitizeModelResponseResponseOrBuilder
com.google.cloud.modelarmor.v1.SanitizeUserPromptRequestOrBuilder
com.google.cloud.modelarmor.v1.SanitizeUserPromptResponseOrBuilder
com.google.cloud.modelarmor.v1.SdpAdvancedConfigOrBuilder
com.google.cloud.modelarmor.v1.SdpBasicConfigOrBuilder
com.google.cloud.modelarmor.v1.SdpDeidentifyResultOrBuilder
com.google.cloud.modelarmor.v1.SdpFilterResultOrBuilder
com.google.cloud.modelarmor.v1.SdpFilterSettingsOrBuilder
com.google.cloud.modelarmor.v1.SdpFinding.SdpFindingLocationOrBuilder
com.google.cloud.modelarmor.v1.SdpFindingOrBuilder
com.google.cloud.modelarmor.v1.SdpInspectResultOrBuilder
com.google.cloud.modelarmor.v1.Template.TemplateMetadata.MultiLanguageDetectionOrBuilder
com.google.cloud.modelarmor.v1.Template.TemplateMetadataOrBuilder
com.google.cloud.modelarmor.v1.TemplateOrBuilder
com.google.cloud.modelarmor.v1.UpdateFloorSettingRequestOrBuilder
com.google.cloud.modelarmor.v1.UpdateTemplateRequestOrBuilder
com.google.cloud.modelarmor.v1.VirusDetailOrBuilder
com.google.cloud.modelarmor.v1.VirusScanFilterResultOrBuilder

Enums

Enum Description
com.google.cloud.modelarmor.v1.AiPlatformFloorSetting.EnforcementTypeCase
com.google.cloud.modelarmor.v1.ByteDataItem.ByteItemType Option to specify the type of byte data.
com.google.cloud.modelarmor.v1.DataItem.DataItemCase
com.google.cloud.modelarmor.v1.DetectionConfidenceLevel Confidence levels for detectors. Higher value maps to a greater confidence level. To enforce stricter level a lower value should be used.
com.google.cloud.modelarmor.v1.FilterExecutionState Enum which reports whether a specific filter executed successfully or not.
com.google.cloud.modelarmor.v1.FilterMatchState Option to specify filter match state.
com.google.cloud.modelarmor.v1.FilterResult.FilterResultCase
com.google.cloud.modelarmor.v1.FloorSetting.IntegratedService Integrated service for which the floor setting is applicable.
com.google.cloud.modelarmor.v1.InvocationResult A field indicating the outcome of the invocation, irrespective of match status.
com.google.cloud.modelarmor.v1.MaliciousUriFilterSettings.MaliciousUriFilterEnforcement Option to specify the state of Malicious URI filter (ENABLED/DISABLED).
com.google.cloud.modelarmor.v1.MessageItem.MessageType Option to specify the type of message.
com.google.cloud.modelarmor.v1.PiAndJailbreakFilterSettings.PiAndJailbreakFilterEnforcement Option to specify the state of Prompt Injection and Jailbreak filter (ENABLED/DISABLED).
com.google.cloud.modelarmor.v1.RaiFilterType Options for responsible AI Filter Types.
com.google.cloud.modelarmor.v1.SdpBasicConfig.SdpBasicConfigEnforcement Option to specify the state of Sensitive Data Protection basic config (ENABLED/DISABLED).
com.google.cloud.modelarmor.v1.SdpFilterResult.ResultCase
com.google.cloud.modelarmor.v1.SdpFilterSettings.SdpConfigurationCase
com.google.cloud.modelarmor.v1.SdpFindingLikelihood For more information about each Sensitive Data Protection likelihood level, see https://cloud.google.com/sensitive-data-protection/docs/likelihood.
com.google.cloud.modelarmor.v1.Template.TemplateMetadata.EnforcementType Enforcement type for Model Armor filters.
com.google.cloud.modelarmor.v1.VirusDetail.ThreatType Defines all the threat types of a virus
com.google.cloud.modelarmor.v1.VirusScanFilterResult.ScannedContentType Type of content scanned.