Skip to main content

transformer.proto

path mgmt/v1alpha1/transformer.proto

package mgmt.v1alpha1


Messages

CreateUserDefinedTransformerRequest

NameTypeDescription
account_idstring
namestring
descriptionstring
typestring@deprecated
sourceTransformerSource
transformer_configTransformerConfig

CreateUserDefinedTransformerResponse

NameTypeDescription
transformerUserDefinedTransformer

DeleteUserDefinedTransformerRequest

NameTypeDescription
transformer_idstring

DeleteUserDefinedTransformerResponse

NameTypeDescription

GenerateBool

NameTypeDescription

GenerateCardNumber

NameTypeDescription
valid_luhnbool

GenerateCategorical

NameTypeDescription
categoriesstring

GenerateCity

NameTypeDescription

GenerateCountry

NameTypeDescription
generate_full_nameboolAn option to return the full country name of the randomly selected country or return the default of a 2-letter country code.

GenerateDefault

NameTypeDescription

GenerateE164PhoneNumber

NameTypeDescription
minint64
maxint64

GenerateEmail

NameTypeDescription
email_typeoptional GenerateEmailTypeOptionally specify the type of email to generate. The types specified determine the contents on the left side of the @.

GenerateFirstName

NameTypeDescription

GenerateFloat64

NameTypeDescription
randomize_signbool
mindouble
maxdouble
precisionint64

GenerateFullAddress

NameTypeDescription

GenerateFullName

NameTypeDescription

GenerateGender

NameTypeDescription
abbreviatebool

GenerateInt64

NameTypeDescription
randomize_signbool
minint64
maxint64

GenerateInt64PhoneNumber

NameTypeDescription

GenerateJavascript

NameTypeDescription
codestring

GenerateLastName

NameTypeDescription

GenerateSSN

NameTypeDescription

GenerateSha256Hash

NameTypeDescription

GenerateState

NameTypeDescription
generate_full_nameboolAn option to return the full state name of the randomly selected state or return the default of a 2-letter state code.

GenerateStreetAddress

NameTypeDescription

GenerateString

NameTypeDescription
minint64
maxint64

GenerateStringPhoneNumber

NameTypeDescription
minint64
maxint64

GenerateUnixTimestamp

NameTypeDescription

GenerateUsername

NameTypeDescription

GenerateUtcTimestamp

NameTypeDescription

GenerateUuid

NameTypeDescription
include_hyphensbool

GenerateZipcode

NameTypeDescription

GetSystemTransformerBySourceRequest

NameTypeDescription
sourceTransformerSource

GetSystemTransformerBySourceResponse

NameTypeDescription
transformerSystemTransformer

GetSystemTransformersRequest

NameTypeDescription

GetSystemTransformersResponse

NameTypeDescription
transformersrepeated SystemTransformer

GetUserDefinedTransformerByIdRequest

NameTypeDescription
transformer_idstring

GetUserDefinedTransformerByIdResponse

NameTypeDescription
transformerUserDefinedTransformer

GetUserDefinedTransformersRequest

NameTypeDescription
account_idstring

GetUserDefinedTransformersResponse

NameTypeDescription
transformersrepeated UserDefinedTransformer

IsTransformerNameAvailableRequest

NameTypeDescription
account_idstring
transformer_namestring

IsTransformerNameAvailableResponse

NameTypeDescription
is_availablebool

Null

NameTypeDescription

Passthrough

NameTypeDescription

SystemTransformer

NameTypeDescription
namestring
descriptionstring
data_typeTransformerDataType
sourceTransformerSource
configTransformerConfig
data_typesrepeated TransformerDataType
supported_job_typesrepeated SupportedJobType

TransformCharacterScramble

NameTypeDescription
user_provided_regexoptional stringa user provided regular expression that they wish to validate if it compiles in GO

TransformE164PhoneNumber

NameTypeDescription
preserve_lengthbool

TransformEmail

