io.envoyproxy.controlplane.cache

Class Snapshot

java.lang.Object

io.envoyproxy.controlplane.cache.Snapshot

public abstract class Snapshot
extends Object

Snapshot is a data class that contains an internally consistent snapshot of xDS resources. Snapshots should have distinct versions per node group.

Constructor Summary

Constructors

Constructor and Description
Snapshot()

Method Summary

Modifier and Type	Method and Description
abstract SnapshotResources<Cds.Cluster>	clusters() Returns all cluster items in the CDS payload.
static Snapshot	create(Iterable<Cds.Cluster> clusters, Iterable<Eds.ClusterLoadAssignment> endpoints, Iterable<Lds.Listener> listeners, Iterable<Rds.RouteConfiguration> routes, Iterable<Cert.Secret> secrets, String version) Returns a new Snapshot instance that is versioned uniformly across all resources.
static Snapshot	create(Iterable<Cds.Cluster> clusters, String clustersVersion, Iterable<Eds.ClusterLoadAssignment> endpoints, String endpointsVersion, Iterable<Lds.Listener> listeners, String listenersVersion, Iterable<Rds.RouteConfiguration> routes, String routesVersion, Iterable<Cert.Secret> secrets, String secretsVersion) Returns a new Snapshot instance that has separate versions for each resource type.
static Snapshot	createEmpty(String version) Creates an empty snapshot with the given version.
abstract SnapshotResources<Eds.ClusterLoadAssignment>	endpoints() Returns all endpoint items in the EDS payload.
void	ensureConsistent() Asserts that all dependent resources are included in the snapshot.
abstract SnapshotResources<Lds.Listener>	listeners() Returns all listener items in the LDS payload.
Map<String,? extends Message>	resources(String typeUrl) Returns the resources with the given type.
abstract SnapshotResources<Rds.RouteConfiguration>	routes() Returns all route items in the RDS payload.
abstract SnapshotResources<Cert.Secret>	secrets() Returns all secret items in the SDS payload.
String	version(String typeUrl) Returns the version in this snapshot for the given resource type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Snapshot

public Snapshot()

Method Detail

create

public static Snapshot create(Iterable<Cds.Cluster> clusters,
                              Iterable<Eds.ClusterLoadAssignment> endpoints,
                              Iterable<Lds.Listener> listeners,
                              Iterable<Rds.RouteConfiguration> routes,
                              Iterable<Cert.Secret> secrets,
                              String version)

Returns a new Snapshot instance that is versioned uniformly across all resources.

Parameters:

clusters - the cluster resources in this snapshot

endpoints - the endpoint resources in this snapshot

listeners - the listener resources in this snapshot

routes - the route resources in this snapshot

version - the version associated with all resources in this snapshot

create

public static Snapshot create(Iterable<Cds.Cluster> clusters,
                              String clustersVersion,
                              Iterable<Eds.ClusterLoadAssignment> endpoints,
                              String endpointsVersion,
                              Iterable<Lds.Listener> listeners,
                              String listenersVersion,
                              Iterable<Rds.RouteConfiguration> routes,
                              String routesVersion,
                              Iterable<Cert.Secret> secrets,
                              String secretsVersion)

Returns a new Snapshot instance that has separate versions for each resource type.

Parameters:

clusters - the cluster resources in this snapshot

clustersVersion - the version of the cluster resources

endpoints - the endpoint resources in this snapshot

endpointsVersion - the version of the endpoint resources

listeners - the listener resources in this snapshot

listenersVersion - the version of the listener resources

routes - the route resources in this snapshot

routesVersion - the version of the route resources

createEmpty

public static Snapshot createEmpty(String version)

Creates an empty snapshot with the given version.

Parameters:

version - the version of the snapshot resources

clusters

public abstract SnapshotResources<Cds.Cluster> clusters()

Returns all cluster items in the CDS payload.

endpoints

public abstract SnapshotResources<Eds.ClusterLoadAssignment> endpoints()

Returns all endpoint items in the EDS payload.

listeners

public abstract SnapshotResources<Lds.Listener> listeners()

Returns all listener items in the LDS payload.

routes

public abstract SnapshotResources<Rds.RouteConfiguration> routes()

Returns all route items in the RDS payload.

secrets

public abstract SnapshotResources<Cert.Secret> secrets()

Returns all secret items in the SDS payload.

ensureConsistent

public void ensureConsistent()
                      throws SnapshotConsistencyException

Asserts that all dependent resources are included in the snapshot. All EDS resources are listed by name in CDS resources, and all RDS resources are listed by name in LDS resources.

Note that clusters and listeners are requested without name references, so Envoy will accept the snapshot list of clusters as-is, even if it does not match all references found in xDS.

Throws:

SnapshotConsistencyException - if the snapshot is not consistent

resources

public Map<String,? extends Message> resources(String typeUrl)

Returns the resources with the given type.

Parameters:

typeUrl - the URL for the requested resource type

version

public String version(String typeUrl)

Returns the version in this snapshot for the given resource type.

Parameters:

typeUrl - the URL for the requested resource type