Endpoint class final

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.
- name: library-example.googleapis.com
  allow_cors: false
- name: content-staging-library-example.googleapis.com
  # Allows HTTP OPTIONS calls to be passed to the API frontend, for it
  # to decide whether the subsequent cross-origin request is allowed
  # to proceed.
  allow_cors: true
Inheritance
  • Object
  • ProtoMessage
  • Endpoint

Constructors

Endpoint({String name = '', List<String> aliases = const [], String target = '', bool allowCors = false})
Endpoint.fromJson(Object? j)
factory

Properties

aliases → List<String>
Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints.
final
allowCors → bool
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.
final
hashCode → int
The hash code for this object.
no setterinherited
name → String
The canonical name of this endpoint.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
target → String
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".
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String