Class EndpointsApiService.Builder (2.3.4)

publicstaticfinalclass EndpointsApiService.BuilderextendsGeneratedMessageV3.Builder<EndpointsApiService.Builder>implementsEndpointsApiServiceOrBuilder

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

Inherited Members

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicEndpointsApiService.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

build()

publicEndpointsApiServicebuild()
Returns
Type Description

buildPartial()

publicEndpointsApiServicebuildPartial()
Returns
Type Description

clear()

publicEndpointsApiService.Builderclear()
Returns
Type Description
Overrides

clearConfigId()

publicEndpointsApiService.BuilderclearConfigId()

Endpoints service configuration ID as specified by the Service Management API. For example "2016年09月19日r1". 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
EndpointsApiService.Builder

This builder for chaining.

clearDisableTraceSampling()

publicEndpointsApiService.BuilderclearDisableTraceSampling()

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

bool disable_trace_sampling = 4;

Returns
Type Description
EndpointsApiService.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

publicEndpointsApiService.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
Returns
Type Description
Overrides

clearName()

publicEndpointsApiService.BuilderclearName()

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
EndpointsApiService.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

publicEndpointsApiService.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
Returns
Type Description
Overrides

clearRolloutStrategy()

publicEndpointsApiService.BuilderclearRolloutStrategy()

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.Builder

This builder for chaining.

clone()

publicEndpointsApiService.Builderclone()
Returns
Type Description
Overrides

getConfigId()

publicStringgetConfigId()

Endpoints service configuration ID as specified by the Service Management API. For example "2016年09月19日r1". 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()

publicByteStringgetConfigIdBytes()

Endpoints service configuration ID as specified by the Service Management API. For example "2016年09月19日r1". 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()

publicEndpointsApiServicegetDefaultInstanceForType()
Returns
Type Description

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Overrides

getDisableTraceSampling()

publicbooleangetDisableTraceSampling()

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()

publicStringgetName()

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()

publicByteStringgetNameBytes()

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.

getRolloutStrategy()

publicEndpointsApiService.RolloutStrategygetRolloutStrategy()

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

getRolloutStrategyValue()

publicintgetRolloutStrategyValue()

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.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

mergeFrom(EndpointsApiService other)

publicEndpointsApiService.BuildermergeFrom(EndpointsApiServiceother)
Parameter
Name Description
Returns
Type Description

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicEndpointsApiService.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overrides Exceptions
Type Description

mergeFrom(Message other)

publicEndpointsApiService.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalEndpointsApiService.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

setConfigId(String value)

publicEndpointsApiService.BuildersetConfigId(Stringvalue)

Endpoints service configuration ID as specified by the Service Management API. For example "2016年09月19日r1". 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;

Parameter
Name Description
value String

The configId to set.

Returns
Type Description
EndpointsApiService.Builder

This builder for chaining.

setConfigIdBytes(ByteString value)

publicEndpointsApiService.BuildersetConfigIdBytes(ByteStringvalue)

Endpoints service configuration ID as specified by the Service Management API. For example "2016年09月19日r1". 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;

Parameter
Name Description
value ByteString

The bytes for configId to set.

Returns
Type Description
EndpointsApiService.Builder

This builder for chaining.

setDisableTraceSampling(boolean value)

publicEndpointsApiService.BuildersetDisableTraceSampling(booleanvalue)

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

bool disable_trace_sampling = 4;

Parameter
Name Description
value boolean

The disableTraceSampling to set.

Returns
Type Description
EndpointsApiService.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

publicEndpointsApiService.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

setName(String value)

publicEndpointsApiService.BuildersetName(Stringvalue)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
EndpointsApiService.Builder

This builder for chaining.

setNameBytes(ByteString value)

publicEndpointsApiService.BuildersetNameBytes(ByteStringvalue)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
EndpointsApiService.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicEndpointsApiService.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
index int
value Object
Returns
Type Description
Overrides

setRolloutStrategy(EndpointsApiService.RolloutStrategy value)

publicEndpointsApiService.BuildersetRolloutStrategy(EndpointsApiService.RolloutStrategyvalue)

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;

Parameter
Name Description
value EndpointsApiService.RolloutStrategy

The rolloutStrategy to set.

Returns
Type Description
EndpointsApiService.Builder

This builder for chaining.

setRolloutStrategyValue(int value)

publicEndpointsApiService.BuildersetRolloutStrategyValue(intvalue)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for rolloutStrategy to set.

Returns
Type Description
EndpointsApiService.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalEndpointsApiService.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.