public static final class Service.Builder extends GeneratedMessageV3.Builder<Service.Builder> implements ServiceOrBuilderA 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
ServiceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Service.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
build()
public Service build()| Returns | |
|---|---|
| Type | Description |
Service |
|
buildPartial()
public Service buildPartial()| Returns | |
|---|---|
| Type | Description |
Service |
|
clear()
public Service.Builder clear()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Service.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearId()
public Service.Builder clearId() Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
clearLabels()
public Service.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearName()
public Service.Builder clearName() 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()
public Service.Builder clearNetworkSettings()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)
public Service.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
clearSplit()
public Service.Builder clearSplit()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()
public Service.Builder clone()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
containsLabels(String key)
public boolean containsLabels(String key)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()
public Service getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Service |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getId()
public String getId() Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The id. |
getIdBytes()
public ByteString getIdBytes() Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for id. |
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public int getLabelsCount()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()
public Map<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)
public String getLabelsOrDefault(String key, String defaultValue)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)
public String getLabelsOrThrow(String key)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() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public String getName() 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()
public ByteString getNameBytes() 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()
public NetworkSettings getNetworkSettings()Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Returns | |
|---|---|
| Type | Description |
NetworkSettings |
The networkSettings. |
getNetworkSettingsBuilder()
public NetworkSettings.Builder getNetworkSettingsBuilder()Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Returns | |
|---|---|
| Type | Description |
NetworkSettings.Builder |
|
getNetworkSettingsOrBuilder()
public NetworkSettingsOrBuilder getNetworkSettingsOrBuilder()Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
| Returns | |
|---|---|
| Type | Description |
NetworkSettingsOrBuilder |
|
getSplit()
public TrafficSplit getSplit()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()
public TrafficSplit.Builder getSplitBuilder()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()
public TrafficSplitOrBuilder getSplitOrBuilder()Mapping that defines fractional HTTP traffic diversion to different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
| Returns | |
|---|---|
| Type | Description |
TrafficSplitOrBuilder |
|
hasNetworkSettings()
public boolean hasNetworkSettings()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()
public boolean hasSplit()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()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Service other)
public Service.Builder mergeFrom(Service other)| Parameter | |
|---|---|
| Name | Description |
other |
Service |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Service.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Service.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
mergeNetworkSettings(NetworkSettings value)
public Service.Builder mergeNetworkSettings(NetworkSettings value)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)
public Service.Builder mergeSplit(TrafficSplit value)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)
public final Service.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
putAllLabels(Map<String,String> values)
public Service.Builder putAllLabels(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)
public Service.Builder putLabels(String key, String value)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)
public Service.Builder removeLabels(String key)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)
public Service.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setId(String value)
public Service.Builder setId(String value) Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe id to set. |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
setIdBytes(ByteString value)
public Service.Builder setIdBytes(ByteString value) Relative name of the service within the application.
Example: default.
@OutputOnly
string id = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for id to set. |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
setName(String value)
public Service.Builder setName(String value) Full path to the Service resource in the API.
Example: apps/myapp/services/default.
@OutputOnly
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Service.Builder setNameBytes(ByteString value) Full path to the Service resource in the API.
Example: apps/myapp/services/default.
@OutputOnly
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
This builder for chaining. |
setNetworkSettings(NetworkSettings value)
public Service.Builder setNetworkSettings(NetworkSettings value)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)
public Service.Builder setNetworkSettings(NetworkSettings.Builder builderForValue)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)
public Service.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
setSplit(TrafficSplit value)
public Service.Builder setSplit(TrafficSplit value)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)
public Service.Builder setSplit(TrafficSplit.Builder builderForValue)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)
public final Service.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|