proto-google-common-protos-scalapb_0.11/com.google.api.endpoint/Endpoint

Endpoint

@SerialVersionUID(0L) final case
class Endpoint(name: String, aliases: Seq[String], target: String, allowCors: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Endpoint]

Endpoint describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics.

Example service configuration:

name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed.

  • name: library-example.googleapis.com allow_cors: true
Value Params
aliases

Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended aliases. Additional names that this endpoint will be hosted on.

allowCors

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

name

The canonical name of this endpoint.

target

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

Companion
object
trait Updatable[Endpoint]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def addAliases(`__vs`: String*): Endpoint
def addAllAliases(`__vs`: Iterable[String]): Endpoint
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override
def serializedSize: Int
Definition Classes
GeneratedMessage
def toProtoString: String
def withAliases(`__v`: Seq[String]): Endpoint
def withAllowCors(`__v`: Boolean): Endpoint
def withName(`__v`: String): Endpoint
def withTarget(`__v`: String): Endpoint
def withUnknownFields(`__v`: UnknownFieldSet): Endpoint
def writeTo(`_output__`: CodedOutputStream): Unit

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
final
def toByteArray: Array[Byte]

Serializes the messgae and returns a byte array containing its raw bytes

Serializes the messgae and returns a byte array containing its raw bytes

Inherited from
GeneratedMessage
final
def toByteString: ByteString

Serializes the messgae and returns a ByteString containing its raw bytes

Serializes the messgae and returns a ByteString containing its raw bytes

Inherited from
GeneratedMessage
final
def toPMessage: PMessage
Inherited from
GeneratedMessage
def update(ms: Lens[Endpoint, Endpoint] => () => Endpoint*): Endpoint
Inherited from
Updatable
final
def writeDelimitedTo(output: OutputStream): Unit
Inherited from
GeneratedMessage
final
def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Inherited from
GeneratedMessage