package proto
- Alphabetic
- By Inheritance
- proto
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final case class Grpc() extends Product with Serializable
GRPC protocol as defined by https://grpc.io/
- final case class ProtoCompactUUID() extends Product with Serializable
- final case class ProtoEnabled() extends Product with Serializable
This trait can be used to enable protobuf conversion on services or structures that are not a part of a GRPC service.
- type ProtoIndex = proto.ProtoIndex.Type
Marks an explicit index to be used for a structure member when it is interpreted as protobuf.
Marks an explicit index to be used for a structure member when it is interpreted as protobuf. For example:
structure Test {
@
protoIndex(2) str: String }Is equivalent to:
message Test { string str = 2 }
- final case class ProtoInlinedOneOf() extends Product with Serializable
This trait can be used to customize the rendering of an Union shape during the conversion to Protobuf models.
This trait can be used to customize the rendering of an Union shape during the conversion to Protobuf models. Union in Protobuf are typically encoded using
oneOf
.oneOf
can only be used withinmessage
and each of their member has an index. This makes them tricky to render. One possible solution is to create a syntheticmessage
to host theoneOf
, and then use thatmessage
FQN at use site when refering to the Union. There is an alternate encoding where you render theoneOf
inside themessage
where it's used. You can only use this encoding if the Union is used only inside of onestructure
.You can use this trait, along with the validator provided, to implement this encoding.
- sealed abstract class ProtoNumType extends Value
Specifies which type of number signing should be used on integers and longs.
- type ProtoReservedFields = proto.ProtoReservedFields.Type
Marks certain field indexes as unusable by the smithy specification.
Marks certain field indexes as unusable by the smithy specification. For example, if a range is provided of 1 to 10 then the proto indexes for any fields in that structure must fall outside of that range. Ranges are inclusive.
- sealed abstract class ProtoTimestampFormat extends Value
Specifies which type of timestamp representation should be used PROTOBUF indicates that the default encoding should be used EPOCH_MILLIS indicates that an int64 should be used instead of the default encoding.
- final case class ProtoWrapped() extends Product with Serializable
- final case class Range(start: Int, end: Int) extends Product with Serializable
- sealed trait ReservedFieldsDefinition extends Product with Serializable
Value Members
- object Grpc extends Companion[Grpc] with Serializable
- object ProtoCompactUUID extends Companion[ProtoCompactUUID] with Serializable
- object ProtoEnabled extends Companion[ProtoEnabled] with Serializable
- object ProtoIndex extends Newtype[Int]
Marks an explicit index to be used for a structure member when it is interpreted as protobuf.
Marks an explicit index to be used for a structure member when it is interpreted as protobuf. For example:
structure Test {
@
protoIndex(2) str: String }Is equivalent to:
message Test { string str = 2 }
- object ProtoInlinedOneOf extends Companion[ProtoInlinedOneOf] with Serializable
- object ProtoNumType extends Enumeration[ProtoNumType] with Companion[ProtoNumType] with Serializable
- object ProtoReservedFields extends Newtype[List[ReservedFieldsDefinition]]
Marks certain field indexes as unusable by the smithy specification.
Marks certain field indexes as unusable by the smithy specification. For example, if a range is provided of 1 to 10 then the proto indexes for any fields in that structure must fall outside of that range. Ranges are inclusive.
- object ProtoTimestampFormat extends Enumeration[ProtoTimestampFormat] with Companion[ProtoTimestampFormat] with Serializable
- object ProtoWrapped extends Companion[ProtoWrapped] with Serializable
- object Range extends Companion[Range] with Serializable
- object ReservedFieldsDefinition extends Companion[ReservedFieldsDefinition] with Serializable