Interface ServiceOrBuilder (2.45.0)

public interface ServiceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

getId()

public abstract String getId()

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

@OutputOnly

string id = 2;

Returns
Type Description
String

The id.

getIdBytes()

public abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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()

public abstract 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 abstract 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 abstract 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.

getNetworkSettingsOrBuilder()

public abstract 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 abstract 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.

getSplitOrBuilder()

public abstract 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 abstract 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 abstract 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.