extensionv1beta1

Documentation

Index

• Variables
• type MessageConstraints
  • func (*MessageConstraints) Descriptor() ([]byte, []int)
  • func (x *MessageConstraints) GetNoSideEffectsOnly() bool
  • func (x *MessageConstraints) GetRequestOnly() bool
  • func (x *MessageConstraints) GetResponseOnly() bool
  • func (*MessageConstraints) ProtoMessage()
  • func (x *MessageConstraints) ProtoReflect() protoreflect.Message
  • func (x *MessageConstraints) Reset()
  • func (x *MessageConstraints) String() string

Variables

var (
	// Constraints on a message.
	//
	// Prototyping for now - we will want to change this to a number in Buf's reserved range if
	// this goes further.
	//
	// optional buf.registry.priv.extension.v1beta1.MessageConstraints message = 89181;
	E_Message = &file_buf_registry_priv_extension_v1beta1_extension_proto_extTypes[0]
)

Extension fields to descriptorpb.MessageOptions.

var File_buf_registry_priv_extension_v1beta1_extension_proto protoreflect.FileDescriptor

Types

type MessageConstraints

type MessageConstraints struct {

	// The given message should only be recursively used as part of RPC requests and should
	// never be part of an RPC response.
	//
	// This is not just for request/response messages, this is also for any message that
	// is part of a request. It says that the message cannot form part of a response.
	//
	// This applies to all nested messages within the message that are marked as request_only.
	//
	// Exclusive with response_only.
	//
	// TODO: Also have a marker for specific request/response messages?
	// TODO: enum?
	RequestOnly bool `protobuf:"varint,1,opt,name=request_only,json=requestOnly,proto3" json:"request_only,omitempty"`
	// The given message should only be recursively used as part of RPC responses and should
	// never be part of an RPC request.
	//
	// This is not just for request/response messages, this is also for any message that
	// is part of a response. It says that the message cannot form part of a request.
	//
	// This applies to all nested messages within the message that are marked as response_only.
	//
	// Exclusive with request_only.
	//
	// TODO: Also have a marker for specific request/response messages?
	// TODO: enum?
	ResponseOnly bool `protobuf:"varint,2,opt,name=response_only,json=responseOnly,proto3" json:"response_only,omitempty"`
	// The given message should only be recursively used as part of RPCs that are marked
	// as NO_SIDE_EFFECTS. Typically used to denote that a message should
	// only be used in read-only contexts.
	//
	// This applies to all nested messages within the message that are marked as no_side_effects_only.
	//
	// This is not just for request/response messages, this is also for any message that
	// is part of an RPC.
	NoSideEffectsOnly bool `protobuf:"varint,3,opt,name=no_side_effects_only,json=noSideEffectsOnly,proto3" json:"no_side_effects_only,omitempty"`
	// contains filtered or unexported fields
}

Constraints on a message.

func (*MessageConstraints) Descriptor

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

Deprecated: Use MessageConstraints.ProtoReflect.Descriptor instead.

func (*MessageConstraints) GetNoSideEffectsOnly

func (x *MessageConstraints) GetNoSideEffectsOnly() bool

func (*MessageConstraints) GetRequestOnly

func (x *MessageConstraints) GetRequestOnly() bool

func (*MessageConstraints) GetResponseOnly

func (x *MessageConstraints) GetResponseOnly() bool

func (*MessageConstraints) ProtoMessage

func (*MessageConstraints) ProtoMessage()

func (*MessageConstraints) ProtoReflect

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

func (*MessageConstraints) Reset

func (x *MessageConstraints) Reset()

func (*MessageConstraints) String

func (x *MessageConstraints) String() string