Class EndpointsApiService (2.55.0) 

public final class EndpointsApiService extends GeneratedMessageV3 implements EndpointsApiServiceOrBuilder

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.

Protobuf type google.appengine.v1.EndpointsApiService

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EndpointsApiService

Static Fields

CONFIG_ID_FIELD_NUMBER

public static final int CONFIG_ID_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_TRACE_SAMPLING_FIELD_NUMBER

public static final int DISABLE_TRACE_SAMPLING_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ROLLOUT_STRATEGY_FIELD_NUMBER

public static final int ROLLOUT_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EndpointsApiService getDefaultInstance()
Returns
Type Description
EndpointsApiService

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EndpointsApiService.Builder newBuilder()
Returns
Type Description
EndpointsApiService.Builder

newBuilder(EndpointsApiService prototype)

public static EndpointsApiService.Builder newBuilder(EndpointsApiService prototype)
Parameter
Name Description
prototype EndpointsApiService
Returns
Type Description
EndpointsApiService.Builder

parseDelimitedFrom(InputStream input)

public static EndpointsApiService parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EndpointsApiService parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EndpointsApiService parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EndpointsApiService parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EndpointsApiService parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EndpointsApiService parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EndpointsApiService parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EndpointsApiService parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EndpointsApiService parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EndpointsApiService parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EndpointsApiService parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EndpointsApiService parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EndpointsApiService
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EndpointsApiService> parser()
Returns
Type Description
Parser<EndpointsApiService>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfigId()

public String 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.

string config_id = 2;

Returns
Type Description
String

The configId.

getConfigIdBytes()

public ByteString getConfigIdBytes()

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.

string config_id = 2;

Returns
Type Description
ByteString

The bytes for configId.

getDefaultInstanceForType()

public EndpointsApiService getDefaultInstanceForType()
Returns
Type Description
EndpointsApiService

getDisableTraceSampling()

public boolean getDisableTraceSampling()

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

bool disable_trace_sampling = 4;

Returns
Type Description
boolean

The disableTraceSampling.

getName()

public String getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<EndpointsApiService> getParserForType()
Returns
Type Description
Parser<EndpointsApiService>
Overrides

getRolloutStrategy()

public EndpointsApiService.RolloutStrategy getRolloutStrategy()

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

.google.appengine.v1.EndpointsApiService.RolloutStrategy rollout_strategy = 3;

Returns
Type Description
EndpointsApiService.RolloutStrategy

The rolloutStrategy.

getRolloutStrategyValue()

public int getRolloutStrategyValue()

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

.google.appengine.v1.EndpointsApiService.RolloutStrategy rollout_strategy = 3;

Returns
Type Description
int

The enum numeric value on the wire for rolloutStrategy.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EndpointsApiService.Builder newBuilderForType()
Returns
Type Description
EndpointsApiService.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EndpointsApiService.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EndpointsApiService.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EndpointsApiService.Builder toBuilder()
Returns
Type Description
EndpointsApiService.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException