ScalaPB

https://scalapb.github.io/
Admin
ScalaPB is a Protocol Buffer compiler for Scala that automatically generates Scala case classes from...
Tokens:825,794
Snippets:4,225
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Navigate to Examples Directory

Source: https://scalapb.github.io/zio-grpc/docs/quickstart

Change the current directory to the ZIO gRPC examples directory. This is necessary to run the provided examples.

```bash
cd zio-grpc/examples/helloworld
```

--------------------------------

### Run ZIO gRPC Server

Source: https://scalapb.github.io/zio-grpc/docs/quickstart

Start the ZIO gRPC HelloWorld server using sbt. This command executes the main server class from the examples directory.

```bash
sbt "runMain zio_grpc.examples.helloworld.HelloWorldServer"
```

--------------------------------

### Original Proto File Example

Source: https://scalapb.github.io/docs/customizations

This is an example of a proto file that might be customized using auxiliary options.

```protobuf
syntax = "proto3";

package a.b.c;

message Foo {
  string hello = 1;
}

```

--------------------------------

### Navigate to ZIO gRPC Examples Directory

Source: https://scalapb.github.io/zio-grpc/docs/basics

Change your current directory to the routeguide example within the cloned ZIO gRPC repository. This is where the tutorial's code resides.

```bash
$ cd zio-grpc/examples/routeguide  

```

--------------------------------

### Pack and Unpack Examples

Source: https://scalapb.github.io/api/com/google/protobuf/any/Any.html

Examples demonstrating how to pack and unpack messages using the `Any` type in C++, Java, Python, and Go.

```APIDOC
## Pack and Unpack Examples

### Description
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

### Example 1: Pack and unpack a message in C++
```cpp
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
```

### Example 2: Pack and unpack a message in Java
```java
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
} // or 
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
```

### Example 3: Pack and unpack a message in Python
```python
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
```

### Example 4: Pack and unpack a message in Go
```go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}
```
```

--------------------------------

### Clone ScalaPB Examples

Source: https://scalapb.github.io/docs/getting-started

Clone the ScalaPB repository to access example code, including the basic address book tutorial.

```bash
git clone https://github.com/scalapb/ScalaPB.git  

cd examples/basic  
```

--------------------------------

### Clone ZIO gRPC Repository

Source: https://scalapb.github.io/zio-grpc/docs/quickstart

Clone the ZIO gRPC repository to access the example code. This is the first step to getting the example project.

```bash
git clone https://github.com/scalapb/zio-grpc
```

--------------------------------

### Mixin Configuration Example

Source: https://scalapb.github.io/api/com/google/protobuf/api/Mixin.html

Shows how to configure a mixin in an API definition. This example includes the AccessControl API into the Storage API.

```yaml
apis:
  - name: google.storage.v2.Storage
    mixins:
      - name: google.acl.v1.AccessControl
```

--------------------------------

### Clone ZIO gRPC Example Repository

Source: https://scalapb.github.io/zio-grpc/docs/basics

Clone the ZIO gRPC repository to access the example code for the tutorial. Ensure you checkout the v0.6.0-rc6 tag for this version.

```bash
$ git clone -b v0.6.0-rc6 https://github.com/scalapb/zio-grpc.git  

```

--------------------------------

### Compute Timestamp from current time in Python

Source: https://scalapb.github.io/api/com/google/protobuf/timestamp/index.html

This example shows how to get the current time and set it on a Timestamp object in Python.

```python
timestamp = Timestamp()
timestamp.GetCurrentTime()
```

--------------------------------

### Run ZIO gRPC RouteGuide Server

Source: https://scalapb.github.io/zio-grpc/docs/basics

Starts the RouteGuide server using sbt. Ensure you have the necessary dependencies configured.

```bash
sbt "runMain zio_grpc.examples.routeguide.RouteGuideServer"
```

--------------------------------

### Example Proto File for Greeter Service

Source: https://scalapb.github.io/docs/grpc

A simple proto3 file defining a 'Greeter' service with a 'SayHello' RPC, including request and response messages.

```protobuf
syntax = "proto3";  
  
package com.example.protos;  
  
// The greeting service definition.  
service Greeter {  
  // Sends a greeting  
  rpc SayHello (HelloRequest) returns (HelloReply) {}  
}  
  
// The request message containing the user's name.  
message HelloRequest {  
  string name = 1;  
}  
  
// The response message containing the greetings  
message HelloReply {  
  string message = 1;  
}  
```

