Gradle Plugin/kotlinx.rpc.protoc

Package-level declarations

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

How to configure

Types

DefaultProtoTask

abstract class DefaultProtoTask(val properties: ProtoTask.Properties) : ProtoTask, DefaultTask

Default implementation of ProtoTask with Task.group set to PROTO_GROUP.

ProcessProtoFiles

abstract class ProcessProtoFiles : Sync, ProtoTask

Copy proto files to a temporary directory for Buf to process.

ProtocExtension

sealed interface ProtocExtension

Configuration for the Protoc capabilities.

ProtocPlugin

open class ProtocPlugin

Access to a specific protoc plugin.

ProtoSourceSet

sealed interface ProtoSourceSet : SourceDirectorySet

Represents a source set for proto files.

ProtoSourceSets

typealias ProtoSourceSets = NamedDomainObjectContainer<ProtoSourceSet>

ProtoTask

interface ProtoTask : Task

Abstract base interface for tasks that work with .proto files.

ProtoTasks

sealed interface ProtoTasks<ProtoTaskT : ProtoTask> : TaskCollection<ProtoTaskT>

Represents a collection of ProtoTask tasks of a given type.

Properties

buf

val ProtoTasks<ProtoTask>.buf: ProtoTasks<BufExecTask>

Returns a collection of all buf tasks registered in the project.

generate

val ProtoTasks<BufExecTask>.generate: ProtoTasks<BufGenerateTask>

Returns a collection of all buf generate tasks registered in the project.

grpcKotlinMultiplatform

val NamedDomainObjectContainer<ProtocPlugin>.grpcKotlinMultiplatform: NamedDomainObjectProvider<ProtocPlugin>

Access to the grpc-kotlin-multiplatform protoc plugin.

grpcKotlinMultiplatformProtocPluginJarPath

val Project.grpcKotlinMultiplatformProtocPluginJarPath: Provider<String>

Absolute path to the protoc-gen-grpc-kotlin-multiplatform jar.

kotlinMultiplatform

val NamedDomainObjectContainer<ProtocPlugin>.kotlinMultiplatform: NamedDomainObjectProvider<ProtocPlugin>

Access to the kotlin-multiplatform protoc plugin.

kotlinMultiplatformProtocPluginJarPath

val Project.kotlinMultiplatformProtocPluginJarPath: Provider<String>

Absolute path to the protoc-gen-kotlin-multiplatform jar.

proto

val NamedDomainObjectProvider<SourceSet>.proto: Provider<ProtoSourceSet>

val SourceSet.proto: ProtoSourceSet

Returns the proto source set for this SourceSet.

@get:JvmName(name = "proto_kotlin")

val NamedDomainObjectProvider<KotlinSourceSet>.proto: Provider<ProtoSourceSet>

val KotlinSourceSet.proto: ProtoSourceSet

Returns the proto source set for this KotlinSourceSet.

PROTO_BUILD_DIR

const val PROTO_BUILD_DIR: String

Directory for proto build artifacts.

PROTO_BUILD_GENERATED

const val PROTO_BUILD_GENERATED: String

Directory for proto build generated files.

PROTO_BUILD_SOURCE_SETS

const val PROTO_BUILD_SOURCE_SETS: String

Directory for proto build temporary files. Files there are constructed to form a valid Buf workspace.

PROTO_FILES_DIR

const val PROTO_FILES_DIR: String

Source directory for proto files in PROTO_BUILD_SOURCE_SETS.

PROTO_FILES_IMPORT_DIR

const val PROTO_FILES_IMPORT_DIR: String

Source directory for proto imported files in PROTO_BUILD_SOURCE_SETS.

PROTO_GROUP

const val PROTO_GROUP: String

proto group for related gradle tasks.

PROTO_SOURCE_DIRECTORY_NAME

const val PROTO_SOURCE_DIRECTORY_NAME: String

Name of the default source directory set for proto files in PROTO_SOURCE_SETS.

PROTO_SOURCE_SET_EXTENSION_NAME

const val PROTO_SOURCE_SET_EXTENSION_NAME: String

Name of the extension that is created for org.gradle.api.tasks.SourceSet instances.

PROTO_SOURCE_SETS

const val PROTO_SOURCE_SETS: String

Container for proto source sets.

PROTOC_GEN_GRPC_KOTLIN_MULTIPLATFORM_JAR_CONFIGURATION

const val PROTOC_GEN_GRPC_KOTLIN_MULTIPLATFORM_JAR_CONFIGURATION: String

Configuration name for the protoc-gen-grpc-kotlin-multiplatform protoc plugin artifact.

PROTOC_GEN_KOTLIN_MULTIPLATFORM_JAR_CONFIGURATION

const val PROTOC_GEN_KOTLIN_MULTIPLATFORM_JAR_CONFIGURATION: String

Configuration name for the protoc-gen-kotlin-multiplatform protoc plugin artifact.

protoTasks

val Project.protoTasks: ProtoTasks<ProtoTask>

Returns a collection of all proto tasks registered in the project.

Functions

grpcKotlinMultiplatform

fun NamedDomainObjectContainer<ProtocPlugin>.grpcKotlinMultiplatform(action: Action<ProtocPlugin>)

Configures the grpc-kotlin-multiplatform protoc plugin.

kotlinMultiplatform

fun NamedDomainObjectContainer<ProtocPlugin>.kotlinMultiplatform(action: Action<ProtocPlugin>)

Configures the kotlin-multiplatform protoc plugin.

matchingType

inline fun <ProtoTaskT : ProtoTask> ProtoTasks<*>.matchingType(): ProtoTasks<ProtoTaskT>

Filters tasks by type.

proto

fun NamedDomainObjectProvider<SourceSet>.proto(action: Action<ProtoSourceSet>)

fun SourceSet.proto(action: Action<ProtoSourceSet>)

Executes the given action on the proto source set for this SourceSet.

@JvmName(name = "proto_kotlin")

fun NamedDomainObjectProvider<KotlinSourceSet>.proto(action: Action<ProtoSourceSet>)

fun KotlinSourceSet.proto(action: Action<ProtoSourceSet>)

Executes the given action on the proto source set for this KotlinSourceSet.