NameTypeDescription
preserve_domainboolWhether or not to preserve the original domain, barring what has been specified in the excluded_domains property.
preserve_lengthboolWhether or not to preserve the original length of the email. This causes the transformed email to retain the original length.
excluded_domainsrepeated stringA lsit of email domains that should be excluded. This changes based on the preserve_domain flag. See the docs for more details.
email_typeoptional GenerateEmailTypeOptionally specify the type of email to generate. The types specified determine the contents on the left side of the @.
invalid_email_actionoptional InvalidEmailActionOptionally specify an action in the result of an invalid email. An invalid email is one that does not conform to RFC 5322.

TransformFirstName

NameTypeDescription
preserve_lengthbool

TransformFloat64

NameTypeDescription
randomization_range_mindouble
randomization_range_maxdouble

TransformFullName

NameTypeDescription
preserve_lengthbool

TransformInt64

NameTypeDescription
randomization_range_minint64
randomization_range_maxint64

TransformInt64PhoneNumber

NameTypeDescription
preserve_lengthbool

TransformJavascript

NameTypeDescription
codestring

TransformLastName

NameTypeDescription
preserve_lengthbool

TransformPhoneNumber

NameTypeDescription
preserve_lengthbool

TransformString

NameTypeDescription
preserve_lengthbool

TransformerConfig

NameTypeDescription
generate_email_configGenerateEmail
transform_email_configTransformEmail
generate_bool_configGenerateBool
generate_card_number_configGenerateCardNumber
generate_city_configGenerateCity
generate_e164_phone_number_configGenerateE164PhoneNumber
generate_first_name_configGenerateFirstName
generate_float64_configGenerateFloat64
generate_full_address_configGenerateFullAddress
generate_full_name_configGenerateFullName
generate_gender_configGenerateGender
generate_int64_phone_number_configGenerateInt64PhoneNumber
generate_int64_configGenerateInt64
generate_last_name_configGenerateLastName
generate_sha256hash_configGenerateSha256Hash
generate_ssn_configGenerateSSN
generate_state_configGenerateState
generate_street_address_configGenerateStreetAddress
generate_string_phone_number_configGenerateStringPhoneNumber
generate_string_configGenerateString
generate_unixtimestamp_configGenerateUnixTimestamp
generate_username_configGenerateUsername
generate_utctimestamp_configGenerateUtcTimestamp
generate_uuid_configGenerateUuid
generate_zipcode_configGenerateZipcode
transform_e164_phone_number_configTransformE164PhoneNumber
transform_first_name_configTransformFirstName
transform_float64_configTransformFloat64
transform_full_name_configTransformFullName
transform_int64_phone_number_configTransformInt64PhoneNumber
transform_int64_configTransformInt64
transform_last_name_configTransformLastName
transform_phone_number_configTransformPhoneNumber
transform_string_configTransformString
passthrough_configPassthrough
nullconfigNull
user_defined_transformer_configUserDefinedTransformerConfig
generate_default_configGenerateDefault
transform_javascript_configTransformJavascript
generate_categorical_configGenerateCategorical
transform_character_scramble_configTransformCharacterScramble
generate_javascript_configGenerateJavascript
generate_country_configGenerateCountry

UpdateUserDefinedTransformerRequest

NameTypeDescription
transformer_idstring
namestring
descriptionstring
transformer_configTransformerConfig

UpdateUserDefinedTransformerResponse

NameTypeDescription
transformerUserDefinedTransformer

UserDefinedTransformer

NameTypeDescription
idstring
namestring
descriptionstring
data_typeTransformerDataTypeThis property is readonly and is calculated based off the origin system transformer
sourceTransformerSource
configTransformerConfig
created_atgoogle.protobuf.Timestamp
updated_atgoogle.protobuf.Timestamp
account_idstring
data_typesrepeated TransformerDataType

UserDefinedTransformerConfig

NameTypeDescription
idstring

ValidateUserJavascriptCodeRequest

NameTypeDescription
account_idstring@deprecated - an account isn't required to validate js code
codestring