--------------------------------

### Protobuf Service Definition with HTTP Annotation

Source: https://scalapb.github.io/api/com/google/protobuf/api/index.html

Defines a Protobuf service with an RPC method that includes an HTTP GET annotation. This example shows the base definition before any mixin inheritance.

```protobuf
service AccessControl {
  // Get the underlying ACL object.
  rpc GetAcl(GetAclRequest) returns (Acl) {
    option (google.api.http).get = "/v1/{resource=**}:getAcl";
  }
}
service Storage {
  rpc GetAcl(GetAclRequest) returns (Acl);

  // Get a data record.
  rpc GetData(GetDataRequest) returns (Data) {
    option (google.api.http).get = "/v2/{resource=**}";
  }
}
```

--------------------------------

### Run ZIO gRPC RouteGuide Client

Source: https://scalapb.github.io/zio-grpc/docs/basics

Starts the RouteGuide client application using sbt. This connects to a running RouteGuide server.

```bash
sbt "runMain zio_grpc.examples.routeguide.RouteGuideClientApp"
```

--------------------------------

### Timestamp Examples

Source: https://scalapb.github.io/api/com/google/protobuf/timestamp/Timestamp.html

Examples demonstrating how to create and use Timestamp objects in various programming languages.

```APIDOC
## Timestamp Examples

### Example 1: Compute Timestamp from POSIX `time()`
```c++
Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);
```

### Example 2: Compute Timestamp from POSIX `gettimeofday()`
```c++
struct timeval tv;
gettimeofday(&tv, NULL);
Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);
```

### Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`
```c++
FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
```

### Example 4: Compute Timestamp from Java `System.currentTimeMillis()`
```java
long millis = System.currentTimeMillis();
Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
 .setNanos((int) ((millis % 1000) * 1000000)).build();
```

### Example 5: Compute Timestamp from Java `Instant.now()`
```java
Instant now = Instant.now();
Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond())
 .setNanos(now.getNano()).build();
```

### Example 6: Compute Timestamp from current time in Python
```python
timestamp = Timestamp()
timestamp.GetCurrentTime()
```
```

--------------------------------

### Start ZIO gRPC Server

Source: https://scalapb.github.io/zio-grpc/docs/basics

Extend ServerMain to quickly set up a gRPC server. Override the port, define service dependencies, and implement the services method to return a ServiceList.

```scala
object RouteGuideServer extends ServerMain {
  override def port: Int = 8980

  val featuresDatabase = JsonFormat.fromJsonString[
    FeatureDatabase
  ](
    Source.fromResource("route_guide_db.json").mkString
  )

  val createRouteGuide = for {
    routeNotes <- Ref.make(Map.empty[Point, List[RouteNote]])
  } yield new RouteGuideService(featuresDatabase.feature, routeNotes)

  def services: ServiceList[Any] = 
    ServiceList.addZIO(createRouteGuide)
}
```

--------------------------------

### Simple Mixin Example

Source: https://scalapb.github.io/api/com/google/protobuf/api/Mixin.html

Demonstrates a basic mixin where Storage inherits methods from AccessControl. Documentation and options are inherited, and the HTTP path is updated with the new version.

```protobuf
package google.acl.v1;
service AccessControl {
  // Get the underlying ACL object.
  rpc GetAcl(GetAclRequest) returns (Acl) {
    option (google.api.http).get = "/v1/{resource=**}:getAcl";
  }
}
package google.storage.v2;
service Storage {
  rpc GetAcl(GetAclRequest) returns (Acl);
  // Get a data record.
  rpc GetData(GetDataRequest) returns (Data) {
    option (google.api.http).get = "/v2/{resource=**}";
  }
}
```

--------------------------------

### Install Rosetta on Apple M1

Source: https://scalapb.github.io/docs/faq

If you encounter 'Bad CPU type' errors on Apple M1, install Rosetta to enable x86_64 binary execution.

```bash
softwareupdate --install-rosetta
```

--------------------------------

### Instantiate ZIO gRPC Client Layer

Source: https://scalapb.github.io/zio-grpc/docs/basics

Create a ZLayer for RouteGuideClient using .live. This provides the client as a singleton through the environment, allowing the use of static accessor methods.

```scala
val clientLayer: Layer[Throwable, RouteGuideClient] = 
  RouteGuideClient.live(
    ZManagedChannel(
      ManagedChannelBuilder.forAddress("localhost", 8980).usePlaintext()
    )
  )
