Google Cloud Appengine Admin V1 Client - Class EndpointsApiService (1.2.1)

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

Generated from protobuf message google.appengine.v1.EndpointsApiService

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 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.

↳ rollout_strategy int

Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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 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
TypeDescription
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 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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRolloutStrategy

Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.

Returns
TypeDescription
int

setRolloutStrategy

Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDisableTraceSampling

Enable or disable trace sampling. By default, this is set to false for enabled.

Returns
TypeDescription
bool

setDisableTraceSampling

Enable or disable trace sampling. By default, this is set to false for enabled.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this