ValidateUserJavascriptCodeResponse

NameTypeDescription
validbool

ValidateUserRegexCodeRequest

NameTypeDescription
account_idstring@deprecated - an account isn't required to validate js code
user_provided_regexstring

ValidateUserRegexCodeResponse

NameTypeDescription
validbool

Enums

GenerateEmailType

NameNumberDescription
GENERATE_EMAIL_TYPE_UNSPECIFIED0Unspecified defaults to uuid v4
GENERATE_EMAIL_TYPE_UUID_V41Generates a random uuid v4 (without hyphens) on the left side of the @. This has all the uniqueness guarantees of the standard uuid v4, along with randomized domains.
GENERATE_EMAIL_TYPE_FULLNAME2Generates a full name (firstnamelastname) on the left side of the @. This has high cardinality but is not guaranteed to be unique.

InvalidEmailAction

Action enumeration that dictates what the transform_email transformer should do in the case that it encounters an email that does not conform to RFC 5322

NameNumberDescription
INVALID_EMAIL_ACTION_UNSPECIFIED0Unspecified defaults to reject.
INVALID_EMAIL_ACTION_REJECT1If an invalid email is encountered, the transformer will reject the transformation and exit.
INVALID_EMAIL_ACTION_NULL2The result of the email will be null. This should only be specified if the destination column is also nullable.
INVALID_EMAIL_ACTION_PASSTHROUGH3The result of the email will be identical to the original value, unmodified.
INVALID_EMAIL_ACTION_GENERATE4The result of the email will be a brand new generated email. This is the same result as the generate_email transformer.

SupportedJobType

NameNumberDescription
SUPPORTED_JOB_TYPE_UNSPECIFIED0
SUPPORTED_JOB_TYPE_SYNC1
SUPPORTED_JOB_TYPE_GENERATE2

TransformerDataType

NameNumberDescription
TRANSFORMER_DATA_TYPE_UNSPECIFIED0
TRANSFORMER_DATA_TYPE_STRING1
TRANSFORMER_DATA_TYPE_INT642
TRANSFORMER_DATA_TYPE_BOOLEAN3
TRANSFORMER_DATA_TYPE_FLOAT644
TRANSFORMER_DATA_TYPE_NULL5
TRANSFORMER_DATA_TYPE_ANY6
TRANSFORMER_DATA_TYPE_TIME7
TRANSFORMER_DATA_TYPE_UUID8

TransformerSource

