annotations

package
v1.34.2-20240724200539... Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: unknown License: Apache-2.0 Imports: 5 Imported by: 409

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	PackageVersionStatus_name = map[int32]string{
		0: "UNKNOWN",
		1: "FROZEN",
		2: "ACTIVE",
		3: "NEXT_MAJOR_VERSION_CANDIDATE",
	}
	PackageVersionStatus_value = map[string]int32{
		"UNKNOWN":                      0,
		"FROZEN":                       1,
		"ACTIVE":                       2,
		"NEXT_MAJOR_VERSION_CANDIDATE": 3,
	}
)

Enum value maps for PackageVersionStatus.

View Source 
var (
	// optional udpa.annotations.MigrateAnnotation enum_migrate = 171962766;
	E_EnumMigrate = &file_udpa_annotations_migrate_proto_extTypes[2]
)

Extension fields to descriptorpb.EnumOptions.

View Source 
var (
	// optional udpa.annotations.MigrateAnnotation enum_value_migrate = 171962766;
	E_EnumValueMigrate = &file_udpa_annotations_migrate_proto_extTypes[3]
)

Extension fields to descriptorpb.EnumValueOptions.

View Source 
var (
	// optional udpa.annotations.FieldMigrateAnnotation field_migrate = 171962766;
	E_FieldMigrate = &file_udpa_annotations_migrate_proto_extTypes[1]
)

Extension fields to descriptorpb.FieldOptions.

View Source 
var (
	// optional udpa.annotations.FileMigrateAnnotation file_migrate = 171962766;
	E_FileMigrate = &file_udpa_annotations_migrate_proto_extTypes[4]
)

Extension fields to descriptorpb.FileOptions.

View Source 
var (
	// optional udpa.annotations.StatusAnnotation file_status = 222707719;
	E_FileStatus = &file_udpa_annotations_status_proto_extTypes[0]
)

Extension fields to descriptorpb.FileOptions.

View Source 
var (
	// optional udpa.annotations.MigrateAnnotation message_migrate = 171962766;
	E_MessageMigrate = &file_udpa_annotations_migrate_proto_extTypes[0]
)

Extension fields to descriptorpb.MessageOptions.

