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
Static Fields
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NETWORK_SETTINGS_FIELD_NUMBER
public static final int NETWORK_SETTINGS_FIELD_NUMBER
Field Value
SPLIT_FIELD_NUMBER
public static final int SPLIT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Service getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Service.Builder newBuilder()
Returns
newBuilder(Service prototype)
public static Service.Builder newBuilder(Service prototype)
Parameter
Returns
public static Service parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Service parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Service parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Service parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Service parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Service parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Service> parser()
Returns
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
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Service getDefaultInstanceForType()
Returns
getId()
Relative name of the service within the application.
Example: default
.
@OutputOnly
string id = 2;
Returns
getIdBytes()
public ByteString getIdBytes()
Relative name of the service within the application.
Example: default
.
@OutputOnly
string id = 2;
Returns
getLabels()
public Map<String,String> getLabels()
Returns
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
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
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
Returns
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
Returns
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
getNetworkSettings()
public NetworkSettings getNetworkSettings()
Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
Returns
getNetworkSettingsOrBuilder()
public NetworkSettingsOrBuilder getNetworkSettingsOrBuilder()
Ingress settings for this service. Will apply to all versions.
.google.appengine.v1.NetworkSettings network_settings = 6;
Returns
getParserForType()
public Parser<Service> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSplit()
public TrafficSplit getSplit()
Mapping that defines fractional HTTP traffic diversion to
different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
Returns
getSplitOrBuilder()
public TrafficSplitOrBuilder getSplitOrBuilder()
Mapping that defines fractional HTTP traffic diversion to
different versions within the service.
.google.appengine.v1.TrafficSplit split = 3;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Service.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Service.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Service.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions