autocliv1

package
v0.7.4 Latest Latest
Warning

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

 Go to latest Published: Apr 15, 2024 License: Apache-2.0 Imports: 14 Imported by: 309

Documentation

Overview

Code generated by protoc-gen-go-pulsar. DO NOT EDIT.

Code generated by protoc-gen-go-pulsar. DO NOT EDIT.

Index

Constants

View Source 
const (
	Query_AppOptions_FullMethodName = "/cosmos.autocli.v1.Query/AppOptions"
)

Variables

View Source 
var File_cosmos_autocli_v1_options_proto protoreflect.FileDescriptor
View Source 
var File_cosmos_autocli_v1_query_proto protoreflect.FileDescriptor
View Source 
var Query_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cosmos.autocli.v1.Query",
	HandlerType: (*QueryServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AppOptions",
			Handler:    _Query_AppOptions_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cosmos/autocli/v1/query.proto",
}

Query_ServiceDesc is the grpc.ServiceDesc for Query service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterQueryServer added in v0.2.2 

func RegisterQueryServer(s grpc.ServiceRegistrar, srv QueryServer)

Types

type AppOptionsRequest added in v0.2.2 

type AppOptionsRequest struct {
	// contains filtered or unexported fields
}

AppOptionsRequest is the RemoteInfoService/AppOptions request type.

func (*AppOptionsRequest) Descriptor deprecated added in v0.2.2 

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

Deprecated: Use AppOptionsRequest.ProtoReflect.Descriptor instead.

func (*AppOptionsRequest) ProtoMessage added in v0.2.2 

func (*AppOptionsRequest) ProtoMessage()

func (*AppOptionsRequest) ProtoReflect added in v0.2.2 

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

func (*AppOptionsRequest) Reset added in v0.2.2 

func (x *AppOptionsRequest) Reset()

func (*AppOptionsRequest) String added in v0.2.2 

func (x *AppOptionsRequest) String() string

type AppOptionsResponse added in v0.2.2 

type AppOptionsResponse struct {

	// module_options is a map of module name to autocli module options.
	ModuleOptions map[string]*ModuleOptions `` /* 188-byte string literal not displayed */
	// contains filtered or unexported fields
}

AppOptionsResponse is the RemoteInfoService/AppOptions response type.

func (*AppOptionsResponse) Descriptor deprecated added in v0.2.2 

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

Deprecated: Use AppOptionsResponse.ProtoReflect.Descriptor instead.

func (*AppOptionsResponse) GetModuleOptions added in v0.2.2 

func (x *AppOptionsResponse) GetModuleOptions() map[string]*ModuleOptions

func (*AppOptionsResponse) ProtoMessage added in v0.2.2 

func (*AppOptionsResponse) ProtoMessage()

func (*AppOptionsResponse) ProtoReflect added in v0.2.2 

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

func (*AppOptionsResponse) Reset added in v0.2.2 

func (x *AppOptionsResponse) Reset()

func (*AppOptionsResponse) String added in v0.2.2 

func (x *AppOptionsResponse) String() string

type FlagOptions 

type FlagOptions struct {

	// name is an alternate name to use for the field flag.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// shorthand is a one-letter abbreviated flag.
	Shorthand string `protobuf:"bytes,2,opt,name=shorthand,proto3" json:"shorthand,omitempty"`
	// usage is the help message.
	Usage string `protobuf:"bytes,3,opt,name=usage,proto3" json:"usage,omitempty"`
	// default_value is the default value as text.
	DefaultValue string `protobuf:"bytes,4,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// deprecated is the usage text to show if this flag is deprecated.
	Deprecated string `protobuf:"bytes,6,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	// shorthand_deprecated is the usage text to show if the shorthand of this flag is deprecated.
	ShorthandDeprecated string `protobuf:"bytes,7,opt,name=shorthand_deprecated,json=shorthandDeprecated,proto3" json:"shorthand_deprecated,omitempty"`
	// hidden hides the flag from help/usage text
	Hidden bool `protobuf:"varint,8,opt,name=hidden,proto3" json:"hidden,omitempty"`
	// contains filtered or unexported fields
}

