gengapic

Documentation

Index

• func Gen(genReq *plugin.CodeGeneratorRequest) (*plugin.CodeGeneratorResponse, error)
• func MDPlain(s string) string
• func ParseOptions(parameter *string) (*options, error)
• type Transport

Functions

func Gen

func Gen(genReq *plugin.CodeGeneratorRequest) (*plugin.CodeGeneratorResponse, error)

func MDPlain

func MDPlain(s string) string

func ParseOptions

func ParseOptions(parameter *string) (*options, error)

ParseOptions takes a string and parses it into a struct defining customizations on the target gapic surface. Options are comma-separated key/value pairs which are in turn delimited with '='. Valid options include: * go-gapic-package (package and module naming info) * sample-only (only checked for presence) * gapic-service-config (filepath) * grpc-service-config (filepath) * module (name) * release-level (one of 'alpha', 'beta', or empty) * transport ('+' separated list of transport backends to generate) The only required option is 'go-gapic-package'.

Valid parameter example: go-gapic-package=path/to/out;pkg,module=path,transport=rest+grpc,gapic-service-config=gapic_cfg.json,release-level=alpha

It returns a pointer to a populated options if no errors were encountered while parsing. If errors were encountered, it returns a nil pointer and the first error.

Types

type Transport

type Transport int