spec_metadata

package
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 30, 2017 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package spec_metadata is a generated protocol buffer package.

It is generated from these files: 

spec_metadata/spec.proto

It has these top-level messages: 

FileSpec
ServiceSpec
ServiceMethodSpec
FileOption
ServiceOption
MethodOption
MessageOption
FieldOption
ExternalDocumentation

Index

Constants

View Source 
const Default_ServiceMethodSpec_HttpMethod string = "GET"

Variables

View Source 
var E_FieldOption = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.FieldOptions)(nil),
	ExtensionType: (*FieldOption)(nil),
	Field:         20171111,
	Name:          "qingcloud.api.spec_metadata.field_option",
	Tag:           "bytes,20171111,opt,name=field_option,json=fieldOption",
	Filename:      "spec_metadata/spec.proto",
}
View Source 
var E_FileOption = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.FileOptions)(nil),
	ExtensionType: (*FileOption)(nil),
	Field:         20171111,
	Name:          "qingcloud.api.spec_metadata.file_option",
	Tag:           "bytes,20171111,opt,name=file_option,json=fileOption",
	Filename:      "spec_metadata/spec.proto",
}
View Source 
var E_MessageOption = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.MessageOptions)(nil),
	ExtensionType: (*MessageOption)(nil),
	Field:         20171111,
	Name:          "qingcloud.api.spec_metadata.message_option",
	Tag:           "bytes,20171111,opt,name=message_option,json=messageOption",
	Filename:      "spec_metadata/spec.proto",
}
View Source 
var E_MethodOption = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.MethodOptions)(nil),
	ExtensionType: (*MethodOption)(nil),
	Field:         20171111,
	Name:          "qingcloud.api.spec_metadata.method_option",
	Tag:           "bytes,20171111,opt,name=method_option,json=methodOption",
	Filename:      "spec_metadata/spec.proto",
}
View Source 
var E_ServiceOption = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.ServiceOptions)(nil),
	ExtensionType: (*ServiceOption)(nil),
	Field:         20171111,
	Name:          "qingcloud.api.spec_metadata.service_option",
	Tag:           "bytes,20171111,opt,name=service_option,json=serviceOption",
	Filename:      "spec_metadata/spec.proto",
}

Functions

This section is empty.

Types

type ExternalDocumentation 

