Gradle Plugin/kotlinx.rpc.protoc/ProtocPlugin

ProtocPlugin

Available in a dev version: 0․11․0-grpc-186

How to configure

open class ProtocPlugin(source)

Access to a specific protoc plugin.

Types

Artifact

sealed class Artifact

Artifact for a protoc plugin.

Companion

object Companion

Strategy

enum Strategy : Enum<ProtocPlugin.Strategy>

Strategy for a protoc plugin.

Properties

artifact

val artifact: Property<ProtocPlugin.Artifact>

Protoc plugin artifact.

excludeTypes

val excludeTypes: ListProperty<String>

Exclude the specified types when generating with this plugin.

includeImports

val includeImports: Property<Boolean>

Whether to include imports except for Well-Known Types.

includeWkt

val includeWkt: Property<Boolean>

Whether to include Well-Known Types.

isJava

val isJava: Property<Boolean>

Whether the plugin generates Java code.

isKotlin

val isKotlin: Property<Boolean>

Whether the plugin generates Kotlin code.

name

val name: String

Plugin's name.

options

val options: MapProperty<String, Any>

Protoc plugins options.

strategy

val strategy: Property<ProtocPlugin.Strategy>

Strategy for this protoc plugin.

types

val types: ListProperty<String>

Include only the specified types when generating with this plugin.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

local

fun local(action: Action<ProtocPlugin.Artifact.Local>)

Local protoc plugin artifact.

remote

fun remote(action: Action<ProtocPlugin.Artifact.Remote>)

Remote protoc plugin artifact.