FlagOptions are options for flags generated from rpc request fields. By default, all request fields are configured as flags based on the kebab-case name of the field. Fields can be turned into positional arguments instead by using RpcCommandOptions.positional_args.

func (*FlagOptions) Descriptor deprecated 

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

Deprecated: Use FlagOptions.ProtoReflect.Descriptor instead.

func (*FlagOptions) GetDefaultValue 

func (x *FlagOptions) GetDefaultValue() string

func (*FlagOptions) GetDeprecated 

func (x *FlagOptions) GetDeprecated() string

func (*FlagOptions) GetHidden 

func (x *FlagOptions) GetHidden() bool

func (*FlagOptions) GetName 

func (x *FlagOptions) GetName() string

func (*FlagOptions) GetShorthand 

func (x *FlagOptions) GetShorthand() string

func (*FlagOptions) GetShorthandDeprecated 

func (x *FlagOptions) GetShorthandDeprecated() string

func (*FlagOptions) GetUsage 

func (x *FlagOptions) GetUsage() string

func (*FlagOptions) ProtoMessage 

func (*FlagOptions) ProtoMessage()

func (*FlagOptions) ProtoReflect 

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

func (*FlagOptions) Reset 

func (x *FlagOptions) Reset()

func (*FlagOptions) String 

func (x *FlagOptions) String() string

type ModuleOptions 

