Google Cloud Appengine Admin V1 Client - Class Service (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class 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.

Generated from protobuf message google.appengine.v1.Service

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Full path to the Service resource in the API. Example: apps/myapp/services/default. @OutputOnly

↳ id string

Relative name of the service within the application. Example: default. @OutputOnly

↳ split Google\Cloud\AppEngine\V1\TrafficSplit

Mapping that defines fractional HTTP traffic diversion to different versions within the service.

↳ labels array|Google\Protobuf\Internal\MapField

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.

↳ network_settings Google\Cloud\AppEngine\V1\NetworkSettings

Ingress settings for this service. Will apply to all versions.

getName

Full path to the Service resource in the API.

Example: apps/myapp/services/default. @OutputOnly

Returns
Type Description
string

setName

Full path to the Service resource in the API.

Example: apps/myapp/services/default. @OutputOnly

Parameter
Name Description
var string
Returns
Type Description
$this

getId

Relative name of the service within the application.

Example: default. @OutputOnly

Returns
Type Description
string

setId

Relative name of the service within the application.

Example: default. @OutputOnly

Parameter
Name Description
var string
Returns
Type Description
$this

getSplit

Mapping that defines fractional HTTP traffic diversion to different versions within the service.

Returns
Type Description
Google\Cloud\AppEngine\V1\TrafficSplit|null

hasSplit

clearSplit

setSplit

Mapping that defines fractional HTTP traffic diversion to different versions within the service.

Parameter
Name Description
var Google\Cloud\AppEngine\V1\TrafficSplit
Returns
Type Description
$this

getLabels

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
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getNetworkSettings

Ingress settings for this service. Will apply to all versions.

Returns
Type Description
Google\Cloud\AppEngine\V1\NetworkSettings|null

hasNetworkSettings

clearNetworkSettings

setNetworkSettings

Ingress settings for this service. Will apply to all versions.

Parameter
Name Description
var Google\Cloud\AppEngine\V1\NetworkSettings
Returns
Type Description
$this