type ExternalDocumentation struct {
	Title            *string `protobuf:"bytes,1,opt,name=title" json:"title,omitempty"`
	Description      *string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
	Url              *string `protobuf:"bytes,3,opt,name=url" json:"url,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

扩展文档

func (*ExternalDocumentation) Descriptor 

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

func (*ExternalDocumentation) GetDescription 

func (m *ExternalDocumentation) GetDescription() string

func (*ExternalDocumentation) GetTitle 

func (m *ExternalDocumentation) GetTitle() string

func (*ExternalDocumentation) GetUrl 

func (m *ExternalDocumentation) GetUrl() string

func (*ExternalDocumentation) ProtoMessage 

func (*ExternalDocumentation) ProtoMessage()

func (*ExternalDocumentation) Reset 

func (m *ExternalDocumentation) Reset()

func (*ExternalDocumentation) String 

func (m *ExternalDocumentation) String() string

type FieldOption 

type FieldOption struct {
	MinValue          *float64               `protobuf:"fixed64,1,opt,name=min_value,json=minValue" json:"min_value,omitempty"`
	MaxValue          *float64               `protobuf:"fixed64,2,opt,name=max_value,json=maxValue" json:"max_value,omitempty"`
	MultipleOfValue   *float64               `protobuf:"fixed64,3,opt,name=multiple_of_value,json=multipleOfValue" json:"multiple_of_value,omitempty"`
	ExclusiveMinValue *float64               `protobuf:"fixed64,4,opt,name=exclusive_min_value,json=exclusiveMinValue" json:"exclusive_min_value,omitempty"`
	ExclusiveMaxValue *float64               `protobuf:"fixed64,5,opt,name=exclusive_max_value,json=exclusiveMaxValue" json:"exclusive_max_value,omitempty"`
	MinLength         *int32                 `protobuf:"varint,6,opt,name=min_length,json=minLength" json:"min_length,omitempty"`
	MaxLength         *int32                 `protobuf:"varint,7,opt,name=max_length,json=maxLength" json:"max_length,omitempty"`
	RegexpValue       *string                `protobuf:"bytes,8,opt,name=regexp_value,json=regexpValue" json:"regexp_value,omitempty"`
	EnumValue         []string               `protobuf:"bytes,9,rep,name=enum_value,json=enumValue" json:"enum_value,omitempty"`
	ExternalDocs      *ExternalDocumentation `protobuf:"bytes,10,opt,name=external_docs,json=externalDocs" json:"external_docs,omitempty"`
	StructTag         *string                `protobuf:"bytes,11,opt,name=struct_tag,json=structTag" json:"struct_tag,omitempty"`
	XXX_unrecognized  []byte                 `json:"-"`
}

消息成员的扩展信息 这是重要信息, 在运行时可动态获取改信息对 message 做合法性验证

func (*FieldOption) Descriptor 

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

func (*FieldOption) GetEnumValue 

func (m *FieldOption) GetEnumValue() []string

func (*FieldOption) GetExclusiveMaxValue 

func (m *FieldOption) GetExclusiveMaxValue() float64

func (*FieldOption) GetExclusiveMinValue 

func (m *FieldOption) GetExclusiveMinValue() float64

func (*FieldOption) GetExternalDocs 

func (m *FieldOption) GetExternalDocs() *ExternalDocumentation

func (*FieldOption) GetMaxLength 

func (m *FieldOption) GetMaxLength() int32

func (*FieldOption) GetMaxValue 

func (m *FieldOption) GetMaxValue() float64

func (*FieldOption) GetMinLength 

func (m *FieldOption) GetMinLength() int32

func (*FieldOption) GetMinValue 

func (m *FieldOption) GetMinValue() float64

func (*FieldOption) GetMultipleOfValue 

func (m *FieldOption) GetMultipleOfValue() float64

func (*FieldOption) GetRegexpValue 

func (m *FieldOption) GetRegexpValue() string

func (*FieldOption) GetStructTag 

func (m *FieldOption) GetStructTag() string

func (*FieldOption) ProtoMessage 

func (*FieldOption) ProtoMessage()

func (*FieldOption) Reset 

func (m *FieldOption) Reset()

func (*FieldOption) String 

func (m *FieldOption) String() string

type FileOption 

type FileOption struct {
	ExternalDocs     *ExternalDocumentation `protobuf:"bytes,1,opt,name=external_docs,json=externalDocs" json:"external_docs,omitempty"`
	XXX_unrecognized []byte                 `json:"-"`
}

文件的扩展信息

func (*FileOption) Descriptor 

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

func (*FileOption) GetExternalDocs 

func (m *FileOption) GetExternalDocs() *ExternalDocumentation

func (*FileOption) ProtoMessage 

func (*FileOption) ProtoMessage()

func (*FileOption) Reset 

func (m *FileOption) Reset()

func (*FileOption) String 

func (m *FileOption) String() string

type FileSpec 

type FileSpec struct {
	FileName         *string                `protobuf:"bytes,1,req,name=file_name,json=fileName" json:"file_name,omitempty"`
	PackageName      *string                `protobuf:"bytes,2,req,name=package_name,json=packageName" json:"package_name,omitempty"`
	ExternalDocs     *ExternalDocumentation `protobuf:"bytes,3,opt,name=external_docs,json=externalDocs" json:"external_docs,omitempty"`
	XXX_unrecognized []byte                 `json:"-"`
}

proto 文件信息

func (*FileSpec) Descriptor 

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

func (*FileSpec) GetExternalDocs 

func (m *FileSpec) GetExternalDocs() *ExternalDocumentation

func (*FileSpec) GetFileName 

func (m *FileSpec) GetFileName() string

func (*FileSpec) GetPackageName 

func (m *FileSpec) GetPackageName() string

func (*FileSpec) ProtoMessage 

func (*FileSpec) ProtoMessage()

func (*FileSpec) Reset 

func (m *FileSpec) Reset()

func (*FileSpec) String 

func (m *FileSpec) String() string

type MessageOption 

type MessageOption struct {
	ExternalDocs     *ExternalDocumentation `protobuf:"bytes,1,opt,name=external_docs,json=externalDocs" json:"external_docs,omitempty"`
	XXX_unrecognized []byte                 `json:"-"`
}

消息的扩展信息

func (*MessageOption) Descriptor 

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

func (*MessageOption) GetExternalDocs 

func (m *MessageOption) GetExternalDocs() *ExternalDocumentation

func (*MessageOption) ProtoMessage 

func (*MessageOption) ProtoMessage()

func (*MessageOption) Reset 

func (m *MessageOption) Reset()

func (*MessageOption) String 

func (m *MessageOption) String() string

type MethodOption 

type MethodOption struct {
	HttpMethod       *string                `protobuf:"bytes,1,opt,name=http_method,json=httpMethod" json:"http_method,omitempty"`
	ExternalDocs     *ExternalDocumentation `protobuf:"bytes,2,opt,name=external_docs,json=externalDocs" json:"external_docs,omitempty"`
	XXX_unrecognized []byte                 `json:"-"`
}

服务方法的扩展信息

func (*MethodOption) Descriptor 

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

func (*MethodOption) GetExternalDocs 

func (m *MethodOption) GetExternalDocs() *ExternalDocumentation

func (*MethodOption) GetHttpMethod 

func (m *MethodOption) GetHttpMethod() string

func (*MethodOption) ProtoMessage 

func (*MethodOption) ProtoMessage()

func (*MethodOption) Reset 

func (m *MethodOption) Reset()

func (*MethodOption) String 

func (m *MethodOption) String() string

type ServiceMethodSpec 

type ServiceMethodSpec struct {
	MethodName       *string                `protobuf:"bytes,1,req,name=method_name,json=methodName" json:"method_name,omitempty"`
	InputTypeName    *string                `protobuf:"bytes,2,req,name=input_type_name,json=inputTypeName" json:"input_type_name,omitempty"`
	OutputTypeName   *string                `protobuf:"bytes,3,req,name=output_type_name,json=outputTypeName" json:"output_type_name,omitempty"`
	HttpMethod       *string                `protobuf:"bytes,4,opt,name=http_method,json=httpMethod,def=GET" json:"http_method,omitempty"`
	ExternalDocs     *ExternalDocumentation `protobuf:"bytes,5,opt,name=external_docs,json=externalDocs" json:"external_docs,omitempty"`
	XXX_unrecognized []byte                 `json:"-"`
}

服务方法列表

func (*ServiceMethodSpec) Descriptor 

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

func (*ServiceMethodSpec) GetExternalDocs 

func (m *ServiceMethodSpec) GetExternalDocs() *ExternalDocumentation

func (*ServiceMethodSpec) GetHttpMethod 

func (m *ServiceMethodSpec) GetHttpMethod() string

func (*ServiceMethodSpec) GetInputTypeName 

func (m *ServiceMethodSpec) GetInputTypeName() string

func (*ServiceMethodSpec) GetMethodName 

func (m *ServiceMethodSpec) GetMethodName() string

func (*ServiceMethodSpec) GetOutputTypeName 

func (m *ServiceMethodSpec) GetOutputTypeName() string

func (*ServiceMethodSpec) ProtoMessage 

func (*ServiceMethodSpec) ProtoMessage()

func (*ServiceMethodSpec) Reset 

func (m *ServiceMethodSpec) Reset()

func (*ServiceMethodSpec) String 

func (m *ServiceMethodSpec) String() string

type ServiceOption 

type ServiceOption struct {
	ExternalDocs     *ExternalDocumentation `protobuf:"bytes,3,opt,name=external_docs,json=externalDocs" json:"external_docs,omitempty"`
	XXX_unrecognized []byte                 `json:"-"`
}

服务的扩展信息

func (*ServiceOption) Descriptor 

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

func (*ServiceOption) GetExternalDocs 

func (m *ServiceOption) GetExternalDocs() *ExternalDocumentation

func (*ServiceOption) ProtoMessage 

func (*ServiceOption) ProtoMessage()

func (*ServiceOption) Reset 

func (m *ServiceOption) Reset()

func (*ServiceOption) String 

func (m *ServiceOption) String() string

type ServiceSpec 

type ServiceSpec struct {
	ServiceName      *string                `protobuf:"bytes,1,req,name=service_name,json=serviceName" json:"service_name,omitempty"`
	MethodList       []*ServiceMethodSpec   `protobuf:"bytes,2,rep,name=method_list,json=methodList" json:"method_list,omitempty"`
	ExternalDocs     *ExternalDocumentation `protobuf:"bytes,3,opt,name=external_docs,json=externalDocs" json:"external_docs,omitempty"`
	XXX_unrecognized []byte                 `json:"-"`
}

服务信息

func (*ServiceSpec) Descriptor 

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

func (*ServiceSpec) GetExternalDocs 

func (m *ServiceSpec) GetExternalDocs() *ExternalDocumentation

func (*ServiceSpec) GetMethodList 

func (m *ServiceSpec) GetMethodList() []*ServiceMethodSpec

func (*ServiceSpec) GetServiceName 

func (m *ServiceSpec) GetServiceName() string

func (*ServiceSpec) ProtoMessage 

func (*ServiceSpec) ProtoMessage()

func (*ServiceSpec) Reset 

func (m *ServiceSpec) Reset()

func (*ServiceSpec) String 

func (m *ServiceSpec) 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.