HomeDocs
DocsCommunityTestimonialsUsersGitHubTwitterBlogJobsTermsPrivacyCookies
TermsPrivacyCookies
Hey! These docs are for version 2.14, which is no longer officially supported. Click here for the latest version, 2.17!


gRPC support for Java Protobuf (https://github.com/grpc/grpc-java)

Backend: <span style="color: purple"><code>pants.backend.experimental.codegen.protobuf.java</code></span> Config section: <span style="color: purple"><code>[protobuf-java-grpc]</code></span>

## Basic options

None

## Advanced options

<div style="color: purple">

### `version`

<code>--protobuf-java-grpc-version=<str></code><br> <code>PANTS_PROTOBUF_JAVA_GRPC_VERSION</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>1.48.0</code></span>

<br>

Version string for the tool. This is available for substitution in the `[protobuf-java-grpc].artifacts` option by including the string `{version}`.

</div> <br>

<div style="color: purple">

### `artifacts`

<code>--protobuf-java-grpc-artifacts="['&lt;str&gt;', '&lt;str&gt;', ...]"</code><br> <code>PANTS_PROTOBUF_JAVA_GRPC_ARTIFACTS</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "io.grpc:protoc-gen-grpc-java:exe:linux-aarch&lowbar;64:{version}", "io.grpc:protoc-gen-grpc-java:exe:linux-x86&lowbar;64:{version}", "io.grpc:protoc-gen-grpc-java:exe:osx-aarch&lowbar;64:{version}", "io.grpc:protoc-gen-grpc-java:exe:osx-x86&lowbar;64:{version}" ]</pre></span>

<br>

Artifact requirements for this tool using specified as either the address of a `jvm_artifact` target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version). For Maven coordinates, the string `{version}` version will be substituted with the value of the `[protobuf-java-grpc].version` option.

</div> <br>

<div style="color: purple">

### `lockfile`

<code>--protobuf-java-grpc-lockfile=<str></code><br> <code>PANTS_PROTOBUF_JAVA_GRPC_LOCKFILE</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>&lt;default&gt;</code></span>

<br>

Path to a lockfile used for installing the tool.

Set to the string `<default>` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.14.2rc2/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.

To use a custom lockfile, set this option to a file path relative to the build root, then run `./pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.

</div> <br>

<div style="color: purple">

### `jvm_options`

<code>--protobuf-java-grpc-jvm-options="['&lt;str&gt;', '&lt;str&gt;', ...]"</code><br> <code>PANTS_PROTOBUF_JAVA_GRPC_JVM_OPTIONS</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>

<br>

List of JVM options to pass to `protobuf-java-grpc` JVM processes.

Options set here will be added to those set in `[jvm].global_options`. Please check the documentation for the `jvm` subsystem to see what values are accepted here.

</div> <br>

## Deprecated options

None