scalapb-runtime
API
Generated with
scalapb-runtime/com.google.protobuf/com.google.protobuf.api

com.google.protobuf.api

package com.google.protobuf.api

Members list

Type members

Classlikes

final case class Api(name: String, methods: Seq[Method], options: Seq[OptionProto], version: String, sourceContext: Option[SourceContext], mixins: Seq[Mixin], syntax: Syntax, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Api]

Api is a light-weight descriptor for an API Interface.

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

Value parameters

methods

The methods of this interface, in unspecified order.

mixins

Included interfaces. See [Mixin][].

name

The fully qualified name of this interface, including package name followed by the interface's simple name.

options

Any metadata attached to the interface.

sourceContext

Source context for the protocol buffer service represented by this message.

syntax

The source syntax of the service.

version

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

Attributes

Companion
object
Supertypes
trait Updatable[Api]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Api extends GeneratedMessageCompanion[Api], JavaProtoSupport[Api, Api]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[Api, Api]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Api.type
object ApiProto extends GeneratedFileObject

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
ApiProto.type
final case class Method(name: String, requestTypeUrl: String, requestStreaming: Boolean, responseTypeUrl: String, responseStreaming: Boolean, options: Seq[OptionProto], syntax: Syntax, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Method]

Method represents a method of an API interface.

Method represents a method of an API interface.

Value parameters

name

The simple name of this method.

options

Any metadata attached to the method.

requestStreaming

If true, the request is streamed.

requestTypeUrl

A URL of the input message type.

responseStreaming

If true, the response is streamed.

responseTypeUrl

The URL of the output message type.

syntax

The source syntax of this method.

Attributes

Companion
object
Supertypes
trait Updatable[Method]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Method extends GeneratedMessageCompanion[Method], JavaProtoSupport[Method, Method]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[Method, Method]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Method.type
final case class Mixin(name: String, root: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Mixin]

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:

  • If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.

  • Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited.

  • If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the [root][] path if specified.

Example of a simple mixin:

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=**}";
 }

}

Example of a mixin configuration:

apis:

  • name: google.storage.v2.Storage mixins:
    • name: google.acl.v1.AccessControl

The mixin construct implies that all methods in AccessControl are also declared with same name and request/response types in Storage. A documentation generator or annotation processor will see the effective Storage.GetAcl method after inherting documentation and annotations as follows:

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

Note how the version in the path pattern changed from v1 to v2.

If the root field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example:

apis:

  • name: google.storage.v2.Storage mixins:
    • name: google.acl.v1.AccessControl root: acls

This implies the following inherited HTTP annotation:

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

Value parameters

name

The fully qualified name of the interface which is included.

root

If non-empty specifies a path under which inherited HTTP paths are rooted.

Attributes

Companion
object
Supertypes
trait Updatable[Mixin]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Mixin extends GeneratedMessageCompanion[Mixin], JavaProtoSupport[Mixin, Mixin]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[Mixin, Mixin]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Mixin.type
Generated with