options

Documentation

Index

• Variables
• type Sensitive
  • func (*Sensitive) Descriptor() ([]byte, []int)
  • func (x *Sensitive) GetEncrypt() bool
  • func (m *Sensitive) GetLogAction() isSensitive_LogAction
  • func (x *Sensitive) GetMask() bool
  • func (x *Sensitive) GetObfuscate() bool
  • func (x *Sensitive) GetPii() bool
  • func (x *Sensitive) GetRedact() bool
  • func (*Sensitive) ProtoMessage()
  • func (x *Sensitive) ProtoReflect() protoreflect.Message
  • func (x *Sensitive) Reset()
  • func (x *Sensitive) String() string
• type Sensitive_Mask
• type Sensitive_Obfuscate
• type Sensitive_Redact

Variables

var (
	// When set to true, `sensitive` indicates that this field contains sensitive data, such as
	// personally identifiable information, passwords, or private keys, and should be redacted for
	// display by tools aware of this annotation. Note that that this has no effect on standard
	// Protobuf functions such as `TextFormat::PrintToString`.
	//
	// # For example this to be used as below
	//
	//	message SensitiveTestData {
	//	   string name = 1 [(options.sensitive).mask = true];
	//	   string secret = 2 [(options.sensitive).encrypt = true];
	//	 }
	//
	// optional options.Sensitive sensitive = 50003;
	E_Sensitive = &file_options_log_options_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

var File_options_log_options_proto protoreflect.FileDescriptor

Types

type Sensitive

type Sensitive struct {

	// Types that are assignable to LogAction:
	//
	//	*Sensitive_Redact
	//	*Sensitive_Mask
	//	*Sensitive_Obfuscate
	LogAction isSensitive_LogAction `protobuf_oneof:"log_action"`
	// Indicates to encrypt the data while storing in permanent storage
	// Note, this will also apply to the logging of the element
	Encrypt bool `protobuf:"varint,4,opt,name=encrypt,proto3" json:"encrypt,omitempty"`
	// Indicates the field is a PII, field with this option will
	// expect the data to be encrypted and not logged in plain text
	Pii bool `protobuf:"varint,5,opt,name=pii,proto3" json:"pii,omitempty"`
	// contains filtered or unexported fields
}

func (*Sensitive) Descriptor

func (*Sensitive) Descriptor() ([]byte, []int)

Deprecated: Use Sensitive.ProtoReflect.Descriptor instead.

func (*Sensitive) GetEncrypt

func (x *Sensitive) GetEncrypt() bool

func (*Sensitive) GetLogAction

func (m *Sensitive) GetLogAction() isSensitive_LogAction

func (*Sensitive) GetMask

func (x *Sensitive) GetMask() bool

func (*Sensitive) GetObfuscate

func (x *Sensitive) GetObfuscate() bool

func (*Sensitive) GetPii

func (x *Sensitive) GetPii() bool

func (*Sensitive) GetRedact

func (x *Sensitive) GetRedact() bool

func (*Sensitive) ProtoMessage

func (*Sensitive) ProtoMessage()

func (*Sensitive) ProtoReflect

func (x *Sensitive) ProtoReflect() protoreflect.Message

func (*Sensitive) Reset

func (x *Sensitive) Reset()

func (*Sensitive) String

func (x *Sensitive) String() string

type Sensitive_Mask

type Sensitive_Mask struct {
	// Indicates to mask the data while logging
	Mask bool `protobuf:"varint,2,opt,name=mask,proto3,oneof"`
}

type Sensitive_Obfuscate

type Sensitive_Obfuscate struct {
	// Indicates to obfuscate the data while logging
	Obfuscate bool `protobuf:"varint,3,opt,name=obfuscate,proto3,oneof"` // Indicates whether data is PII or not
}

type Sensitive_Redact

type Sensitive_Redact struct {
	// Indicates to clear the data while logging
	Redact bool `protobuf:"varint,1,opt,name=redact,proto3,oneof"`
}