Class EndpointsApiService.Builder (2.28.0)

Version 2.28.0

• 2.53.0 (latest)
• 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

public static final class EndpointsApiService.Builder extends GeneratedMessageV3.Builder<EndpointsApiService.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EndpointsApiService.Builder

Implements

EndpointsApiServiceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EndpointsApiService.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public EndpointsApiService build()

Returns
Type	Description
EndpointsApiService

buildPartial()

public EndpointsApiService buildPartial()

Returns
Type	Description
EndpointsApiService

clear()

public EndpointsApiService.Builder clear()

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConfigId()

public EndpointsApiService.Builder clearConfigId()

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
EndpointsApiService.Builder	This builder for chaining.

clearDisableTraceSampling()

public EndpointsApiService.Builder clearDisableTraceSampling()

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)

public EndpointsApiService.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public EndpointsApiService.Builder clearName()

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)

public EndpointsApiService.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRolloutStrategy()

public EndpointsApiService.Builder clearRolloutStrategy()

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

public EndpointsApiService.Builder clone()

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(EndpointsApiService other)

public EndpointsApiService.Builder mergeFrom(EndpointsApiService other)

Parameter
Name	Description
other	EndpointsApiService

Returns
Type	Description
EndpointsApiService.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EndpointsApiService.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EndpointsApiService.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public EndpointsApiService.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
EndpointsApiService.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EndpointsApiService.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setConfigId(String value)

public EndpointsApiService.Builder setConfigId(String value)

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;

Parameter
Name	Description
value	String The configId to set.

Returns
Type	Description
EndpointsApiService.Builder	This builder for chaining.

setConfigIdBytes(ByteString value)

public EndpointsApiService.Builder setConfigIdBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for configId to set.

Returns
Type	Description
EndpointsApiService.Builder	This builder for chaining.

setDisableTraceSampling(boolean value)

public EndpointsApiService.Builder setDisableTraceSampling(boolean value)

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)

public EndpointsApiService.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public EndpointsApiService.Builder setName(String value)

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)

public EndpointsApiService.Builder setNameBytes(ByteString value)

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)

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRolloutStrategy(EndpointsApiService.RolloutStrategy value)

public EndpointsApiService.Builder setRolloutStrategy(EndpointsApiService.RolloutStrategy value)

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)

public EndpointsApiService.Builder setRolloutStrategyValue(int value)

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)

public final EndpointsApiService.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
EndpointsApiService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)