options

package
v1.14.0 Latest Latest
Warning

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

Go to latest
Published: Mar 27, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// Whether field is optional in Trinsic's backend.
	// This is not the same as an `optional` protobuf label;
	// it only impacts documentation generation for the field.
	//
	// optional bool optional = 60000;
	E_Optional = &file_services_options_field_options_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// optional services.options.SdkTemplateOption sdk_template_option = 60001;
	E_SdkTemplateOption = &file_services_options_field_options_proto_extTypes[1]
)

Extension fields to descriptorpb.MethodOptions.

View Source
var File_services_options_field_options_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AnnotationOption added in v1.9.0

type AnnotationOption struct {

	// Is this annotation active
	Active bool `protobuf:"varint,1,opt,name=active,proto3" json:"active,omitempty"`
	// Custom annotation message to provide
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*AnnotationOption) Descriptor deprecated added in v1.9.0

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

Deprecated: Use AnnotationOption.ProtoReflect.Descriptor instead.

func (*AnnotationOption) GetActive added in v1.9.0

func (x *AnnotationOption) GetActive() bool

func (*AnnotationOption) GetMessage added in v1.9.0

func (x *AnnotationOption) GetMessage() string

func (*AnnotationOption) ProtoMessage added in v1.9.0

func (*AnnotationOption) ProtoMessage()

func (*AnnotationOption) ProtoReflect added in v1.9.0

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

func (*AnnotationOption) Reset added in v1.9.0

func (x *AnnotationOption) Reset()

func (*AnnotationOption) String added in v1.9.0

func (x *AnnotationOption) String() string

type SdkTemplateOption

type SdkTemplateOption struct {

	// Whether the service endpoint allows anonymous (no auth token necessary) authentication
	// This is used by the `protoc-gen-trinsic-sdk` plugin for metadata.
	Anonymous bool `protobuf:"varint,1,opt,name=anonymous,proto3" json:"anonymous,omitempty"`
	// Whether the SDK template generator should ignore this method. This method will
	// be wrapped manually.
	Ignore bool `protobuf:"varint,2,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// Whether the SDK template generator should generate this method without arguments, eg
	// ProviderService.GetEcosystemInfo() where the request object is empty
	NoArguments bool `protobuf:"varint,3,opt,name=no_arguments,json=noArguments,proto3" json:"no_arguments,omitempty"`
	// This endpoint is experimental. Consider it in beta, so documentation may be incomplete or incorrect.
	Experimental *AnnotationOption `protobuf:"bytes,4,opt,name=experimental,proto3" json:"experimental,omitempty"`
	// This endpoint is deprecated. It will be removed in the future.
	Deprecated *AnnotationOption `protobuf:"bytes,5,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	// contains filtered or unexported fields
}

func (*SdkTemplateOption) Descriptor deprecated

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

Deprecated: Use SdkTemplateOption.ProtoReflect.Descriptor instead.

func (*SdkTemplateOption) GetAnonymous

func (x *SdkTemplateOption) GetAnonymous() bool

func (*SdkTemplateOption) GetDeprecated added in v1.9.0

func (x *SdkTemplateOption) GetDeprecated() *AnnotationOption

func (*SdkTemplateOption) GetExperimental added in v1.9.0

func (x *SdkTemplateOption) GetExperimental() *AnnotationOption

func (*SdkTemplateOption) GetIgnore

func (x *SdkTemplateOption) GetIgnore() bool

func (*SdkTemplateOption) GetNoArguments added in v1.8.0

func (x *SdkTemplateOption) GetNoArguments() bool

func (*SdkTemplateOption) ProtoMessage

func (*SdkTemplateOption) ProtoMessage()

func (*SdkTemplateOption) ProtoReflect

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

func (*SdkTemplateOption) Reset

func (x *SdkTemplateOption) Reset()

func (*SdkTemplateOption) String

func (x *SdkTemplateOption) String() string

Jump to

Keyboard shortcuts

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