protobuf
Installation
Entrypoint
Types
Protobuf
Protoc
Go
- protobuf()
- grpc()

protobuf

This software is released under the MIT License.
https://opensource.org/licenses/MIT

Installation

dagger install github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4

Entrypoint

Return Type

Protobuf !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided
platform	Scalar	-	No description provided
from	Container	-	No description provided

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 --version string

func (m *MyModule) Example(version string) *dagger.Protobuf  {
	return dag.
			Protobuf(version)
}

@function
def example(version: str, ) -> dagger.Protobuf:
	return (
		dag.protobuf(version)
	)

@func()
example(version: string, ): Protobuf {
	return dag
		.protobuf(version)
}

Types

Protobuf 🔗

container() 🔗

Return Type

Container !

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 --version string container

func (m *MyModule) Example(version string) *dagger.Container  {
	return dag.
			Protobuf(version).
			Container()
}

@function
def example(version: str, ) -> dagger.Container:
	return (
		dag.protobuf(version)
		.container()
	)

@func()
example(version: string, ): Container {
	return dag
		.protobuf(version)
		.container()
}

protoc() 🔗

Run protoc.

Return Type

Protoc !

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 --version string protoc

func (m *MyModule) Example(version string) *dagger.ProtobufProtoc  {
	return dag.
			Protobuf(version).
			Protoc()
}

@function
def example(version: str, ) -> dagger.ProtobufProtoc:
	return (
		dag.protobuf(version)
		.protoc()
	)

@func()
example(version: string, ): ProtobufProtoc {
	return dag
		.protobuf(version)
		.protoc()
}

go() 🔗

Install the protoc-gen-go plugin.

Return Type

Go !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 --version string go --version string

func (m *MyModule) Example(version string, version1 string) *dagger.ProtobufGo  {
	return dag.
			Protobuf(version).
			Go(version1)
}

@function
def example(version: str, version1: str) -> dagger.ProtobufGo:
	return (
		dag.protobuf(version)
		.go(version1)
	)

@func()
example(version: string, version1: string): ProtobufGo {
	return dag
		.protobuf(version)
		.go(version1)
}

withPlugin() 🔗

Return Type

Protobuf !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided
bin	File !	-	No description provided

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 --version string with-plugin --name string --bin file:path

func (m *MyModule) Example(version string, name string, bin *dagger.File) *dagger.Protobuf  {
	return dag.
			Protobuf(version).
			WithPlugin(name, bin)
}

@function
def example(version: str, name: str, bin: dagger.File) -> dagger.Protobuf:
	return (
		dag.protobuf(version)
		.with_plugin(name, bin)
	)

@func()
example(version: string, name: string, bin: File): Protobuf {
	return dag
		.protobuf(version)
		.withPlugin(name, bin)
}

copyTo() 🔗

Copy well-known types, protoc, and plugins to the provided container.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
container	Container !	-	No description provided

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 --version string copy-to --container IMAGE:TAG

func (m *MyModule) Example(version string, container *dagger.Container) *dagger.Container  {
	return dag.
			Protobuf(version).
			CopyTo(container)
}

@function
def example(version: str, container: dagger.Container) -> dagger.Container:
	return (
		dag.protobuf(version)
		.copy_to(container)
	)

@func()
example(version: string, container: Container): Container {
	return dag
		.protobuf(version)
		.copyTo(container)
}

Protoc 🔗

compile() 🔗

Compile protocol buffer definitions.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
proto	[String ! ] !	-	No description provided
includePath	[String ! ] !	["."]	Specify the directory in which to search for imports.
excludeWellKnownTypes	Boolean	-	No description provided

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 protoc \
 compile --source DIR_PATH --proto string1 --proto string2 --include-path string1 --include-path string2

func (m *MyModule) Example(source *dagger.Directory, proto []string, includePath []string) *dagger.Directory  {
	return dag.
			Protobuf().
			Protoc().
			Compile(source, proto, includePath)
}

@function
def example(source: dagger.Directory, proto: List[str], include_path: List[str]) -> dagger.Directory:
	return (
		dag.protobuf()
		.protoc()
		.compile(source, proto, include_path)
	)

@func()
example(source: Directory, proto: string[], includePath: string[]): Directory {
	return dag
		.protobuf()
		.protoc()
		.compile(source, proto, includePath)
}

go() 🔗

Generate Go code.

Return Type

Protoc !

Arguments

Name	Type	Default Value	Description
outDir	String !	-	No description provided
opt	[String ! ]	-	No description provided

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 protoc \
 go --out-dir string

func (m *MyModule) Example(outDir string) *dagger.ProtobufProtoc  {
	return dag.
			Protobuf().
			Protoc().
			Go(outDir)
}

@function
def example(out_dir: str) -> dagger.ProtobufProtoc:
	return (
		dag.protobuf()
		.protoc()
		.go(out_dir)
	)

@func()
example(outDir: string): ProtobufProtoc {
	return dag
		.protobuf()
		.protoc()
		.go(outDir)
}

goGrpc() 🔗

Generate GRPC Go code.

Return Type

Protoc !

Arguments

Name	Type	Default Value	Description
outDir	String !	-	No description provided
opt	[String ! ]	-	No description provided

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 protoc \
 go-grpc --out-dir string

func (m *MyModule) Example(outDir string) *dagger.ProtobufProtoc  {
	return dag.
			Protobuf().
			Protoc().
			GoGrpc(outDir)
}

@function
def example(out_dir: str) -> dagger.ProtobufProtoc:
	return (
		dag.protobuf()
		.protoc()
		.go_grpc(out_dir)
	)

@func()
example(outDir: string): ProtobufProtoc {
	return dag
		.protobuf()
		.protoc()
		.goGrpc(outDir)
}

Go 🔗

protobuf() 🔗

Return Type

Protobuf !

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 go --version string \
 protobuf

func (m *MyModule) Example(version string) *dagger.Protobuf  {
	return dag.
			Protobuf().
			Go(version).
			Protobuf()
}

@function
def example(version: str) -> dagger.Protobuf:
	return (
		dag.protobuf()
		.go(version)
		.protobuf()
	)

@func()
example(version: string): Protobuf {
	return dag
		.protobuf()
		.go(version)
		.protobuf()
}

grpc() 🔗

Install the protoc-gen-go-grpc plugin.

Return Type

Go !

Arguments

Name	Type	Default Value	Description
version	String !	"latest"	No description provided

Example

dagger -m github.com/z5labs/daggerverse/protobuf@dd8d0ee1a7a96b9f0343ebaa059d58f150495ec4 call \
 go --version string \
 grpc --version string

func (m *MyModule) Example(version string, version1 string) *dagger.ProtobufGo  {
	return dag.
			Protobuf().
			Go(version).
			Grpc(version1)
}

@function
def example(version: str, version1: str) -> dagger.ProtobufGo:
	return (
		dag.protobuf()
		.go(version)
		.grpc(version1)
	)

@func()
example(version: string, version1: string): ProtobufGo {
	return dag
		.protobuf()
		.go(version)
		.grpc(version1)
}