View Source API Reference google_api_traffic_director v0.3.0
Modules
API client metadata for GoogleApi.TrafficDirector.V3.
API calls for all endpoints tagged Discovery
.
Handle Tesla connections for GoogleApi.TrafficDirector.V3.
Addresses specify either a logical or physical address and port, which are used to tell Envoy where to bind/listen, connect to upstream and find management servers.
BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings.
All xds configs for a particular client.
Request for client status of clients identified by a list of NodeMatchers.
Envoy's cluster manager fills this message with all currently known clusters. Cluster configuration information can be used to recreate an Envoy configuration by populating all clusters as static clusters or by returning them in a CDS response.
Additional parameters that can be used to select resource variants. These include any global context parameters, per-resource type client feature capabilities and per-resource type functional attributes. All per-resource type attributes will be xds.resource.
prefixed and some of these are documented below: xds.resource.listening_address
: The value is "IP:port" (e.g. "10.1.1.3:8080") which is the listening address of a Listener. Used in a Listener resource query.
Specifies the way to match a double value.
Specifies the double start and end of the range using half-open interval semantics [start, end).
Describes a dynamically loaded cluster via the CDS API. [#next-free-field: 6]
[#next-free-field: 6]
Describes a dynamically loaded listener via the LDS API. [#next-free-field: 7]
Attributes
-
lastUpdated
(type:DateTime.t
, default:nil
) - The timestamp when the Listener was last successfully updated. -
listener
(type:map()
, default:nil
) - The listener config. -
versionInfo
(type:String.t
, default:nil
) - This is the per-resource version information. This version is currently taken from the :ref:version_info
field at the time that the listener was loaded. In the future, discrete per-listener versions may be supported by the API.
[#next-free-field: 6]
[#next-free-field: 7]
Envoy's admin fill this message with all currently known endpoints. Endpoint configuration information can be used to recreate an Envoy configuration by populating all endpoints as static endpoints or by returning them in an EDS response.
The address represents an envoy internal listener. [#comment:
Version and identification for an Envoy extension. [#next-free-field: 7]
GenericXdsConfig is used to specify the config status and the dump of any xDS resource identified by their type URL. It is the generalized version of the now deprecated ListenersConfigDump, ClustersConfigDump etc [#next-free-field: 10]
Google's RE2
regex engine. The regex string must adhere to the documented syntax
. The engine is designed to complete execution in linear time as well as limit the amount of memory used. Envoy supports program size checking via runtime. The runtime keys re2.max_program_size.error_level
and re2.max_program_size.warn_level
can be set to integers as the maximum program size or complexity that a compiled regex can have before an exception is thrown or a warning is logged, respectively. re2.max_program_size.error_level
defaults to 100, and re2.max_program_size.warn_level
has no default if unset (will not check/log a warning). Envoy emits two stats for tracking the program size of regexes: the histogram re2.program_size
, which records the program size, and the counter re2.exceeded_warn_level
, which is incremented each time the program size exceeds the warn level threshold.
Attributes
-
lastUpdated
(type:DateTime.t
, default:nil
) - The timestamp when the scoped route config set was last updated. -
name
(type:String.t
, default:nil
) - The name assigned to the scoped route configurations. -
scopedRouteConfigs
(type:list(map())
, default:nil
) - The scoped route configurations.
Specifies the way to match a list value.
Envoy's listener manager fills this message with all currently known listeners. Listener configuration information can be used to recreate an Envoy configuration by populating all listeners as static listeners or by returning them in a LDS response.
Identifies location of where either Envoy runs or where upstream hosts run.
Identifies a specific Envoy instance. The node identifier is presented to the management server, which may use this identifier to distinguish per Envoy configuration for serving. [#next-free-field: 13]
Specifies the way to match a Node. The match follows AND semantics.
NullMatch is an empty message to specify a null value.
Specifies a list of alternatives for the match.
Specifies the segment in a path to retrieve value from Struct.
Detailed config (per xDS) with status. [#next-free-field: 8]
Attributes
-
mode
(type:integer()
, default:nil
) - The mode for the Pipe. Not applicable for abstract sockets. -
path
(type:String.t
, default:nil
) - Unix Domain Socket path. On Linux, paths starting with '@' will use the abstract namespace. The starting '@' is replaced by a null byte by Envoy. Paths starting with '@' will result in an error in environments other than Linux.
A regex matcher designed for safety when used with untrusted input.
Envoy's RDS implementation fills this message with all currently loaded routes, as described by their RouteConfiguration objects. Static routes that are either defined in the bootstrap configuration or defined inline while configuring listeners are separated from those configured dynamically via RDS. Route configuration information can be used to recreate an Envoy configuration by populating all routes as static routes or by returning them in RDS responses.
Envoy's scoped RDS implementation fills this message with all currently loaded route configuration scopes (defined via ScopedRouteConfigurationsSet protos). This message lists both the scopes defined inline with the higher order object (i.e., the HttpConnectionManager) and the dynamically obtained scopes via the SRDS API.
Envoy uses SemVer (https://semver.org/). Major/minor versions indicate expected behaviors and APIs, the patch version field is used only for security fixes and can be generally ignored.
[#next-free-field: 7]
Describes a statically loaded cluster.
Describes a statically loaded listener.
Specifies the way to match a string. [#next-free-field: 9]
StructMatcher provides a general interface to check if a given value is matched in google.protobuf.Struct. It uses path
to retrieve the value from the struct and then check if it's matched to the specified value. For example, for the following Struct: .. code-block:: yaml fields: a: struct_value: fields: b: struct_value: fields: c: string_value: pro t: list_value: values: - string_value: m - string_value: n The following MetadataMatcher is matched as the path [a, b, c] will retrieve a string value "pro" from the Metadata which is matched to the specified prefix match. .. code-block:: yaml path: - key: a - key: b - key: c value: string_match: prefix: pr The following StructMatcher is matched as the code will match one of the string values in the list at the path [a, t]. .. code-block:: yaml path: - key: a - key: t value: list_match: one_of: string_match: exact: m An example use of StructMatcher is to match metadata in envoy.v*.core.Node.
Message type for extension configuration.
Attributes
-
details
(type:String.t
, default:nil
) - Details about the last failed update attempt. -
failedConfiguration
(type:map()
, default:nil
) - What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead. -
lastUpdateAttempt
(type:DateTime.t
, default:nil
) - Time of the latest failed update attempt. -
versionInfo
(type:String.t
, default:nil
) - This is the version of the rejected resource. [#not-implemented-hide:]
Specifies the way to match a ProtobufWkt::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 8]