Class EndpointsApiService.Builder (2.55.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.78.0 (latest)
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.4
- 2.2.0
- 2.1.10
- 0.2.0
publicstaticfinalclass EndpointsApiService.BuilderextendsGeneratedMessageV3.Builder<EndpointsApiService.Builder>implementsEndpointsApiServiceOrBuilderCloud 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EndpointsApiService.BuilderImplements
EndpointsApiServiceOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicEndpointsApiService.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
build()
publicEndpointsApiServicebuild()| Returns | |
|---|---|
| Type | Description |
EndpointsApiService |
|
buildPartial()
publicEndpointsApiServicebuildPartial()| Returns | |
|---|---|
| Type | Description |
EndpointsApiService |
|
clear()
publicEndpointsApiService.Builderclear()| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
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 |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
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 |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
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 |
EndpointsApiService.Builder |
|
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 |
EndpointsApiService |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
EndpointsApiService.RolloutStrategy |
The rolloutStrategy. |
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 |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(EndpointsApiService other)
publicEndpointsApiService.BuildermergeFrom(EndpointsApiServiceother)| Parameter | |
|---|---|
| Name | Description |
other |
EndpointsApiService |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicEndpointsApiService.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicEndpointsApiService.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalEndpointsApiService.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
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 |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
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 |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
EndpointsApiService.Builder |
|
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 |
EndpointsApiService.Builder |
|