1. class
  2. Google
  3. \
  4. Api
  5. \
  6. Endpoint

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

Generated from protobuf message google.api.Endpoint

Methods

__construct(array $data = NULL)

Constructor.

string
getName()

The canonical name of this endpoint.

$this
setName(string $var)

The canonical name of this endpoint.

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 intended aliases.

$this
setAliases(string[]|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 intended aliases.

RepeatedField
getFeatures()

The list of features enabled on this endpoint.

$this
setFeatures(string[]|RepeatedField $var)

The list of features enabled on this endpoint.

string
getTarget()

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.

$this
setTarget(string $var)

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.

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.

$this
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.

Details

at line 102
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $name
      The canonical name of this endpoint.
@type string[]|\Google\Protobuf\Internal\RepeatedField $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.
@type string[]|\Google\Protobuf\Internal\RepeatedField $features
      The list of features enabled on this endpoint.
@type string $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".
@type bool $allow_cors
      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.

}

at line 113
string getName()

The canonical name of this endpoint.

Generated from protobuf field string name = 1;

Return Value

string

at line 125
$this setName(string $var)

The canonical name of this endpoint.

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 142
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 intended aliases.

Additional names that this endpoint will be hosted on.

Generated from protobuf field repeated string aliases = 2;

Return Value

RepeatedField

at line 157
$this setAliases(string[]|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 intended aliases.

Additional names that this endpoint will be hosted on.

Generated from protobuf field repeated string aliases = 2;

Parameters

string[]|RepeatedField $var

Return Value

$this

at line 171
RepeatedField getFeatures()

The list of features enabled on this endpoint.

Generated from protobuf field repeated string features = 4;

Return Value

RepeatedField

at line 183
$this setFeatures(string[]|RepeatedField $var)

The list of features enabled on this endpoint.

Generated from protobuf field repeated string features = 4;

Parameters

string[]|RepeatedField $var

Return Value

$this

at line 200
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;

Return Value

string

at line 215
$this 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;

Parameters

string $var

Return Value

$this

at line 234
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;

Return Value

bool

at line 251
$this 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;

Parameters

bool $var

Return Value

$this