```

--------------------------------

### Implement New Server Method (GreeterImpl)

Source: https://scalapb.github.io/zio-grpc/docs/quickstart

Implements the new sayHelloAgain method in the HelloWorldServer's GreeterImpl. This provides the server-side logic for the new RPC.

```scala
def sayHelloAgain(request: HelloRequest) = 
  ZIO.succeed(HelloReply(s"Hello again, ${request.name}"))
```

--------------------------------

### getFeatures

Source: https://scalapb.github.io/api/com/google/protobuf/descriptor/MethodOptions.html

Gets the features of the MethodOptions.

```APIDOC
## getFeatures

### Description
Gets the features of the MethodOptions.

### Method
def

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **FeatureSet**: The FeatureSet of the MethodOptions.
```

--------------------------------

### Pack and Unpack Any Message in Java

Source: https://scalapb.github.io/api/com/google/protobuf/any/Any.html

Example showing how to pack a Foo message into an Any type and unpack it using Java's utility methods.

```java
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }
```

--------------------------------

### getIdempotencyLevel

Source: https://scalapb.github.io/api/com/google/protobuf/descriptor/MethodOptions.html

Gets the idempotency level of the MethodOptions.

```APIDOC
## getIdempotencyLevel

### Description
Gets the idempotency level of the MethodOptions.

### Method
def

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **IdempotencyLevel**: The IdempotencyLevel of the MethodOptions.
```

--------------------------------

### Use ScalaPB as a Protoc Plugin (Unix/Mac)

Source: https://scalapb.github.io/docs/scalapbc

Use ScalaPB as a direct protoc plugin on Unix-like systems. Download the native executable and specify its path using the --plugin option. Ensure the JVM is available if using a JVM-based implementation.

```bash
protoc my.protos --plugin=/path/to/bin/protoc-gen-scala-0.11.11-unix.sh --scala_out=scala  

```

--------------------------------

### getDeprecated

Source: https://scalapb.github.io/api/com/google/protobuf/descriptor/MethodOptions.html

Gets the deprecated status of the MethodOptions.

```APIDOC
## getDeprecated

### Description
Gets the deprecated status of the MethodOptions.

### Method
def

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **Boolean**: The deprecated status.
```

--------------------------------

### Get ScalaPbOptions Descriptor

Source: https://scalapb.github.io/api/scalapb/options/ScalaPbOptions%24.html

Retrieves the ScalaPbOptions descriptor.

```APIDOC
## def scalaDescriptor: Descriptor
```

--------------------------------

### Run ZIO gRPC Client

Source: https://scalapb.github.io/zio-grpc/docs/quickstart

Execute the ZIO gRPC HelloWorld client using sbt from a separate terminal. This connects to the running server.

```bash
sbt "runMain zio_grpc.examples.helloworld.HelloWorldClient"
```

--------------------------------

### get

Source: https://scalapb.github.io/api/scalapb/options/FieldOptions%24%24FieldOptionsLens.html

Extracts the FieldOptions value from an UpperPB container.

```APIDOC
## get

### Description
Extracts the FieldOptions value from an UpperPB container.

### Method
`get(u: UpperPB): FieldOptions`
```

--------------------------------

### Use ScalaPB as a Protoc Plugin (Windows)

Source: https://scalapb.github.io/docs/scalapbc

Use ScalaPB as a direct protoc plugin on Windows. Specify the path to the .bat script using the --plugin option. Ensure the JVM is available if using a JVM-based implementation.

```bash
protoc my.protos --plugin=protoc-gen-scala=/path/to/bin/protoc-gen-scala.bat --scala_out=scala  

```

--------------------------------

### get

Source: https://scalapb.github.io/api/com/google/protobuf/descriptor/EnumValueDescriptorProto%24%24EnumValueDescriptorProtoLens.html

Extracts a field of type EnumValueDescriptorProto from a container.

```APIDOC
## get(u: UpperPB): EnumValueDescriptorProto

### Description
Extracts a field of type `EnumValueDescriptorProto` from a container `UpperPB`.

### Method Signature
`get(u: UpperPB): EnumValueDescriptorProto`

### Parameters
* `u`: The container object of type `UpperPB` from which to extract the field.

### Returns
The extracted `EnumValueDescriptorProto`.
```

--------------------------------

### Define gRPC Service (Initial)

Source: https://scalapb.github.io/zio-grpc/docs/quickstart

Defines the initial Greeter gRPC service with a SayHello RPC method using protocol buffers. This is the starting point for service definition.

```protobuf
// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings
message HelloReply {
  string message = 1;
}

