Class Service.Builder (2.17.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 Service.BuilderextendsGeneratedMessageV3.Builder<Service.Builder>implementsServiceOrBuilderA Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
Protobuf type google.appengine.v1.Service
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Service.BuilderImplements
ServiceOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicService.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
build()
publicServicebuild()| Returns | |
|---|---|
| Type | Description |
Service |
|
buildPartial()
publicServicebuildPartial()| Returns | |
|---|---|
| Type | Description |
Service |
|
clear()
publicService.Builderclear()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearField(Descriptors.FieldDescriptor field)
publicService.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearId()
publicService.BuilderclearId() Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
clearLabels()
publicService.BuilderclearLabels()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearName()
publicService.BuilderclearName() Full path to the Service resource in the API.
Example: apps/myapp/services/default.
@OutputOnly
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
clearNetworkSettings()
publicService.BuilderclearNetworkSettings()Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
publicService.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearSplit()
publicService.BuilderclearSplit()Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clone()
publicService.Builderclone()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). <p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
publicServicegetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Service |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getId()
publicStringgetId() Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The id. |
getIdBytes()
publicByteStringgetIdBytes() Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for id. |
getLabels()
publicMap<String,String>getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
publicintgetLabelsCount()A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). <p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
map<string, string> labels = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
publicMap<String,String>getLabelsMap()A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). <p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
map<string, string> labels = 4;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). <p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
map<string, string> labels = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). <p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMutableLabels()
publicMap<String,String>getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
publicStringgetName() Full path to the Service resource in the API.
Example: apps/myapp/services/default.
@OutputOnly
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
publicByteStringgetNameBytes() Full path to the Service resource in the API.
Example: apps/myapp/services/default.
@OutputOnly
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNetworkSettings()
publicNetworkSettingsgetNetworkSettings()Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Returns | |
|---|---|
| Type | Description |
NetworkSettings |
The networkSettings. |
getNetworkSettingsBuilder()
publicNetworkSettings.BuildergetNetworkSettingsBuilder()Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Returns | |
|---|---|
| Type | Description |
NetworkSettings.Builder |
|
getNetworkSettingsOrBuilder()
publicNetworkSettingsOrBuildergetNetworkSettingsOrBuilder()Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Returns | |
|---|---|
| Type | Description |
NetworkSettingsOrBuilder |
|
getSplit()
publicTrafficSplitgetSplit()Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Returns | |
|---|---|
| Type | Description |
TrafficSplit |
The split. |
getSplitBuilder()
publicTrafficSplit.BuildergetSplitBuilder()Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Returns | |
|---|---|
| Type | Description |
TrafficSplit.Builder |
|
getSplitOrBuilder()
publicTrafficSplitOrBuildergetSplitOrBuilder()Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Returns | |
|---|---|
| Type | Description |
TrafficSplitOrBuilder |
|
hasNetworkSettings()
publicbooleanhasNetworkSettings()Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the networkSettings field is set. |
hasSplit()
publicbooleanhasSplit()Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the split field is set. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
internalGetMutableMapField(int number)
protectedMapFieldinternalGetMutableMapField(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Service other)
publicService.BuildermergeFrom(Serviceother)| Parameter | |
|---|---|
| Name | Description |
other |
Service |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicService.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicService.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
mergeNetworkSettings(NetworkSettings value)
publicService.BuildermergeNetworkSettings(NetworkSettingsvalue)Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
NetworkSettings |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
mergeSplit(TrafficSplit value)
publicService.BuildermergeSplit(TrafficSplitvalue)Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
TrafficSplit |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalService.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
putAllLabels(Map<String,String> values)
publicService.BuilderputAllLabels(Map<String,String>values)A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). <p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
putLabels(String key, String value)
publicService.BuilderputLabels(Stringkey,Stringvalue)A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). <p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
map<string, string> labels = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
removeLabels(String key)
publicService.BuilderremoveLabels(Stringkey)A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). <p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
publicService.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setId(String value)
publicService.BuildersetId(Stringvalue) Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
String The id to set. |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
setIdBytes(ByteString value)
publicService.BuildersetIdBytes(ByteStringvalue) Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for id to set. |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
setName(String value)
publicService.BuildersetName(Stringvalue) Full path to the Service resource in the API.
Example: apps/myapp/services/default.
@OutputOnly
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
String The name to set. |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
publicService.BuildersetNameBytes(ByteStringvalue) Full path to the Service resource in the API.
Example: apps/myapp/services/default.
@OutputOnly
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
setNetworkSettings(NetworkSettings value)
publicService.BuildersetNetworkSettings(NetworkSettingsvalue)Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
NetworkSettings |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setNetworkSettings(NetworkSettings.Builder builderForValue)
publicService.BuildersetNetworkSettings(NetworkSettings.BuilderbuilderForValue)Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
NetworkSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicService.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setSplit(TrafficSplit value)
publicService.BuildersetSplit(TrafficSplitvalue)Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
TrafficSplit |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setSplit(TrafficSplit.Builder builderForValue)
publicService.BuildersetSplit(TrafficSplit.BuilderbuilderForValue)Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TrafficSplit.Builder |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalService.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|