Endpoint
class Endpoint extends Message
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
Protobuf type Google\Api\Endpoint
Methods
No description
The canonical name of this endpoint.
The canonical name of this endpoint.
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intented alias.
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intented alias.
The list of APIs served by this endpoint.
The list of APIs served by this endpoint.
The list of features enabled on this endpoint.
The list of features enabled on this endpoint.
The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
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.
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.
Details
at line 79
__construct()
at line 90
string
getName()
The canonical name of this endpoint.
Generated from protobuf field string name = 1;
at line 101
setName(string $var)
The canonical name of this endpoint.
Generated from protobuf field string name = 1;
at line 116
RepeatedField
getAliases()
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intented alias.
Additional names that this endpoint will be hosted on.
Generated from protobuf field repeated string aliases = 2;
at line 130
setAliases(array|RepeatedField $var)
DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intented alias.
Additional names that this endpoint will be hosted on.
Generated from protobuf field repeated string aliases = 2;
at line 142
RepeatedField
getApis()
The list of APIs served by this endpoint.
Generated from protobuf field repeated string apis = 3;
at line 153
setApis(array|RepeatedField $var)
The list of APIs served by this endpoint.
Generated from protobuf field repeated string apis = 3;
at line 165
RepeatedField
getFeatures()
The list of features enabled on this endpoint.
Generated from protobuf field repeated string features = 4;
at line 176
setFeatures(array|RepeatedField $var)
The list of features enabled on this endpoint.
Generated from protobuf field repeated string features = 4;
at line 191
string
getTarget()
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".
Generated from protobuf field string target = 101;
at line 205
setTarget(string $var)
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".
Generated from protobuf field string target = 101;
at line 222
bool
getAllowCors()
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.
Generated from protobuf field bool allow_cors = 5;
at line 238
setAllowCors(bool $var)
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.
Generated from protobuf field bool allow_cors = 5;