```

--------------------------------

### Get and Set Operations

Source: https://scalapb.github.io/api/scalapb/options/PreprocessorOutput%24%24OptionsByFileEntry%24%24OptionsByFileEntryLens.html

Methods for retrieving and updating the OptionsByFileEntry.

```APIDOC
## get(u: UpperPB): OptionsByFileEntry
### Description
Extracts the OptionsByFileEntry from a container.
### Parameters
- **u**: The container of type UpperPB.
### Returns
The extracted OptionsByFileEntry.
```

```APIDOC
## set(c: OptionsByFileEntry): Mutation[UpperPB]
### Description
Creates a mutation to set the OptionsByFileEntry.
### Parameters
- **c**: The OptionsByFileEntry value to set.
### Returns
A Mutation that sets the OptionsByFileEntry.
```

--------------------------------

### Create Minimal ScalaPB Project

Source: https://scalapb.github.io/docs/contact

Use this sbt command to quickly generate a minimal project template for ScalaPB. This is useful for creating reproducible examples for bug reports.

```bash
sbt new scalapb/scalapb-template.g8
```

--------------------------------

### value

Source: https://scalapb.github.io/api/scalapb/AnyMethods.html

Abstract method to get the value of the Any message as a ByteString.

```APIDOC
## value

### Description
Abstract method to get the value of the Any message as a ByteString.

### Method
N/A (Abstract method)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **value** (ByteString) - The value of the Any message.
```

--------------------------------

### typeUrl

Source: https://scalapb.github.io/api/scalapb/AnyMethods.html

Abstract method to get the type URL of the Any message.

```APIDOC
## typeUrl

### Description
Abstract method to get the type URL of the Any message.

### Method
N/A (Abstract method)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **typeUrl** (String) - The type URL of the Any message.
```

--------------------------------

### Pack and Unpack Any Message in Go

Source: https://scalapb.github.io/api/com/google/protobuf/any/index.html

Provides an example of packing a message into an Any type and unpacking it in Go using `anypb.New` and `UnmarshalTo`.

```go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil { ... }
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil { ... }
```

--------------------------------

### Running a ZIO gRPC Server with ServerMain

Source: https://scalapb.github.io/zio-grpc/docs/generated-code

This snippet shows the simplest way to run a ZIO gRPC service by extending `scalapb.zio_grpc.ServerMain`. It demonstrates how to add services and optionally override the default port.

```scala
import scalapb.zio_grpc.{ServerMain, ServiceList}

object MyMain extends ServerMain {
  def services = ServiceList.add(ServiceNameImpl)

  // Default port is 9000
  override def port: Int = 8980
}
```

--------------------------------

### get

Source: https://scalapb.github.io/api/com/google/protobuf/descriptor/DescriptorProto%24%24DescriptorProtoLens.html

Extracts a field of a specific type from a DescriptorProto container.

```APIDOC
## get

### Description
Gets knows how to extract some field of type `A` from a container.

### Method
`get(u: UpperPB): DescriptorProto`
```

--------------------------------

### Configure File-Level ScalaPB Options

Source: https://scalapb.github.io/docs/customizations

Use these file-level options in your proto files to customize ScalaPB's code generation. This example shows how to set the Scala package name, enable flat package structure, and include custom imports and preambles.

```protobuf
import "scalapb/scalapb.proto";  
  
option (scalapb.options) = {  
  scope: FILE  
  package_name: "com.example.myprotos"  
  flat_package: true  
  single_file: true  
  java_conversions: false  
  import: "com.thesamet.pb.MyType"  
  import: "com.thesamet.other._"  
  preamble: "sealed trait BaseMessage"  
  preamble: "sealed trait CommonMessage"  
  lenses: true  
  getters: true  
  retain_source_code_info: false  
  no_default_values_in_constructor: false  
  preserve_unknown_fields: false  
  enum_value_naming: CAMEL_CASE  
  enum_strip_prefix: false  
  bytes_type: "scodec.bits.ByteVector"  
  scala3_sources: false  
  public_constructor_parameters: false  
};  

```

--------------------------------

### get

Source: https://scalapb.github.io/api/com/google/protobuf/descriptor/DescriptorProto%24%24ExtensionRange%24%24ExtensionRangeLens.html

Extracts a field of a specific type 'A' from a container object.

```APIDOC
## get(u: UpperPB): ExtensionRange

