public final class Service extends GeneratedMessageV3 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
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>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NETWORK_SETTINGS_FIELD_NUMBER
public static final int NETWORK_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SPLIT_FIELD_NUMBER
public static final int SPLIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Service getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Service.Builder newBuilder()
newBuilder(Service prototype)
public static Service.Builder newBuilder(Service prototype)
| Parameter |
| Name |
Description |
prototype |
Service
|
public static Service parseDelimitedFrom(InputStream input)
public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Service parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Service parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(CodedInputStream input)
public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(InputStream input)
public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Service parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Service> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Service getDefaultInstanceForType()
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()
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;
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;
| 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 |
|
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;
getNetworkSettingsOrBuilder()
public NetworkSettingsOrBuilder getNetworkSettingsOrBuilder()
Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
getParserForType()
public Parser<Service> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSplit()
public TrafficSplit getSplit()
Mapping that defines fractional HTTP traffic diversion to
different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
getSplitOrBuilder()
public TrafficSplitOrBuilder getSplitOrBuilder()
Mapping that defines fractional HTTP traffic diversion to
different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Service.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Service.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Service.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
