com.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfigOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dlp-v2 Show documentation
Show all versions of proto-google-cloud-dlp-v2 Show documentation
PROTO library for proto-google-cloud-dlp-v2
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/privacy/dlp/v2/dlp.proto
// Protobuf Java Version: 3.25.4
package com.google.privacy.dlp.v2;
public interface CryptoReplaceFfxFpeConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The key used by the encryption algorithm.
*
*
*
* .google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the cryptoKey field is set.
*/
boolean hasCryptoKey();
/**
*
*
*
* Required. The key used by the encryption algorithm.
*
*
*
* .google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The cryptoKey.
*/
com.google.privacy.dlp.v2.CryptoKey getCryptoKey();
/**
*
*
*
* Required. The key used by the encryption algorithm.
*
*
*
* .google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.privacy.dlp.v2.CryptoKeyOrBuilder getCryptoKeyOrBuilder();
/**
*
*
*
* The 'tweak', a context may be used for higher security since the same
* identifier in two different contexts won't be given the same surrogate. If
* the context is not set, a default tweak will be used.
*
* If the context is set but:
*
* 1. there is no record present when transforming a given value or
* 1. the field is not present when transforming a given value,
*
* a default tweak will be used.
*
* Note that case (1) is expected when an `InfoTypeTransformation` is
* applied to both structured and unstructured `ContentItem`s.
* Currently, the referenced field may be of value type integer or string.
*
* The tweak is constructed as a sequence of bytes in big endian byte order
* such that:
*
* - a 64 bit integer is encoded followed by a single byte of value 1
* - a string is encoded in UTF-8 format followed by a single byte of value 2
*
*
* .google.privacy.dlp.v2.FieldId context = 2;
*
* @return Whether the context field is set.
*/
boolean hasContext();
/**
*
*
*
* The 'tweak', a context may be used for higher security since the same
* identifier in two different contexts won't be given the same surrogate. If
* the context is not set, a default tweak will be used.
*
* If the context is set but:
*
* 1. there is no record present when transforming a given value or
* 1. the field is not present when transforming a given value,
*
* a default tweak will be used.
*
* Note that case (1) is expected when an `InfoTypeTransformation` is
* applied to both structured and unstructured `ContentItem`s.
* Currently, the referenced field may be of value type integer or string.
*
* The tweak is constructed as a sequence of bytes in big endian byte order
* such that:
*
* - a 64 bit integer is encoded followed by a single byte of value 1
* - a string is encoded in UTF-8 format followed by a single byte of value 2
*
*
* .google.privacy.dlp.v2.FieldId context = 2;
*
* @return The context.
*/
com.google.privacy.dlp.v2.FieldId getContext();
/**
*
*
*
* The 'tweak', a context may be used for higher security since the same
* identifier in two different contexts won't be given the same surrogate. If
* the context is not set, a default tweak will be used.
*
* If the context is set but:
*
* 1. there is no record present when transforming a given value or
* 1. the field is not present when transforming a given value,
*
* a default tweak will be used.
*
* Note that case (1) is expected when an `InfoTypeTransformation` is
* applied to both structured and unstructured `ContentItem`s.
* Currently, the referenced field may be of value type integer or string.
*
* The tweak is constructed as a sequence of bytes in big endian byte order
* such that:
*
* - a 64 bit integer is encoded followed by a single byte of value 1
* - a string is encoded in UTF-8 format followed by a single byte of value 2
*
*
* .google.privacy.dlp.v2.FieldId context = 2;
*/
com.google.privacy.dlp.v2.FieldIdOrBuilder getContextOrBuilder();
/**
*
*
*
* Common alphabets.
*
*
*
* .google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
*
*
* @return Whether the commonAlphabet field is set.
*/
boolean hasCommonAlphabet();
/**
*
*
*
* Common alphabets.
*
*
*
* .google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
*
*
* @return The enum numeric value on the wire for commonAlphabet.
*/
int getCommonAlphabetValue();
/**
*
*
*
* Common alphabets.
*
*
*
* .google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
*
*
* @return The commonAlphabet.
*/
com.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet getCommonAlphabet();
/**
*
*
*
* This is supported by mapping these to the alphanumeric characters
* that the FFX mode natively supports. This happens before/after
* encryption/decryption.
* Each character listed must appear only once.
* Number of characters must be in the range [2, 95].
* This must be encoded as ASCII.
* The order of characters does not matter.
* The full list of allowed characters is:
* ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/``
*
*
* string custom_alphabet = 5;
*
* @return Whether the customAlphabet field is set.
*/
boolean hasCustomAlphabet();
/**
*
*
*
* This is supported by mapping these to the alphanumeric characters
* that the FFX mode natively supports. This happens before/after
* encryption/decryption.
* Each character listed must appear only once.
* Number of characters must be in the range [2, 95].
* This must be encoded as ASCII.
* The order of characters does not matter.
* The full list of allowed characters is:
* ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/``
*
*
* string custom_alphabet = 5;
*
* @return The customAlphabet.
*/
java.lang.String getCustomAlphabet();
/**
*
*
*
* This is supported by mapping these to the alphanumeric characters
* that the FFX mode natively supports. This happens before/after
* encryption/decryption.
* Each character listed must appear only once.
* Number of characters must be in the range [2, 95].
* This must be encoded as ASCII.
* The order of characters does not matter.
* The full list of allowed characters is:
* ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/``
*
*
* string custom_alphabet = 5;
*
* @return The bytes for customAlphabet.
*/
com.google.protobuf.ByteString getCustomAlphabetBytes();
/**
*
*
*
* The native way to select the alphabet. Must be in the range [2, 95].
*
*
* int32 radix = 6;
*
* @return Whether the radix field is set.
*/
boolean hasRadix();
/**
*
*
*
* The native way to select the alphabet. Must be in the range [2, 95].
*
*
* int32 radix = 6;
*
* @return The radix.
*/
int getRadix();
/**
*
*
*
* The custom infoType to annotate the surrogate with.
* This annotation will be applied to the surrogate by prefixing it with
* the name of the custom infoType followed by the number of
* characters comprising the surrogate. The following scheme defines the
* format: info_type_name(surrogate_character_count):surrogate
*
* For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and
* the surrogate is 'abc', the full replacement value
* will be: 'MY_TOKEN_INFO_TYPE(3):abc'
*
* This annotation identifies the surrogate when inspecting content using the
* custom infoType
* [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype).
* This facilitates reversal of the surrogate when it occurs in free text.
*
* In order for inspection to work properly, the name of this infoType must
* not occur naturally anywhere in your data; otherwise, inspection may
* find a surrogate that does not correspond to an actual identifier.
* Therefore, choose your custom infoType name carefully after considering
* what your data looks like. One way to select a name that has a high chance
* of yielding reliable detection is to include one or more unicode characters
* that are highly improbable to exist in your data.
* For example, assuming your data is entered from a regular ASCII keyboard,
* the symbol with the hex code point 29DD might be used like so:
* ⧝MY_TOKEN_TYPE
*
*
* .google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
*
* @return Whether the surrogateInfoType field is set.
*/
boolean hasSurrogateInfoType();
/**
*
*
*
* The custom infoType to annotate the surrogate with.
* This annotation will be applied to the surrogate by prefixing it with
* the name of the custom infoType followed by the number of
* characters comprising the surrogate. The following scheme defines the
* format: info_type_name(surrogate_character_count):surrogate
*
* For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and
* the surrogate is 'abc', the full replacement value
* will be: 'MY_TOKEN_INFO_TYPE(3):abc'
*
* This annotation identifies the surrogate when inspecting content using the
* custom infoType
* [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype).
* This facilitates reversal of the surrogate when it occurs in free text.
*
* In order for inspection to work properly, the name of this infoType must
* not occur naturally anywhere in your data; otherwise, inspection may
* find a surrogate that does not correspond to an actual identifier.
* Therefore, choose your custom infoType name carefully after considering
* what your data looks like. One way to select a name that has a high chance
* of yielding reliable detection is to include one or more unicode characters
* that are highly improbable to exist in your data.
* For example, assuming your data is entered from a regular ASCII keyboard,
* the symbol with the hex code point 29DD might be used like so:
* ⧝MY_TOKEN_TYPE
*
*
* .google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
*
* @return The surrogateInfoType.
*/
com.google.privacy.dlp.v2.InfoType getSurrogateInfoType();
/**
*
*
*
* The custom infoType to annotate the surrogate with.
* This annotation will be applied to the surrogate by prefixing it with
* the name of the custom infoType followed by the number of
* characters comprising the surrogate. The following scheme defines the
* format: info_type_name(surrogate_character_count):surrogate
*
* For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and
* the surrogate is 'abc', the full replacement value
* will be: 'MY_TOKEN_INFO_TYPE(3):abc'
*
* This annotation identifies the surrogate when inspecting content using the
* custom infoType
* [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype).
* This facilitates reversal of the surrogate when it occurs in free text.
*
* In order for inspection to work properly, the name of this infoType must
* not occur naturally anywhere in your data; otherwise, inspection may
* find a surrogate that does not correspond to an actual identifier.
* Therefore, choose your custom infoType name carefully after considering
* what your data looks like. One way to select a name that has a high chance
* of yielding reliable detection is to include one or more unicode characters
* that are highly improbable to exist in your data.
* For example, assuming your data is entered from a regular ASCII keyboard,
* the symbol with the hex code point 29DD might be used like so:
* ⧝MY_TOKEN_TYPE
*
*
* .google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
*/
com.google.privacy.dlp.v2.InfoTypeOrBuilder getSurrogateInfoTypeOrBuilder();
com.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.AlphabetCase getAlphabetCase();
}