annotationsv3

package
v1.33.0-20240422202033... 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: 37

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 xds.annotations.v3.MigrateAnnotation enum_migrate = 112948430;
	E_EnumMigrate = &file_xds_annotations_v3_migrate_proto_extTypes[2]
)

Extension fields to descriptorpb.EnumOptions.

View Source
var (
	// optional xds.annotations.v3.MigrateAnnotation enum_value_migrate = 112948430;
	E_EnumValueMigrate = &file_xds_annotations_v3_migrate_proto_extTypes[3]
)

Extension fields to descriptorpb.EnumValueOptions.

View Source
var (
	// optional xds.annotations.v3.FieldMigrateAnnotation field_migrate = 112948430;
	E_FieldMigrate = &file_xds_annotations_v3_migrate_proto_extTypes[1]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// optional xds.annotations.v3.FieldStatusAnnotation field_status = 226829418;
	E_FieldStatus = &file_xds_annotations_v3_status_proto_extTypes[2]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// optional xds.annotations.v3.FileMigrateAnnotation file_migrate = 112948430;
	E_FileMigrate = &file_xds_annotations_v3_migrate_proto_extTypes[4]
)

Extension fields to descriptorpb.FileOptions.

View Source
var (
	// optional xds.annotations.v3.FileStatusAnnotation file_status = 226829418;
	E_FileStatus = &file_xds_annotations_v3_status_proto_extTypes[0]
)

Extension fields to descriptorpb.FileOptions.

View Source
var (
	// optional xds.annotations.v3.MigrateAnnotation message_migrate = 112948430;
	E_MessageMigrate = &file_xds_annotations_v3_migrate_proto_extTypes[0]
)

Extension fields to descriptorpb.MessageOptions.

View Source
var (
	// optional xds.annotations.v3.MessageStatusAnnotation message_status = 226829418;
	E_MessageStatus = &file_xds_annotations_v3_status_proto_extTypes[1]
)

Extension fields to descriptorpb.MessageOptions.

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

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// Magic number is the 28 most significant bits in the sha256sum of "xds.annotations.v3.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 = 61008053;
	E_Sensitive = &file_xds_annotations_v3_sensitive_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// Magic number is the 28 most significant bits in the sha256sum of
	// "xds.annotations.v3.versioning".
	//
	// optional xds.annotations.v3.VersioningAnnotation versioning = 92389011;
	E_Versioning = &file_xds_annotations_v3_versioning_proto_extTypes[0]
)

Extension fields to descriptorpb.MessageOptions.

View Source
var File_xds_annotations_v3_migrate_proto protoreflect.FileDescriptor
View Source
var File_xds_annotations_v3_security_proto protoreflect.FileDescriptor
View Source
var File_xds_annotations_v3_sensitive_proto protoreflect.FileDescriptor
View Source
var File_xds_annotations_v3_status_proto protoreflect.FileDescriptor
View Source
var File_xds_annotations_v3_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 FieldStatusAnnotation

type FieldStatusAnnotation 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"`
	// contains filtered or unexported fields
}

func (*FieldStatusAnnotation) Descriptor deprecated

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

Deprecated: Use FieldStatusAnnotation.ProtoReflect.Descriptor instead.

func (*FieldStatusAnnotation) GetWorkInProgress

func (x *FieldStatusAnnotation) GetWorkInProgress() bool

func (*FieldStatusAnnotation) ProtoMessage

func (*FieldStatusAnnotation) ProtoMessage()

func (*FieldStatusAnnotation) ProtoReflect

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

func (*FieldStatusAnnotation) Reset

func (x *FieldStatusAnnotation) Reset()

func (*FieldStatusAnnotation) String

func (x *FieldStatusAnnotation) 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 FileStatusAnnotation

type FileStatusAnnotation 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"`
	// contains filtered or unexported fields
}

func (*FileStatusAnnotation) Descriptor deprecated

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

Deprecated: Use FileStatusAnnotation.ProtoReflect.Descriptor instead.

func (*FileStatusAnnotation) GetWorkInProgress

func (x *FileStatusAnnotation) GetWorkInProgress() bool

func (*FileStatusAnnotation) ProtoMessage

func (*FileStatusAnnotation) ProtoMessage()

func (*FileStatusAnnotation) ProtoReflect

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

func (*FileStatusAnnotation) Reset

func (x *FileStatusAnnotation) Reset()

func (*FileStatusAnnotation) String

func (x *FileStatusAnnotation) String() string

type MessageStatusAnnotation

type MessageStatusAnnotation 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"`
	// contains filtered or unexported fields
}

func (*MessageStatusAnnotation) Descriptor deprecated

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

Deprecated: Use MessageStatusAnnotation.ProtoReflect.Descriptor instead.

func (*MessageStatusAnnotation) GetWorkInProgress

func (x *MessageStatusAnnotation) GetWorkInProgress() bool

func (*MessageStatusAnnotation) ProtoMessage

func (*MessageStatusAnnotation) ProtoMessage()

func (*MessageStatusAnnotation) ProtoReflect

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

func (*MessageStatusAnnotation) Reset

func (x *MessageStatusAnnotation) Reset()

func (*MessageStatusAnnotation) String

func (x *MessageStatusAnnotation) 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) Enum

func (PackageVersionStatus) EnumDescriptor deprecated

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

Deprecated: Use PackageVersionStatus.Descriptor instead.

func (PackageVersionStatus) Number

func (PackageVersionStatus) String

func (x PackageVersionStatus) String() string

func (PackageVersionStatus) Type

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 `` /* 169-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
	// xds.foo.v3alpha.Foo and it was previously xds.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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL