final case class Endpoint(name: String = "", aliases: Seq[String] = _root_.scala.Seq.empty, features: Seq[String] = _root_.scala.Seq.empty, target: String = "", allowCors: Boolean = false, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Endpoint] with Product with Serializable

Endpoint describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration.

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
name

The canonical name of this endpoint.

aliases

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.

features

The list of features enabled on this endpoint.

target

The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

allowCors

Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), 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.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[Endpoint], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoint
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Endpoint(name: String = "", aliases: Seq[String] = _root_.scala.Seq.empty, features: Seq[String] = _root_.scala.Seq.empty, target: String = "", allowCors: Boolean = false, unknownFields: UnknownFieldSet = ...)

    name

    The canonical name of this endpoint.

    aliases

    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.

    features

    The list of features enabled on this endpoint.

    target

    The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

    allowCors

    Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), 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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAliases(__vs: String*): Endpoint
  5. def addAllAliases(__vs: Iterable[String]): Endpoint
  6. def addAllFeatures(__vs: Iterable[String]): Endpoint
  7. def addFeatures(__vs: String*): Endpoint
  8. val allowCors: Boolean
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clearAliases: Endpoint
  11. def clearFeatures: Endpoint
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  13. def companion: Endpoint.type
    Definition Classes
    Endpoint → GeneratedMessage
  14. def discardUnknownFields: Endpoint
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val features: Seq[String]
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Endpoint → GeneratedMessage
  20. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Endpoint → GeneratedMessage
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val name: String
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def serializedSize: Int
    Definition Classes
    Endpoint → GeneratedMessage
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. val target: String
  29. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  30. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  31. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  32. def toProtoString: String
    Definition Classes
    Endpoint → GeneratedMessage
  33. val unknownFields: UnknownFieldSet
  34. def update(ms: (Lens[Endpoint, Endpoint]) ⇒ Mutation[Endpoint]*): Endpoint
    Definition Classes
    Updatable
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  38. def withAliases(__v: Seq[String]): Endpoint
  39. def withAllowCors(__v: Boolean): Endpoint
  40. def withFeatures(__v: Seq[String]): Endpoint
  41. def withName(__v: String): Endpoint
  42. def withTarget(__v: String): Endpoint
  43. def withUnknownFields(__v: UnknownFieldSet): Endpoint
  44. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  45. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Endpoint → GeneratedMessage
  46. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val aliases: Seq[String]
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from Product

Inherited from Equals

Inherited from Updatable[Endpoint]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped