com.google.api.endpoint

Members list

Concise view

Type members

Classlikes

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

Endpoint describes a network address 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.

Endpoint describes a network address 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:

type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address https://library-example.googleapis.com # for service library-example.googleapis.com. The https scheme # is implicit for all service endpoints. Other schemes may be # supported in the future.

Attributes

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
Source:
Endpoint.scala
Graph
Supertypes
trait Updatable[Endpoint]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Endpoint extends GeneratedMessageCompanion[Endpoint]

Attributes

Companion:
class
Source:
Endpoint.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Endpoint]
trait Serializable
class Object
trait Matchable
class Any
Self type
object EndpointProto extends GeneratedFileObject

Attributes

Source:
EndpointProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type