Class EndpointsApiService.Builder (2.32.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EndpointsApiService.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EndpointsApiService.Builder
Overrides

build()

public EndpointsApiService build()
Returns
TypeDescription
EndpointsApiService

buildPartial()

public EndpointsApiService buildPartial()
Returns
TypeDescription
EndpointsApiService

clear()

public EndpointsApiService.Builder clear()
Returns
TypeDescription
EndpointsApiService.Builder
Overrides

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public EndpointsApiService.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
EndpointsApiService.Builder
Overrides

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EndpointsApiService.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
EndpointsApiService.Builder
Overrides

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

This builder for chaining.

clone()

public EndpointsApiService.Builder clone()
Returns
TypeDescription
EndpointsApiService.Builder
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
TypeDescription
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
TypeDescription
ByteString

The bytes for configId.

getDefaultInstanceForType()

public EndpointsApiService getDefaultInstanceForType()
Returns
TypeDescription
EndpointsApiService

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisableTraceSampling()

public boolean getDisableTraceSampling()

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

bool disable_trace_sampling = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for rolloutStrategy.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(EndpointsApiService other)

public EndpointsApiService.Builder mergeFrom(EndpointsApiService other)
Parameter
NameDescription
otherEndpointsApiService
Returns
TypeDescription
EndpointsApiService.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EndpointsApiService.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EndpointsApiService.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public EndpointsApiService.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
EndpointsApiService.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EndpointsApiService.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EndpointsApiService.Builder
Overrides

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
NameDescription
valueString

The configId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for configId to set.

Returns
TypeDescription
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
NameDescription
valueboolean

The disableTraceSampling to set.

Returns
TypeDescription
EndpointsApiService.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public EndpointsApiService.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EndpointsApiService.Builder
Overrides

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
EndpointsApiService.Builder
Overrides

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
NameDescription
valueEndpointsApiService.RolloutStrategy

The rolloutStrategy to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
EndpointsApiService.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final EndpointsApiService.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EndpointsApiService.Builder
Overrides