com.google.api.services.run.v1.model

Class TrafficTarget

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.TrafficTarget

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class TrafficTarget
extends GenericJson

TrafficTarget holds a single entry of the routing table for a Route.

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

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
TrafficTarget()

Method Summary

Modifier and Type	Method and Description
TrafficTarget	clone()
String	getConfigurationName() ConfigurationName of a configuration to whose latest revision we will send this portion of traffic.
Boolean	getLatestRevision() LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target.
Integer	getPercent() Percent specifies percent of the traffic to this Revision or Configuration.
String	getRevisionName() RevisionName of a specific revision to which to send this portion of traffic.
String	getTag() Tag is optionally used to expose a dedicated url for referencing this target exclusively.
String	getUrl() Output only.
TrafficTarget	set(String fieldName, Object value)
TrafficTarget	setConfigurationName(String configurationName) ConfigurationName of a configuration to whose latest revision we will send this portion of traffic.
TrafficTarget	setLatestRevision(Boolean latestRevision) LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target.
TrafficTarget	setPercent(Integer percent) Percent specifies percent of the traffic to this Revision or Configuration.
TrafficTarget	setRevisionName(String revisionName) RevisionName of a specific revision to which to send this portion of traffic.
TrafficTarget	setTag(String tag) Tag is optionally used to expose a dedicated url for referencing this target exclusively.
TrafficTarget	setUrl(String url) Output only.

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

TrafficTarget

public TrafficTarget()

Method Detail

getConfigurationName

public String getConfigurationName()

ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName.

Returns:

value or null for none

setConfigurationName

public TrafficTarget setConfigurationName(String configurationName)

ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName.

Parameters:

configurationName - configurationName or null for none

getLatestRevision

public Boolean getLatestRevision()

LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty. +optional

Returns:

value or null for none

setLatestRevision

public TrafficTarget setLatestRevision(Boolean latestRevision)

LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty. +optional

Parameters:

latestRevision - latestRevision or null for none

getPercent

public Integer getPercent()

Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified. Cloud Run currently requires 100 percent for a single ConfigurationName TrafficTarget entry.

Returns:

value or null for none

setPercent

public TrafficTarget setPercent(Integer percent)

Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified. Cloud Run currently requires 100 percent for a single ConfigurationName TrafficTarget entry.

Parameters:

percent - percent or null for none

getRevisionName

public String getRevisionName()

RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName. Providing RevisionName in spec is not currently supported by Cloud Run.

Returns:

value or null for none

setRevisionName

public TrafficTarget setRevisionName(String revisionName)

RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName. Providing RevisionName in spec is not currently supported by Cloud Run.

Parameters:

revisionName - revisionName or null for none

getTag

public String getTag()

Tag is optionally used to expose a dedicated url for referencing this target exclusively. +optional

Returns:

value or null for none

setTag

public TrafficTarget setTag(String tag)

Tag is optionally used to expose a dedicated url for referencing this target exclusively. +optional

Parameters:

tag - tag or null for none

getUrl

public String getUrl()

Output only. URL displays the URL for accessing tagged traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc. Not currently supported in Cloud Run.

Returns:

value or null for none

setUrl

public TrafficTarget setUrl(String url)

Output only. URL displays the URL for accessing tagged traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc. Not currently supported in Cloud Run.

Parameters:

url - url or null for none

set

public TrafficTarget set(String fieldName,
                         Object value)

Overrides:

set in class GenericJson

clone

public TrafficTarget clone()

Overrides:

clone in class GenericJson