### Description
Extracts some field of type `ExtensionRange` from a container.

### Method Signature
`get(u: UpperPB): ExtensionRange`

### Parameters
* `u` (UpperPB) - The container object from which to extract the field.
```

--------------------------------

### get

Source: https://scalapb.github.io/api/scalapb/options/OneofOptions%24%24OneofOptionsLens.html

Extracts the OneofOptions value from a container. This is the inverse operation of `set`.

```APIDOC
## get

### Description
`get` knows how to extract some field of type `OneofOptions` from a container (`UpperPB`). This is the inverse operation of `set`.

### Method
Lens operation

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
OneofOptions

#### Response Example
N/A
```

--------------------------------

### get(u: U): Container

Source: https://scalapb.github.io/api/scalapb/lenses/MessageLens.html

Extracts a field of type `A` from a container.

```APIDOC
## get(u: U): Container

### Description
Extracts a specific field of type `A` from a given container `U`.

### Method Signature
get(u: U): Container

### Parameters
- **u**: The container from which to extract the field.
```

--------------------------------

### Define gRPC Service

Source: https://scalapb.github.io/zio-grpc/docs/basics

Declares a gRPC service named RouteGuide in the .proto file.

```protobuf
service RouteGuide {
   ... 
}

```

--------------------------------

### Value Access and Mutation

Source: https://scalapb.github.io/api/com/google/protobuf/wrappers/Int32Value%24%24Int32ValueLens.html

Methods for getting and setting values of Int32Value.

```APIDOC
## Value Access and Mutation

### `get(u: UpperPB): Int32Value`

Extracts an Int32Value from a container.

### `set(c: Int32Value): Mutation[UpperPB]`

Represents an assignment operator to set an Int32Value.

### `update(ms: (Lens[Int32Value, Int32Value]) => Mutation[Int32Value]*): Mutation[UpperPB]`

Applies a series of mutations to the Int32Value.

```

--------------------------------

### Pack and Unpack Any Message in Go

Source: https://scalapb.github.io/api/com/google/protobuf/any/index.html

Provides an example of creating an Any type from a Foo message and then unmarshalling it back into a Foo message in Go.

```go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil { ... }
... 
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil { ... }
```

--------------------------------

### Create Dataset from Binary Data

Source: https://scalapb.github.io/docs/sparksql

Prepare a dataset with test binary data by mapping existing data to its byte array representation. This is the first step before parsing into protocol buffer objects.

```scala
val binaryDS: Dataset[Array[Byte]] = spark.createDataset(testData.map(_.toByteArray))
```

--------------------------------

### Get OptionProto Value

Source: https://scalapb.github.io/api/com/google/protobuf/type/OptionProto%24%24OptionProtoLens.html

Extracts a field of type `A` from a container (OptionProto).

```APIDOC
## get(u: UpperPB): OptionProto

### Description
Gets knows how to extract some field of type `A` from a container.

### Method Signature
get(u: UpperPB): OptionProto
```

--------------------------------

### Pack and Unpack Any Message in Python

Source: https://scalapb.github.io/api/com/google/protobuf/any/Any.html

Demonstrates packing a Foo message into an Any type and unpacking it in Python.

```python
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
...
```

--------------------------------

### Getting and Setting VisibilityFeature

Source: https://scalapb.github.io/api/com/google/protobuf/descriptor/FeatureSet%24%24VisibilityFeature%24%24VisibilityFeatureLens.html

Methods for extracting and updating the VisibilityFeature from a container.

```APIDOC
## get(u: UpperPB): VisibilityFeature

### Description
Gets the VisibilityFeature from a container.

### Method Signature
`get(u: UpperPB): VisibilityFeature`

### Definition Classes
ObjectLens → Lens
```

```APIDOC
## set(c: VisibilityFeature): Mutation[UpperPB]

### Description
Represents an assignment operator. Given a value of type A, sets the field.

### Method Signature
`set(c: VisibilityFeature): Mutation[UpperPB]`

### Definition Classes
ObjectLens → Lens
```

--------------------------------

### Launch Server Application

Source: https://scalapb.github.io/zio-grpc/docs/context

Define a ZIO application that launches the assembled server layer. The `run` method is used to start the server and obtain its exit code.

```scala
object LayeredApp extends zio.ZIOAppDefault {
    def run = ourApp.launch.exitCode
}
```

--------------------------------

### Lens Operations

Source: https://scalapb.github.io/api/com/google/protobuf/compiler/plugin/Version%24%24VersionLens.html

Methods for composing, getting, and setting version components.

```APIDOC
## Lens Operations

