App Engine v1 API - Class EndpointsApiService (2.3.0)

public sealed class EndpointsApiService : IMessage<EndpointsApiService>, IEquatable<EndpointsApiService>, IDeepCloneable<EndpointsApiService>, IBufferMessage, IMessage

Reference documentation and code samples for the App Engine v1 API 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.

Inheritance

object > EndpointsApiService

Implements

IMessage EndpointsApiService, IEquatable EndpointsApiService, IDeepCloneable EndpointsApiService, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

EndpointsApiService()

public EndpointsApiService()

EndpointsApiService(EndpointsApiService)

public EndpointsApiService(EndpointsApiService other)

Parameter
Name	Description
`other`	`EndpointsApiService`

Properties

ConfigId

public string ConfigId { get; set; }

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.

Property Value
Type	Description
`string`

DisableTraceSampling

public bool DisableTraceSampling { get; set; }

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

Property Value
Type	Description
`bool`

Name

public string Name { get; set; }

Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"

Property Value
Type	Description
`string`

RolloutStrategy

public EndpointsApiService.Types.RolloutStrategy RolloutStrategy { get; set; }

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

Property Value
Type	Description
`EndpointsApiServiceTypesRolloutStrategy`