com.google.api.services.run.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.run.v1.model.Service

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Service acts as a top-level container that manages a set of Routes and Configurations which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets). The Service's controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.

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 Cloud Run 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()
String	getApiVersion() The API version for this call.
String	getKind() The kind of resource.
ObjectMeta	getMetadata() Metadata associated with this Service, including name, namespace, labels, and annotations.
ServiceSpec	getSpec() Holds the desired state of the Service (from the client).
ServiceStatus	getStatus() Communicates the system-controlled state of the Service.
Service	set(String fieldName, Object value)
Service	setApiVersion(String apiVersion) The API version for this call.
Service	setKind(String kind) The kind of resource.
Service	setMetadata(ObjectMeta metadata) Metadata associated with this Service, including name, namespace, labels, and annotations.
Service	setSpec(ServiceSpec spec) Holds the desired state of the Service (from the client).
Service	setStatus(ServiceStatus status) Communicates the system-controlled state of 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

getApiVersion

public String getApiVersion()

The API version for this call. It must be "serving.knative.dev/v1".

Returns:

value or null for none

setApiVersion

public Service setApiVersion(String apiVersion)

The API version for this call. It must be "serving.knative.dev/v1".

Parameters:

apiVersion - apiVersion or null for none

getKind

public String getKind()

The kind of resource. It must be "Service".

Returns:

value or null for none

setKind

public Service setKind(String kind)

The kind of resource. It must be "Service".

Parameters:

kind - kind or null for none

getMetadata

public ObjectMeta getMetadata()

Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary- authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal.

Returns:

value or null for none

setMetadata

public Service setMetadata(ObjectMeta metadata)

Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary- authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal.

Parameters:

metadata - metadata or null for none

getSpec

public ServiceSpec getSpec()

Holds the desired state of the Service (from the client).

Returns:

value or null for none

setSpec

public Service setSpec(ServiceSpec spec)

Holds the desired state of the Service (from the client).

Parameters:

spec - spec or null for none

getStatus

public ServiceStatus getStatus()

Communicates the system-controlled state of the Service.

Returns:

value or null for none

setStatus

public Service setStatus(ServiceStatus status)

Communicates the system-controlled state of the Service.

Parameters:

status - status 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