Reference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::Service.
A Service resource is a logical component of an application that can share
state and communicate in a secure fashion with other services.
For example, an application that handles customer requests might
include separate services to handle tasks such as backend data
analysis or API requests from mobile devices. Each service has a
collection of versions that define a specific set of code used to
implement the functionality of that service.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#id
defid()->::String
Returns
(::String) — Relative name of the service within the application.
Example: default.
#id=
defid=(value)->::String
Parameter
value (::String) — Relative name of the service within the application.
Example: default.
Returns
(::String) — Relative name of the service within the application.
Example: default.
(::Google::Protobuf::Map{::String => ::String}) — A set of labels to apply to this service. Labels are key/value pairs that
describe the service and all resources that belong to it (e.g.,
versions). The labels can be used to search and group resources, and are
propagated to the usage and billing reports, enabling fine-grain analysis
of costs. An example of using labels is to tag resources belonging to
different environments (e.g., "env=prod", "env=qa").
Label keys and values can be no longer than 63 characters and can only
contain lowercase letters, numeric characters, underscores, dashes, and
international characters. Label keys must start with a lowercase letter
or an international character. Each service can have at most 32 labels.
value (::Google::Protobuf::Map{::String => ::String}) — A set of labels to apply to this service. Labels are key/value pairs that
describe the service and all resources that belong to it (e.g.,
versions). The labels can be used to search and group resources, and are
propagated to the usage and billing reports, enabling fine-grain analysis
of costs. An example of using labels is to tag resources belonging to
different environments (e.g., "env=prod", "env=qa").
Label keys and values can be no longer than 63 characters and can only
contain lowercase letters, numeric characters, underscores, dashes, and
international characters. Label keys must start with a lowercase letter
or an international character. Each service can have at most 32 labels.
Returns
(::Google::Protobuf::Map{::String => ::String}) — A set of labels to apply to this service. Labels are key/value pairs that
describe the service and all resources that belong to it (e.g.,
versions). The labels can be used to search and group resources, and are
propagated to the usage and billing reports, enabling fine-grain analysis
of costs. An example of using labels is to tag resources belonging to
different environments (e.g., "env=prod", "env=qa").
Label keys and values can be no longer than 63 characters and can only
contain lowercase letters, numeric characters, underscores, dashes, and
international characters. Label keys must start with a lowercase letter
or an international character. Each service can have at most 32 labels.
#name
defname()->::String
Returns
(::String) — Full path to the Service resource in the API.
Example: apps/myapp/services/default.
#name=
defname=(value)->::String
Parameter
value (::String) — Full path to the Service resource in the API.
Example: apps/myapp/services/default.
Returns
(::String) — Full path to the Service resource in the API.
Example: apps/myapp/services/default.
[[["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::Service (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-Service)\n- [1.2.1](/ruby/docs/reference/google-cloud-app_engine-v1/1.2.1/Google-Cloud-AppEngine-V1-Service)\n- [1.1.0](/ruby/docs/reference/google-cloud-app_engine-v1/1.1.0/Google-Cloud-AppEngine-V1-Service)\n- [1.0.1](/ruby/docs/reference/google-cloud-app_engine-v1/1.0.1/Google-Cloud-AppEngine-V1-Service)\n- [0.10.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.10.0/Google-Cloud-AppEngine-V1-Service)\n- [0.9.2](/ruby/docs/reference/google-cloud-app_engine-v1/0.9.2/Google-Cloud-AppEngine-V1-Service)\n- [0.8.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.8.0/Google-Cloud-AppEngine-V1-Service)\n- [0.7.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.7.0/Google-Cloud-AppEngine-V1-Service)\n- [0.6.1](/ruby/docs/reference/google-cloud-app_engine-v1/0.6.1/Google-Cloud-AppEngine-V1-Service)\n- [0.5.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.5.0/Google-Cloud-AppEngine-V1-Service)\n- [0.4.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.4.0/Google-Cloud-AppEngine-V1-Service)\n- [0.3.6](/ruby/docs/reference/google-cloud-app_engine-v1/0.3.6/Google-Cloud-AppEngine-V1-Service) \nReference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::Service.\n\nA Service resource is a logical component of an application that can share\nstate and communicate in a secure fashion with other services.\nFor example, an application that handles customer requests might\ninclude separate services to handle tasks such as backend data\nanalysis or API requests from mobile devices. Each service has a\ncollection of versions that define a specific set of code used to\nimplement the functionality of that service. \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### #id\n\n def id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Relative name of the service within the application. Example: `default`.\n\n### #id=\n\n def id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Relative name of the service within the application. Example: `default`. \n**Returns**\n\n- (::String) --- Relative name of the service within the application. Example: `default`.\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., \"env=prod\", \"env=qa\").\n\n \u003cbr /\u003e\n\n Label keys and values can be no longer than 63 characters and can only\n contain lowercase letters, numeric characters, underscores, dashes, and\n international characters. Label keys must start with a lowercase letter\n or an international character. Each service can have at most 32 labels.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., \"env=prod\", \"env=qa\").\n\n\n \u003cbr /\u003e\n\n Label keys and values can be no longer than 63 characters and can only\n contain lowercase letters, numeric characters, underscores, dashes, and\n international characters. Label keys must start with a lowercase letter\nor an international character. Each service can have at most 32 labels. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., \"env=prod\", \"env=qa\").\n\n \u003cbr /\u003e\n\n Label keys and values can be no longer than 63 characters and can only\n contain lowercase letters, numeric characters, underscores, dashes, and\n international characters. Label keys must start with a lowercase letter\n or an international character. Each service can have at most 32 labels.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Full path to the Service resource in the API. Example: `apps/myapp/services/default`.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Full path to the Service resource in the API. Example: `apps/myapp/services/default`. \n**Returns**\n\n- (::String) --- Full path to the Service resource in the API. Example: `apps/myapp/services/default`.\n\n### #network_settings\n\n def network_settings() -\u003e ::Google::Cloud::AppEngine::V1::NetworkSettings\n\n**Returns**\n\n- ([::Google::Cloud::AppEngine::V1::NetworkSettings](./Google-Cloud-AppEngine-V1-NetworkSettings)) --- Ingress settings for this service. Will apply to all versions.\n\n### #network_settings=\n\n def network_settings=(value) -\u003e ::Google::Cloud::AppEngine::V1::NetworkSettings\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AppEngine::V1::NetworkSettings](./Google-Cloud-AppEngine-V1-NetworkSettings)) --- Ingress settings for this service. Will apply to all versions. \n**Returns**\n\n- ([::Google::Cloud::AppEngine::V1::NetworkSettings](./Google-Cloud-AppEngine-V1-NetworkSettings)) --- Ingress settings for this service. Will apply to all versions.\n\n### #split\n\n def split() -\u003e ::Google::Cloud::AppEngine::V1::TrafficSplit\n\n**Returns**\n\n- ([::Google::Cloud::AppEngine::V1::TrafficSplit](./Google-Cloud-AppEngine-V1-TrafficSplit)) --- Mapping that defines fractional HTTP traffic diversion to different versions within the service.\n\n### #split=\n\n def split=(value) -\u003e ::Google::Cloud::AppEngine::V1::TrafficSplit\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AppEngine::V1::TrafficSplit](./Google-Cloud-AppEngine-V1-TrafficSplit)) --- Mapping that defines fractional HTTP traffic diversion to different versions within the service. \n**Returns**\n\n- ([::Google::Cloud::AppEngine::V1::TrafficSplit](./Google-Cloud-AppEngine-V1-TrafficSplit)) --- Mapping that defines fractional HTTP traffic diversion to different versions within the service."]]