### Description
Provides methods for composing lenses, extracting values, and setting values for version components.

### Methods

#### `compose[B](other: Lens[Version, B]): Lens[UpperPB, B]`
Composes two lenses, enabling nested field manipulation.

#### `field[A](getter: (Version) ⇒ A)(setter: (Version, A) ⇒ Version): Lens[UpperPB, A]`
Creates a sub-lens using a getter and setter function.

#### `field[A](lens: Lens[Version, A]): Lens[UpperPB, A]`
Creates a sub-lens using another lens.

#### `get(u: UpperPB): Version`
Extracts a field of type `A` from a container.

#### `set(c: Version): Mutation[UpperPB]`
Represents an assignment operator. Sets the field to the provided value.

#### `setIfDefined(aOpt: scala.Option[Version]): Mutation[UpperPB]`
Optional assignment. If the option is `Some`, the field is set; otherwise, it remains unchanged.

#### `update(ms: (Lens[Version, Version]) ⇒ Mutation[Version]*): Mutation[UpperPB]`
Applies a sequence of mutation operations to the version.

#### `zip[B](other: Lens[UpperPB, B]): Lens[UpperPB, (Version, B)]`
Combines two lenses with the same origin into a new lens that operates on a tuple of the values.

```

--------------------------------

### OneofOptions Example

Source: https://scalapb.github.io/api/com/google/protobuf/descriptor/index.html

Options for a 'oneof' field, including features and uninterpreted options.

```Scala
@SerialVersionUID()
  20. __ final  case class OneofOptions(features: scala.Option[FeatureSet] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Vector.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[OneofOptions] with ExtendableMessage[OneofOptions] with Product with Serializable
```

--------------------------------

### Implementing a ZIO gRPC Service

Source: https://scalapb.github.io/zio-grpc/docs/generated-code

An example of how to implement a generated service trait. The implementation provides the logic for each RPC method.

```scala
object MyServiceImpl extends MyService {
  def sayHello(request: HelloRequest): ZIO[Any, StatusException, HelloReply] = ???
}
```

--------------------------------

### Create DataFrame and Dataset from RDD

Source: https://scalapb.github.io/docs/sparksql

Demonstrates how to create a Spark DataFrame and Dataset of protocol buffer objects directly from an RDD. Requires importing RDD and using ProtoSQL.protoToDataFrame.

```scala
import org.apache.spark.rdd.RDD

val protoRDD: RDD[Person] = spark.sparkContext.parallelize(testData)

val protoDF: DataFrame = ProtoSQL.protoToDataFrame(spark, protoRDD)

val protoDS: Dataset[Person] = spark.createDataset(protoRDD)
```

--------------------------------

### Value Access and Mutation

Source: https://scalapb.github.io/api/com/google/protobuf/wrappers/BoolValue%24%24BoolValueLens.html

Methods for getting, setting, and updating BoolValue fields.

```APIDOC
## Value Access and Mutation

### `get(u: UpperPB): BoolValue`

**Description**: Extracts a BoolValue field from a container.

### `set(c: BoolValue): Mutation[UpperPB]`

**Description**: Represents an assignment operator. Given a value, it transforms a container such that the value is assigned to the field. Ensures that `get(set(a)(c)) == a`.

### `update(ms: (Lens[BoolValue, BoolValue]) => Mutation[BoolValue]*): Mutation[UpperPB]`

**Description**: Applies a series of mutations to a BoolValue field.

```

--------------------------------

### Create Server with Dependent Services

Source: https://scalapb.github.io/zio-grpc/docs/context

Assemble the server layer by combining the server configuration, dependency layers, and the service layer. This sets up the application's runtime environment.

```scala
object MyServer3 extends zio.ZIOAppDefault {

  val serverLayer = 
    ServerLayer.fromServiceList(
      io.grpc.ServerBuilder.forPort(9000),
      ServiceList.addFromEnvironment[ZSimpleService[RequestContext]]
    )

  val appLayer = ZLayer.make[Server](
    serverLayer,
    DepA.layer,
    DepB.layer,
    MyService2.layer
  )

  def run = ourApp.launch.exitCode
}
```
Tokens:
Raw