type ModuleOptions struct {

	// tx describes the tx commands for the module.
	Tx *ServiceCommandDescriptor `protobuf:"bytes,1,opt,name=tx,proto3" json:"tx,omitempty"`
	// query describes the queries commands for the module.
	Query *ServiceCommandDescriptor `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// contains filtered or unexported fields
}

ModuleOptions describes the CLI options for a Cosmos SDK module.

func (*ModuleOptions) Descriptor deprecated 

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

Deprecated: Use ModuleOptions.ProtoReflect.Descriptor instead.

func (*ModuleOptions) GetQuery 

func (x *ModuleOptions) GetQuery() *ServiceCommandDescriptor

func (*ModuleOptions) GetTx 

func (x *ModuleOptions) GetTx() *ServiceCommandDescriptor

func (*ModuleOptions) ProtoMessage 

func (*ModuleOptions) ProtoMessage()

func (*ModuleOptions) ProtoReflect 

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

func (*ModuleOptions) Reset 

func (x *ModuleOptions) Reset()

func (*ModuleOptions) String 

func (x *ModuleOptions) String() string

type PositionalArgDescriptor 

type PositionalArgDescriptor struct {

	// proto_field specifies the proto field to use as the positional arg. Any
	// fields used as positional args will not have a flag generated.
	ProtoField string `protobuf:"bytes,1,opt,name=proto_field,json=protoField,proto3" json:"proto_field,omitempty"`
	// varargs makes a positional parameter a varargs parameter. This can only be
	// applied to last positional parameter and the proto_field must a repeated
	// field. Note: It is mutually exclusive with optional.
	Varargs bool `protobuf:"varint,2,opt,name=varargs,proto3" json:"varargs,omitempty"`
	// optional makes the last positional parameter optional.
	// Note: It is mutually exclusive with varargs.
	Optional bool `protobuf:"varint,3,opt,name=optional,proto3" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

PositionalArgDescriptor describes a positional argument.

func (*PositionalArgDescriptor) Descriptor deprecated 

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

Deprecated: Use PositionalArgDescriptor.ProtoReflect.Descriptor instead.

func (*PositionalArgDescriptor) GetOptional added in v0.5.0 

func (x *PositionalArgDescriptor) GetOptional() bool

func (*PositionalArgDescriptor) GetProtoField 

func (x *PositionalArgDescriptor) GetProtoField() string

func (*PositionalArgDescriptor) GetVarargs 

func (x *PositionalArgDescriptor) GetVarargs() bool

func (*PositionalArgDescriptor) ProtoMessage 

func (*PositionalArgDescriptor) ProtoMessage()

func (*PositionalArgDescriptor) ProtoReflect 

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

func (*PositionalArgDescriptor) Reset 

func (x *PositionalArgDescriptor) Reset()

func (*PositionalArgDescriptor) String 

func (x *PositionalArgDescriptor) String() string

type QueryClient added in v0.2.2 

type QueryClient interface {
	// AppOptions returns the autocli options for all of the modules in an app.
	AppOptions(ctx context.Context, in *AppOptionsRequest, opts ...grpc.CallOption) (*AppOptionsResponse, error)
}

QueryClient is the client API for Query service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewQueryClient added in v0.2.2 

func NewQueryClient(cc grpc.ClientConnInterface) QueryClient

type QueryServer added in v0.2.2 

type QueryServer interface {
	// AppOptions returns the autocli options for all of the modules in an app.
	AppOptions(context.Context, *AppOptionsRequest) (*AppOptionsResponse, error)
	// contains filtered or unexported methods
}

QueryServer is the server API for Query service. All implementations must embed UnimplementedQueryServer for forward compatibility

type RpcCommandOptions 

type RpcCommandOptions struct {

	// rpc_method is short name of the protobuf rpc method that this command is
	// generated from.
	RpcMethod string `protobuf:"bytes,1,opt,name=rpc_method,json=rpcMethod,proto3" json:"rpc_method,omitempty"`
	// use is the one-line usage method. It also allows specifying an alternate
	// name for the command as the first word of the usage text.
	//
	// By default the name of an rpc command is the kebab-case short name of the
	// rpc method.
	Use string `protobuf:"bytes,2,opt,name=use,proto3" json:"use,omitempty"`
	// long is the long message shown in the 'help <this-command>' output.
	Long string `protobuf:"bytes,3,opt,name=long,proto3" json:"long,omitempty"`
	// short is the short description shown in the 'help' output.
	Short string `protobuf:"bytes,4,opt,name=short,proto3" json:"short,omitempty"`
	// example is examples of how to use the command.
	Example string `protobuf:"bytes,5,opt,name=example,proto3" json:"example,omitempty"`
	// alias is an array of aliases that can be used instead of the first word in Use.
	Alias []string `protobuf:"bytes,6,rep,name=alias,proto3" json:"alias,omitempty"`
	// suggest_for is an array of command names for which this command will be suggested -
	// similar to aliases but only suggests.
	SuggestFor []string `protobuf:"bytes,7,rep,name=suggest_for,json=suggestFor,proto3" json:"suggest_for,omitempty"`
	// deprecated defines, if this command is deprecated and should print this string when used.
	Deprecated string `protobuf:"bytes,8,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	// version defines the version for this command. If this value is non-empty and the command does not
	// define a "version" flag, a "version" boolean flag will be added to the command and, if specified,
	// will print content of the "Version" variable. A shorthand "v" flag will also be added if the
	// command does not define one.
	Version string `protobuf:"bytes,9,opt,name=version,proto3" json:"version,omitempty"`
	// flag_options are options for flags generated from rpc request fields.
	// By default all request fields are configured as flags. They can
	// also be configured as positional args instead using positional_args.
	FlagOptions map[string]*FlagOptions `` /* 183-byte string literal not displayed */
	// positional_args specifies positional arguments for the command.
	PositionalArgs []*PositionalArgDescriptor `protobuf:"bytes,11,rep,name=positional_args,json=positionalArgs,proto3" json:"positional_args,omitempty"`
	// skip specifies whether to skip this rpc method when generating commands.
	Skip bool `protobuf:"varint,12,opt,name=skip,proto3" json:"skip,omitempty"`
	// contains filtered or unexported fields
}

RpcCommandOptions specifies options for commands generated from protobuf rpc methods.

func (*RpcCommandOptions) Descriptor deprecated 

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

Deprecated: Use RpcCommandOptions.ProtoReflect.Descriptor instead.

func (*RpcCommandOptions) GetAlias 

func (x *RpcCommandOptions) GetAlias() []string

func (*RpcCommandOptions) GetDeprecated 

func (x *RpcCommandOptions) GetDeprecated() string

func (*RpcCommandOptions) GetExample 

func (x *RpcCommandOptions) GetExample() string

func (*RpcCommandOptions) GetFlagOptions 

func (x *RpcCommandOptions) GetFlagOptions() map[string]*FlagOptions

func (*RpcCommandOptions) GetLong 

func (x *RpcCommandOptions) GetLong() string

func (*RpcCommandOptions) GetPositionalArgs 

func (x *RpcCommandOptions) GetPositionalArgs() []*PositionalArgDescriptor

func (*RpcCommandOptions) GetRpcMethod 

func (x *RpcCommandOptions) GetRpcMethod() string

func (*RpcCommandOptions) GetShort 

func (x *RpcCommandOptions) GetShort() string

func (*RpcCommandOptions) GetSkip 

func (x *RpcCommandOptions) GetSkip() bool

func (*RpcCommandOptions) GetSuggestFor 

func (x *RpcCommandOptions) GetSuggestFor() []string

func (*RpcCommandOptions) GetUse 

func (x *RpcCommandOptions) GetUse() string

func (*RpcCommandOptions) GetVersion 

func (x *RpcCommandOptions) GetVersion() string

func (*RpcCommandOptions) ProtoMessage 

func (*RpcCommandOptions) ProtoMessage()

func (*RpcCommandOptions) ProtoReflect 

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

func (*RpcCommandOptions) Reset 

func (x *RpcCommandOptions) Reset()

func (*RpcCommandOptions) String 

func (x *RpcCommandOptions) String() string

type ServiceCommandDescriptor 

type ServiceCommandDescriptor struct {

	// service is the fully qualified name of the protobuf service to build
	// the command from. It can be left empty if sub_commands are used instead
	// which may be the case if a module provides multiple tx and/or query services.
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// rpc_command_options are options for commands generated from rpc methods.
	// If no options are specified for a given rpc method on the service, a
	// command will be generated for that method with the default options.
	RpcCommandOptions []*RpcCommandOptions `protobuf:"bytes,2,rep,name=rpc_command_options,json=rpcCommandOptions,proto3" json:"rpc_command_options,omitempty"`
	// sub_commands is a map of optional sub-commands for this command based on
	// different protobuf services. The map key is used as the name of the
	// sub-command.
	SubCommands map[string]*ServiceCommandDescriptor `` /* 182-byte string literal not displayed */
	// enhance_custom_commands specifies whether to skip the service when generating commands, if a custom command already
	// exists, or enhance the existing command. If set to true, the custom command will be enhanced with the services from
	// gRPC. otherwise when a custom command exists, no commands will be generated for the service.
	EnhanceCustomCommand bool `protobuf:"varint,4,opt,name=enhance_custom_command,json=enhanceCustomCommand,proto3" json:"enhance_custom_command,omitempty"`
	// contains filtered or unexported fields
}

ServiceCommandDescriptor describes a CLI command based on a protobuf service.

func (*ServiceCommandDescriptor) Descriptor deprecated 

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

Deprecated: Use ServiceCommandDescriptor.ProtoReflect.Descriptor instead.

func (*ServiceCommandDescriptor) GetEnhanceCustomCommand added in v0.7.0 

func (x *ServiceCommandDescriptor) GetEnhanceCustomCommand() bool

func (*ServiceCommandDescriptor) GetRpcCommandOptions 

func (x *ServiceCommandDescriptor) GetRpcCommandOptions() []*RpcCommandOptions

func (*ServiceCommandDescriptor) GetService 

func (x *ServiceCommandDescriptor) GetService() string

func (*ServiceCommandDescriptor) GetSubCommands 

func (x *ServiceCommandDescriptor) GetSubCommands() map[string]*ServiceCommandDescriptor

func (*ServiceCommandDescriptor) ProtoMessage 

func (*ServiceCommandDescriptor) ProtoMessage()

func (*ServiceCommandDescriptor) ProtoReflect 

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

func (*ServiceCommandDescriptor) Reset 

func (x *ServiceCommandDescriptor) Reset()

func (*ServiceCommandDescriptor) String 

func (x *ServiceCommandDescriptor) String() string

type UnimplementedQueryServer added in v0.2.2 

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer must be embedded to have forward compatible implementations.

func (UnimplementedQueryServer) AppOptions added in v0.2.2 

func (UnimplementedQueryServer) AppOptions(context.Context, *AppOptionsRequest) (*AppOptionsResponse, error)

type UnsafeQueryServer added in v0.2.2 

type UnsafeQueryServer interface {
	// contains filtered or unexported methods
}

UnsafeQueryServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QueryServer will result in compilation errors.

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.