Class Service.Builder (2.20.0)

public static final class Service.Builder extends GeneratedMessageV3.Builder<Service.Builder> implements ServiceOrBuilder

A 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

Implements

ServiceOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Service build()
Returns
TypeDescription
Service

buildPartial()

public Service buildPartial()
Returns
TypeDescription
Service

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearId()

public Service.Builder clearId()

Relative name of the service within the application. Example: default.

@OutputOnly

string id = 2;

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearLabels()

public Service.Builder clearLabels()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Service.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

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

clone()

public Service.Builder clone()
Returns
TypeDescription
Service.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public Service getDefaultInstanceForType()
Returns
TypeDescription
Service

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getId()

public String getId()

Relative name of the service within the application. Example: default.

@OutputOnly

string id = 2;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

Relative name of the service within the application. Example: default.

@OutputOnly

string id = 2;

Returns
TypeDescription
ByteString

The bytes for id.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
NetworkSettings.Builder

getNetworkSettingsOrBuilder()

public NetworkSettingsOrBuilder getNetworkSettingsOrBuilder()

Ingress settings for this service. Will apply to all versions.

.google.appengine.v1.NetworkSettings network_settings = 6;

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

hasNetworkSettings()

public boolean hasNetworkSettings()

Ingress settings for this service. Will apply to all versions.

.google.appengine.v1.NetworkSettings network_settings = 6;

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

Whether the split field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Service other)

public Service.Builder mergeFrom(Service other)
Parameter
NameDescription
otherService
Returns
TypeDescription
Service.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

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
NameDescription
valueNetworkSettings
Returns
TypeDescription
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
NameDescription
valueTrafficSplit
Returns
TypeDescription
Service.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
Service.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setId(String value)

public Service.Builder setId(String value)

Relative name of the service within the application. Example: default.

@OutputOnly

string id = 2;

Parameter
NameDescription
valueString

The id to set.

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

The bytes for id to set.

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

The name to set.

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

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueNetworkSettings
Returns
TypeDescription
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
NameDescription
builderForValueNetworkSettings.Builder
Returns
TypeDescription
Service.Builder

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

public Service.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Service.Builder
Overrides

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
NameDescription
valueTrafficSplit
Returns
TypeDescription
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
NameDescription
builderForValueTrafficSplit.Builder
Returns
TypeDescription
Service.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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