com.google.api.services.appengine.v1.model

Class Service

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.appengine.v1.model.Service

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Service
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the App Engine Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Service()

Method Summary

Modifier and Type	Method and Description
Service	clone()
Map<String,Object>	getGeneratedCustomerMetadata() Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
String	getId() Relative name of the service within the application.
Map<String,String>	getLabels() A set of labels to apply to this service.
String	getName() Full path to the Service resource in the API.
NetworkSettings	getNetworkSettings() Ingress settings for this service.
TrafficSplit	getSplit() Mapping that defines fractional HTTP traffic diversion to different versions within the service.
Service	set(String fieldName, Object value)
Service	setGeneratedCustomerMetadata(Map<String,Object> generatedCustomerMetadata) Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
Service	setId(String id) Relative name of the service within the application.
Service	setLabels(Map<String,String> labels) A set of labels to apply to this service.
Service	setName(String name) Full path to the Service resource in the API.
Service	setNetworkSettings(NetworkSettings networkSettings) Ingress settings for this service.
Service	setSplit(TrafficSplit split) Mapping that defines fractional HTTP traffic diversion to different versions within the service.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Service

public Service()

Method Detail

getGeneratedCustomerMetadata

public Map<String,Object> getGeneratedCustomerMetadata()

Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest

Returns:

value or null for none

setGeneratedCustomerMetadata

public Service setGeneratedCustomerMetadata(Map<String,Object> generatedCustomerMetadata)

Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest

Parameters:

generatedCustomerMetadata - generatedCustomerMetadata or null for none

getId

public String getId()

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

Returns:

value or null for none

setId

public Service setId(String id)

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

Parameters:

id - id or null for none

getLabels

public Map<String,String> getLabels()

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"). 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.

Returns:

value or null for none

setLabels

public Service setLabels(Map<String,String> labels)

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"). 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.

Parameters:

labels - labels or null for none

getName

public String getName()

Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly

Returns:

value or null for none

setName

public Service setName(String name)

Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly

Parameters:

name - name or null for none

getNetworkSettings

public NetworkSettings getNetworkSettings()

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

Returns:

value or null for none

setNetworkSettings

public Service setNetworkSettings(NetworkSettings networkSettings)

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

Parameters:

networkSettings - networkSettings or null for none

getSplit

public TrafficSplit getSplit()

Mapping that defines fractional HTTP traffic diversion to different versions within the service.

Returns:

value or null for none

setSplit

public Service setSplit(TrafficSplit split)

Mapping that defines fractional HTTP traffic diversion to different versions within the service.

Parameters:

split - split or null for none

set

public Service set(String fieldName,
                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Service clone()

Overrides:

clone in class com.google.api.client.json.GenericJson