Reference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::EndpointsApiService.
Cloud Endpoints configuration.
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 the Service Management API.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#config_id
defconfig_id()->::String
Returns
(::String) — Endpoints service configuration ID as specified by the Service Management
API. For example "2016-09-19r1".
By default, the rollout strategy for Endpoints is RolloutStrategy.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. The config_id field is used to give the configuration
ID and is required in this case.
Endpoints also has a rollout strategy called RolloutStrategy.MANAGED.
When using this, Endpoints fetches the latest configuration and does not
need the configuration ID. In this case, config_id must be omitted.
#config_id=
defconfig_id=(value)->::String
Parameter
value (::String) — Endpoints service configuration ID as specified by the Service Management
API. For example "2016-09-19r1".
By default, the rollout strategy for Endpoints is RolloutStrategy.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. The config_id field is used to give the configuration
ID and is required in this case.
Endpoints also has a rollout strategy called RolloutStrategy.MANAGED.
When using this, Endpoints fetches the latest configuration and does not
need the configuration ID. In this case, config_id must be omitted.
Returns
(::String) — Endpoints service configuration ID as specified by the Service Management
API. For example "2016-09-19r1".
By default, the rollout strategy for Endpoints is RolloutStrategy.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. The config_id field is used to give the configuration
ID and is required in this case.
Endpoints also has a rollout strategy called RolloutStrategy.MANAGED.
When using this, Endpoints fetches the latest configuration and does not
need the configuration ID. In this case, config_id must be omitted.
#disable_trace_sampling
defdisable_trace_sampling()->::Boolean
Returns
(::Boolean) — Enable or disable trace sampling. By default, this is set to false for
enabled.
#disable_trace_sampling=
defdisable_trace_sampling=(value)->::Boolean
Parameter
value (::Boolean) — Enable or disable trace sampling. By default, this is set to false for
enabled.
Returns
(::Boolean) — Enable or disable trace sampling. By default, this is set to false for
enabled.
#name
defname()->::String
Returns
(::String) — Endpoints service name which is the name of the "service" resource in the
Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
#name=
defname=(value)->::String
Parameter
value (::String) — Endpoints service name which is the name of the "service" resource in the
Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
Returns
(::String) — Endpoints service name which is the name of the "service" resource in the
Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
[[["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,["# App Engine Admin V1 API - Class Google::Cloud::AppEngine::V1::EndpointsApiService (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [1.2.1](/ruby/docs/reference/google-cloud-app_engine-v1/1.2.1/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [1.1.0](/ruby/docs/reference/google-cloud-app_engine-v1/1.1.0/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [1.0.1](/ruby/docs/reference/google-cloud-app_engine-v1/1.0.1/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [0.10.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.10.0/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [0.9.2](/ruby/docs/reference/google-cloud-app_engine-v1/0.9.2/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [0.8.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.8.0/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [0.7.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.7.0/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [0.6.1](/ruby/docs/reference/google-cloud-app_engine-v1/0.6.1/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [0.5.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.5.0/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [0.4.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.4.0/Google-Cloud-AppEngine-V1-EndpointsApiService)\n- [0.3.6](/ruby/docs/reference/google-cloud-app_engine-v1/0.3.6/Google-Cloud-AppEngine-V1-EndpointsApiService) \nReference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::EndpointsApiService.\n\n[Cloud Endpoints](https://cloud.google.com/endpoints) configuration.\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.\n\n\n\u003cbr /\u003e\n\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\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #config_id\n\n def config_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Endpoints service configuration ID as specified by the Service Management API. For example \"2016-09-19r1\".\n\n By default, the rollout strategy for Endpoints is `RolloutStrategy.FIXED`.\n This means that Endpoints starts up with a particular configuration ID.\n When a new configuration is rolled out, Endpoints must be given the new\n configuration ID. The `config_id` field is used to give the configuration\n ID and is required in this case.\n\n Endpoints also has a rollout strategy called `RolloutStrategy.MANAGED`.\n When using this, Endpoints fetches the latest configuration and does not\n need the configuration ID. In this case, `config_id` must be omitted.\n\n### #config_id=\n\n def config_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Endpoints service configuration ID as specified by the Service Management API. For example \"2016-09-19r1\".\n\n\n By default, the rollout strategy for Endpoints is `RolloutStrategy.FIXED`.\n This means that Endpoints starts up with a particular configuration ID.\n When a new configuration is rolled out, Endpoints must be given the new\n configuration ID. The `config_id` field is used to give the configuration\n ID and is required in this case.\n\n Endpoints also has a rollout strategy called `RolloutStrategy.MANAGED`.\n When using this, Endpoints fetches the latest configuration and does not\nneed the configuration ID. In this case, `config_id` must be omitted. \n**Returns**\n\n- (::String) --- Endpoints service configuration ID as specified by the Service Management API. For example \"2016-09-19r1\".\n\n By default, the rollout strategy for Endpoints is `RolloutStrategy.FIXED`.\n This means that Endpoints starts up with a particular configuration ID.\n When a new configuration is rolled out, Endpoints must be given the new\n configuration ID. The `config_id` field is used to give the configuration\n ID and is required in this case.\n\n Endpoints also has a rollout strategy called `RolloutStrategy.MANAGED`.\n When using this, Endpoints fetches the latest configuration and does not\n need the configuration ID. In this case, `config_id` must be omitted.\n\n### #disable_trace_sampling\n\n def disable_trace_sampling() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Enable or disable trace sampling. By default, this is set to false for enabled.\n\n### #disable_trace_sampling=\n\n def disable_trace_sampling=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Enable or disable trace sampling. By default, this is set to false for enabled. \n**Returns**\n\n- (::Boolean) --- Enable or disable trace sampling. By default, this is set to false for enabled.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\" \n**Returns**\n\n- (::String) --- Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"\n\n### #rollout_strategy\n\n def rollout_strategy() -\u003e ::Google::Cloud::AppEngine::V1::EndpointsApiService::RolloutStrategy\n\n**Returns**\n\n- ([::Google::Cloud::AppEngine::V1::EndpointsApiService::RolloutStrategy](./Google-Cloud-AppEngine-V1-EndpointsApiService-RolloutStrategy)) --- Endpoints rollout strategy. If `FIXED`, `config_id` must be specified. If `MANAGED`, `config_id` must be omitted.\n\n### #rollout_strategy=\n\n def rollout_strategy=(value) -\u003e ::Google::Cloud::AppEngine::V1::EndpointsApiService::RolloutStrategy\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AppEngine::V1::EndpointsApiService::RolloutStrategy](./Google-Cloud-AppEngine-V1-EndpointsApiService-RolloutStrategy)) --- Endpoints rollout strategy. If `FIXED`, `config_id` must be specified. If `MANAGED`, `config_id` must be omitted. \n**Returns**\n\n- ([::Google::Cloud::AppEngine::V1::EndpointsApiService::RolloutStrategy](./Google-Cloud-AppEngine-V1-EndpointsApiService-RolloutStrategy)) --- Endpoints rollout strategy. If `FIXED`, `config_id` must be specified. If `MANAGED`, `config_id` must be omitted."]]
