The Endpoints API Service provides tooling for serving Open API and gRPC
endpoints via an NGINX proxy. Only valid for App Engine Flexible environment
deployments.
The fields here refer to the name and configuration ID of a "service"
resource in theService Management API.
Generated from protobuf messagegoogle.appengine.v1.EndpointsApiService
Namespace
Google \ Cloud \ AppEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
↳ config_id
string
Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1". By default, the rollout strategy for Endpoints isRolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. Theconfig_idfield is used to give the configuration ID and is required in this case. Endpoints also has a rollout strategy calledRolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case,config_idmust be omitted.
↳ rollout_strategy
int
Endpoints rollout strategy. IfFIXED,config_idmust be specified. IfMANAGED,config_idmust be omitted.
↳ disable_trace_sampling
bool
Enable or disable trace sampling. By default, this is set to false for enabled.
getName
Endpoints service name which is the name of the "service" resource in the
Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
Returns
Type
Description
string
setName
Endpoints service name which is the name of the "service" resource in the
Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getConfigId
Endpoints service configuration ID as specified by the Service Management
API. For example "2016-09-19r1".
By default, the rollout strategy for Endpoints isRolloutStrategy.FIXED.
This means that Endpoints starts up with a particular configuration ID.
When a new configuration is rolled out, Endpoints must be given the new
configuration ID. Theconfig_idfield is used to give the configuration
ID and is required in this case.
Endpoints also has a rollout strategy calledRolloutStrategy.MANAGED.
When using this, Endpoints fetches the latest configuration and does not
need the configuration ID. In this case,config_idmust be omitted.
Returns
Type
Description
string
setConfigId
Endpoints service configuration ID as specified by the Service Management
API. For example "2016-09-19r1".
By default, the rollout strategy for Endpoints isRolloutStrategy.FIXED.
This means that Endpoints starts up with a particular configuration ID.
When a new configuration is rolled out, Endpoints must be given the new
configuration ID. Theconfig_idfield is used to give the configuration
ID and is required in this case.
Endpoints also has a rollout strategy calledRolloutStrategy.MANAGED.
When using this, Endpoints fetches the latest configuration and does not
need the configuration ID. In this case,config_idmust be omitted.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRolloutStrategy
Endpoints rollout strategy. IfFIXED,config_idmust be specified. IfMANAGED,config_idmust be omitted.
Returns
Type
Description
int
setRolloutStrategy
Endpoints rollout strategy. IfFIXED,config_idmust be specified. IfMANAGED,config_idmust be omitted.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getDisableTraceSampling
Enable or disable trace sampling. By default, this is set to false for
enabled.
Returns
Type
Description
bool
setDisableTraceSampling
Enable or disable trace sampling. By default, this is set to false for
enabled.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Appengine Admin V1 Client - Class EndpointsApiService (2.0.4)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.4 (latest)](/php/docs/reference/cloud-appengine-admin/latest/V1.EndpointsApiService)\n- [2.0.3](/php/docs/reference/cloud-appengine-admin/2.0.3/V1.EndpointsApiService)\n- [1.3.5](/php/docs/reference/cloud-appengine-admin/1.3.5/V1.EndpointsApiService)\n- [1.2.2](/php/docs/reference/cloud-appengine-admin/1.2.2/V1.EndpointsApiService)\n- [1.1.1](/php/docs/reference/cloud-appengine-admin/1.1.1/V1.EndpointsApiService)\n- [1.0.6](/php/docs/reference/cloud-appengine-admin/1.0.6/V1.EndpointsApiService) \nReference documentation and code samples for the Google Cloud Appengine Admin V1 Client class EndpointsApiService.\n\n[Cloud Endpoints](https://cloud.google.com/endpoints) configuration.\n\nThe Endpoints API Service provides tooling for serving Open API and gRPC\nendpoints via an NGINX proxy. Only valid for App Engine Flexible environment\ndeployments.\nThe fields here refer to the name and configuration ID of a \"service\"\nresource in the [Service Management API](https://cloud.google.com/service-management/overview).\n\nGenerated from protobuf message `google.appengine.v1.EndpointsApiService`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AppEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nEndpoints service name which is the name of the \"service\" resource in the\nService Management API. For example \"myapi.endpoints.myproject.cloud.goog\"\n\n### setName\n\nEndpoints service name which is the name of the \"service\" resource in the\nService Management API. For example \"myapi.endpoints.myproject.cloud.goog\"\n\n### getConfigId\n\nEndpoints service configuration ID as specified by the Service Management\nAPI. For example \"2016-09-19r1\".\n\nBy default, the rollout strategy for Endpoints is `RolloutStrategy.FIXED`.\nThis means that Endpoints starts up with a particular configuration ID.\nWhen a new configuration is rolled out, Endpoints must be given the new\nconfiguration ID. The `config_id` field is used to give the configuration\nID and is required in this case.\nEndpoints also has a rollout strategy called `RolloutStrategy.MANAGED`.\nWhen using this, Endpoints fetches the latest configuration and does not\nneed the configuration ID. In this case, `config_id` must be omitted.\n\n### setConfigId\n\nEndpoints service configuration ID as specified by the Service Management\nAPI. For example \"2016-09-19r1\".\n\nBy default, the rollout strategy for Endpoints is `RolloutStrategy.FIXED`.\nThis means that Endpoints starts up with a particular configuration ID.\nWhen a new configuration is rolled out, Endpoints must be given the new\nconfiguration ID. The `config_id` field is used to give the configuration\nID and is required in this case.\nEndpoints also has a rollout strategy called `RolloutStrategy.MANAGED`.\nWhen using this, Endpoints fetches the latest configuration and does not\nneed the configuration ID. In this case, `config_id` must be omitted.\n\n### getRolloutStrategy\n\nEndpoints rollout strategy. If `FIXED`, `config_id` must be specified. If\n`MANAGED`, `config_id` must be omitted.\n\n### setRolloutStrategy\n\nEndpoints rollout strategy. If `FIXED`, `config_id` must be specified. If\n`MANAGED`, `config_id` must be omitted.\n\n### getDisableTraceSampling\n\nEnable or disable trace sampling. By default, this is set to false for\nenabled.\n\n### setDisableTraceSampling\n\nEnable or disable trace sampling. By default, this is set to false for\nenabled."]]