NameNumberDescription
TRANSFORMER_SOURCE_UNSPECIFIED0
TRANSFORMER_SOURCE_PASSTHROUGH1
TRANSFORMER_SOURCE_GENERATE_DEFAULT2
TRANSFORMER_SOURCE_TRANSFORM_JAVASCRIPT3
TRANSFORMER_SOURCE_GENERATE_EMAIL4
TRANSFORMER_SOURCE_TRANSFORM_EMAIL5
TRANSFORMER_SOURCE_GENERATE_BOOL6
TRANSFORMER_SOURCE_GENERATE_CARD_NUMBER7
TRANSFORMER_SOURCE_GENERATE_CITY8
TRANSFORMER_SOURCE_GENERATE_E164_PHONE_NUMBER9
TRANSFORMER_SOURCE_GENERATE_FIRST_NAME10
TRANSFORMER_SOURCE_GENERATE_FLOAT6411
TRANSFORMER_SOURCE_GENERATE_FULL_ADDRESS12
TRANSFORMER_SOURCE_GENERATE_FULL_NAME13
TRANSFORMER_SOURCE_GENERATE_GENDER14
TRANSFORMER_SOURCE_GENERATE_INT64_PHONE_NUMBER15
TRANSFORMER_SOURCE_GENERATE_INT6416
TRANSFORMER_SOURCE_GENERATE_RANDOM_INT6417
TRANSFORMER_SOURCE_GENERATE_LAST_NAME18
TRANSFORMER_SOURCE_GENERATE_SHA256HASH19
TRANSFORMER_SOURCE_GENERATE_SSN20
TRANSFORMER_SOURCE_GENERATE_STATE21
TRANSFORMER_SOURCE_GENERATE_STREET_ADDRESS22
TRANSFORMER_SOURCE_GENERATE_STRING_PHONE_NUMBER23
TRANSFORMER_SOURCE_GENERATE_STRING24
TRANSFORMER_SOURCE_GENERATE_RANDOM_STRING25
TRANSFORMER_SOURCE_GENERATE_UNIXTIMESTAMP26
TRANSFORMER_SOURCE_GENERATE_USERNAME27
TRANSFORMER_SOURCE_GENERATE_UTCTIMESTAMP28
TRANSFORMER_SOURCE_GENERATE_UUID29
TRANSFORMER_SOURCE_GENERATE_ZIPCODE30
TRANSFORMER_SOURCE_TRANSFORM_E164_PHONE_NUMBER31
TRANSFORMER_SOURCE_TRANSFORM_FIRST_NAME32
TRANSFORMER_SOURCE_TRANSFORM_FLOAT6433
TRANSFORMER_SOURCE_TRANSFORM_FULL_NAME34
TRANSFORMER_SOURCE_TRANSFORM_INT64_PHONE_NUMBER35
TRANSFORMER_SOURCE_TRANSFORM_INT6436
TRANSFORMER_SOURCE_TRANSFORM_LAST_NAME37
TRANSFORMER_SOURCE_TRANSFORM_PHONE_NUMBER38
TRANSFORMER_SOURCE_TRANSFORM_STRING39
TRANSFORMER_SOURCE_GENERATE_NULL40
TRANSFORMER_SOURCE_GENERATE_CATEGORICAL42
TRANSFORMER_SOURCE_TRANSFORM_CHARACTER_SCRAMBLE43
TRANSFORMER_SOURCE_USER_DEFINED44
TRANSFORMER_SOURCE_GENERATE_JAVASCRIPT45
TRANSFORMER_SOURCE_GENERATE_COUNTRY46

Services

TransformersService

GetSystemTransformers

MethodGetSystemTransformers
RequestGetSystemTransformersRequest
ResponseGetSystemTransformersResponse
Description

GetSystemTransformerBySource

MethodGetSystemTransformerBySource
RequestGetSystemTransformerBySourceRequest
ResponseGetSystemTransformerBySourceResponse
Description

GetUserDefinedTransformers

MethodGetUserDefinedTransformers
RequestGetUserDefinedTransformersRequest
ResponseGetUserDefinedTransformersResponse
Description

GetUserDefinedTransformerById

MethodGetUserDefinedTransformerById
RequestGetUserDefinedTransformerByIdRequest
ResponseGetUserDefinedTransformerByIdResponse
Description

CreateUserDefinedTransformer

MethodCreateUserDefinedTransformer
RequestCreateUserDefinedTransformerRequest
ResponseCreateUserDefinedTransformerResponse
Description

DeleteUserDefinedTransformer

MethodDeleteUserDefinedTransformer
RequestDeleteUserDefinedTransformerRequest
ResponseDeleteUserDefinedTransformerResponse
Description

UpdateUserDefinedTransformer

MethodUpdateUserDefinedTransformer
RequestUpdateUserDefinedTransformerRequest
ResponseUpdateUserDefinedTransformerResponse
Description

IsTransformerNameAvailable

MethodIsTransformerNameAvailable
RequestIsTransformerNameAvailableRequest
ResponseIsTransformerNameAvailableResponse
Description

ValidateUserJavascriptCode

MethodValidateUserJavascriptCode
RequestValidateUserJavascriptCodeRequest
ResponseValidateUserJavascriptCodeResponse
Description

ValidateUserRegexCode

MethodValidateUserRegexCode
RequestValidateUserRegexCodeRequest
ResponseValidateUserRegexCodeResponse
Description