View Source 
var (
	// Magic number is the 28 most significant bits in the sha256sum of
	// "udpa.annotations.security".
	//
	// optional udpa.annotations.FieldSecurityAnnotation security = 11122993;
	E_Security = &file_udpa_annotations_security_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

View Source 
var (
	// Magic number is the 28 most significant bits in the sha256sum of "udpa.annotations.sensitive".
	// 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`.
	//
	// optional bool sensitive = 76569463;
	E_Sensitive = &file_udpa_annotations_sensitive_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

View Source 
var (
	// Magic number derived from 0x78 ('x') 0x44 ('D') 0x53 ('S')
	//
	// optional udpa.annotations.VersioningAnnotation versioning = 7881811;
	E_Versioning = &file_udpa_annotations_versioning_proto_extTypes[0]
)

Extension fields to descriptorpb.MessageOptions.

View Source 
var File_udpa_annotations_migrate_proto protoreflect.FileDescriptor
View Source 
var File_udpa_annotations_security_proto protoreflect.FileDescriptor
View Source 
var File_udpa_annotations_sensitive_proto protoreflect.FileDescriptor
View Source 
var File_udpa_annotations_status_proto protoreflect.FileDescriptor
View Source 
var File_udpa_annotations_versioning_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type FieldMigrateAnnotation 

type FieldMigrateAnnotation struct {

	// Rename the field in next version.
	Rename string `protobuf:"bytes,1,opt,name=rename,proto3" json:"rename,omitempty"`
	// Add the field to a named oneof in next version. If this already exists, the
	// field will join its siblings under the oneof, otherwise a new oneof will be
	// created with the given name.
	OneofPromotion string `protobuf:"bytes,2,opt,name=oneof_promotion,json=oneofPromotion,proto3" json:"oneof_promotion,omitempty"`
	// contains filtered or unexported fields
}

func (*FieldMigrateAnnotation) Descriptor deprecated 

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

Deprecated: Use FieldMigrateAnnotation.ProtoReflect.Descriptor instead.

func (*FieldMigrateAnnotation) GetOneofPromotion 

func (x *FieldMigrateAnnotation) GetOneofPromotion() string

func (*FieldMigrateAnnotation) GetRename 

func (x *FieldMigrateAnnotation) GetRename() string

func (*FieldMigrateAnnotation) ProtoMessage 

func (*FieldMigrateAnnotation) ProtoMessage()

func (*FieldMigrateAnnotation) ProtoReflect 

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

func (*FieldMigrateAnnotation) Reset 

func (x *FieldMigrateAnnotation) Reset()

func (*FieldMigrateAnnotation) String 

func (x *FieldMigrateAnnotation) String() string

type FieldSecurityAnnotation 

type FieldSecurityAnnotation struct {

	// Field should be set in the presence of untrusted downstreams.
	ConfigureForUntrustedDownstream bool `` /* 159-byte string literal not displayed */
	// Field should be set in the presence of untrusted upstreams.
	ConfigureForUntrustedUpstream bool `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

These annotations indicate metadata for the purpose of understanding the security significance of fields.

func (*FieldSecurityAnnotation) Descriptor deprecated 

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

Deprecated: Use FieldSecurityAnnotation.ProtoReflect.Descriptor instead.

func (*FieldSecurityAnnotation) GetConfigureForUntrustedDownstream 

func (x *FieldSecurityAnnotation) GetConfigureForUntrustedDownstream() bool

func (*FieldSecurityAnnotation) GetConfigureForUntrustedUpstream 

func (x *FieldSecurityAnnotation) GetConfigureForUntrustedUpstream() bool

func (*FieldSecurityAnnotation) ProtoMessage 

func (*FieldSecurityAnnotation) ProtoMessage()

func (*FieldSecurityAnnotation) ProtoReflect 

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

func (*FieldSecurityAnnotation) Reset 

func (x *FieldSecurityAnnotation) Reset()

func (*FieldSecurityAnnotation) String 

func (x *FieldSecurityAnnotation) String() string

type FileMigrateAnnotation 

type FileMigrateAnnotation struct {

	// Move all types in the file to another package, this implies changing proto
	// file path.
	MoveToPackage string `protobuf:"bytes,2,opt,name=move_to_package,json=moveToPackage,proto3" json:"move_to_package,omitempty"`
	// contains filtered or unexported fields
}

func (*FileMigrateAnnotation) Descriptor deprecated 

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

Deprecated: Use FileMigrateAnnotation.ProtoReflect.Descriptor instead.

func (*FileMigrateAnnotation) GetMoveToPackage 

func (x *FileMigrateAnnotation) GetMoveToPackage() string

func (*FileMigrateAnnotation) ProtoMessage 

func (*FileMigrateAnnotation) ProtoMessage()

func (*FileMigrateAnnotation) ProtoReflect 

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

func (*FileMigrateAnnotation) Reset 

func (x *FileMigrateAnnotation) Reset()

func (*FileMigrateAnnotation) String 

func (x *FileMigrateAnnotation) String() string

type MigrateAnnotation 

type MigrateAnnotation struct {

	// Rename the message/enum/enum value in next version.
	Rename string `protobuf:"bytes,1,opt,name=rename,proto3" json:"rename,omitempty"`
	// contains filtered or unexported fields
}

func (*MigrateAnnotation) Descriptor deprecated 

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

Deprecated: Use MigrateAnnotation.ProtoReflect.Descriptor instead.

func (*MigrateAnnotation) GetRename 

func (x *MigrateAnnotation) GetRename() string

func (*MigrateAnnotation) ProtoMessage 

func (*MigrateAnnotation) ProtoMessage()

func (*MigrateAnnotation) ProtoReflect 

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

func (*MigrateAnnotation) Reset 

func (x *MigrateAnnotation) Reset()

func (*MigrateAnnotation) String 

func (x *MigrateAnnotation) String() string

type PackageVersionStatus 

type PackageVersionStatus int32
const (
	// Unknown package version status.
	PackageVersionStatus_UNKNOWN PackageVersionStatus = 0
	// This version of the package is frozen.
	PackageVersionStatus_FROZEN PackageVersionStatus = 1
	// This version of the package is the active development version.
	PackageVersionStatus_ACTIVE PackageVersionStatus = 2
	// This version of the package is the candidate for the next major version. It
	// is typically machine generated from the active development version.
	PackageVersionStatus_NEXT_MAJOR_VERSION_CANDIDATE PackageVersionStatus = 3
)

func (PackageVersionStatus) Descriptor 

func (PackageVersionStatus) Descriptor() protoreflect.EnumDescriptor

func (PackageVersionStatus) Enum 

func (x PackageVersionStatus) Enum() *PackageVersionStatus

func (PackageVersionStatus) EnumDescriptor deprecated 

func (PackageVersionStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use PackageVersionStatus.Descriptor instead.

func (PackageVersionStatus) Number 

func (x PackageVersionStatus) Number() protoreflect.EnumNumber

func (PackageVersionStatus) String 

func (x PackageVersionStatus) String() string

func (PackageVersionStatus) Type 

func (PackageVersionStatus) Type() protoreflect.EnumType

type StatusAnnotation 

type StatusAnnotation struct {

	// The entity is work-in-progress and subject to breaking changes.
	WorkInProgress bool `protobuf:"varint,1,opt,name=work_in_progress,json=workInProgress,proto3" json:"work_in_progress,omitempty"`
	// The entity belongs to a package with the given version status.
	PackageVersionStatus PackageVersionStatus `` /* 167-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*StatusAnnotation) Descriptor deprecated 

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

Deprecated: Use StatusAnnotation.ProtoReflect.Descriptor instead.

func (*StatusAnnotation) GetPackageVersionStatus 

func (x *StatusAnnotation) GetPackageVersionStatus() PackageVersionStatus

func (*StatusAnnotation) GetWorkInProgress 

func (x *StatusAnnotation) GetWorkInProgress() bool

func (*StatusAnnotation) ProtoMessage 

func (*StatusAnnotation) ProtoMessage()

func (*StatusAnnotation) ProtoReflect 

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

func (*StatusAnnotation) Reset 

func (x *StatusAnnotation) Reset()

func (*StatusAnnotation) String 

func (x *StatusAnnotation) String() string

type VersioningAnnotation 

type VersioningAnnotation struct {

	// Track the previous message type. E.g. this message might be
	// udpa.foo.v3alpha.Foo and it was previously udpa.bar.v2.Bar. This
	// information is consumed by UDPA via proto descriptors.
	PreviousMessageType string `protobuf:"bytes,1,opt,name=previous_message_type,json=previousMessageType,proto3" json:"previous_message_type,omitempty"`
	// contains filtered or unexported fields
}

func (*VersioningAnnotation) Descriptor deprecated 

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

Deprecated: Use VersioningAnnotation.ProtoReflect.Descriptor instead.

func (*VersioningAnnotation) GetPreviousMessageType 

func (x *VersioningAnnotation) GetPreviousMessageType() string

func (*VersioningAnnotation) ProtoMessage 

func (*VersioningAnnotation) ProtoMessage()

func (*VersioningAnnotation) ProtoReflect 

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

func (*VersioningAnnotation) Reset 

func (x *VersioningAnnotation) Reset()

func (*VersioningAnnotation) String 

func (x *VersioningAnnotation) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.