publicfinalclass ServiceextendsGeneratedMessageV3implementsServiceOrBuilder
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
ID_FIELD_NUMBER
publicstaticfinalintID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
LABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NETWORK_SETTINGS_FIELD_NUMBER
publicstaticfinalintNETWORK_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SPLIT_FIELD_NUMBER
publicstaticfinalintSPLIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticServicegetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticService.BuildernewBuilder()
newBuilder(Service prototype)
publicstaticService.BuildernewBuilder(Serviceprototype)
| Parameter |
| Name |
Description |
prototype |
Service
|
publicstaticServiceparseDelimitedFrom(InputStreaminput)
publicstaticServiceparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticServiceparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticServiceparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticServiceparseFrom(CodedInputStreaminput)
publicstaticServiceparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticServiceparseFrom(InputStreaminput)
publicstaticServiceparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticServiceparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<Service>parser()
Methods
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
|
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
publicServicegetDefaultInstanceForType()
getId()
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()
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;
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;
| 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 |
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()
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;
getNetworkSettingsOrBuilder()
publicNetworkSettingsOrBuildergetNetworkSettingsOrBuilder()
Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
getParserForType()
publicParser<Service>getParserForType()
Overrides
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getSplit()
publicTrafficSplitgetSplit()
Mapping that defines fractional HTTP traffic diversion to
different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
getSplitOrBuilder()
publicTrafficSplitOrBuildergetSplitOrBuilder()
Mapping that defines fractional HTTP traffic diversion to
different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
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()
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicService.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedService.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicService.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides