package xds.core.v3
Get desktop application:
View/edit binary Protocol Buffers messages
message
authority.proto:17xDS authority information.
Used in:
string name = 1
message
cidr.proto:19CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a `CIDR <https://tools.ietf.org/html/rfc4632>`_ range.
Used in: ,
string address_prefix = 1
IPv4 or IPv6 address, e.g. ``192.0.0.0`` or ``2001:db8::``.
optional prefix_len = 2
Length of prefix, e.g. 0, 32. Defaults to 0 when unset.
message
collection_entry.proto:29xDS collection resource wrapper. This encapsulates a xDS resource when appearing inside a list collection resource. List collection resources are regular Resource messages of type: .. code-block:: proto message <T>Collection { repeated CollectionEntry resources = 1; }
Used in: , ,
oneof resource_specifier
locator = 1
A resource locator describing how the member resource is to be located.
inline_entry = 2
The resource is inlined in the list collection.
message
collection_entry.proto:31Inlined resource entry.
Used in:
string name = 1
Optional name to describe the inlined resource. Resource names must match ``[a-zA-Z0-9_-\./]+`` (TODO(htuch): turn this into a PGV constraint once finalized, probably should be a RFC3986 pchar). This name allows reference via the #entry directive in ResourceLocator.
string version = 2
The resource's logical version. It is illegal to have the same named xDS resource name at a given version with different resource payloads.
optional resource = 3
The resource payload, including type URL.
message
context_params.proto:21Additional 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.
Used in: , ,
map<string, string> params = 1
message
resource.proto:19xDS resource wrapper. This encapsulates a xDS resource when appearing in an xDS transport discovery response or when accessed as a filesystem object.
optional name = 1
Resource name. This may be omitted for filesystem resources.
string version = 2
The resource's logical version. It is illegal to have the same named xDS resource name at a given version with different resource payloads.
optional resource = 3
The resource payload, including type URL.
message
resource_locator.proto:34xDS resource locators identify a xDS resource name and instruct the data-plane load balancer on how the resource may be located. Resource locators have a canonical xdstp:// URI representation: xdstp://{authority}/{type_url}/{id}?{context_params}{#directive,*} where context_params take the form of URI query parameters. Resource locators have a similar canonical http:// URI representation: http://{authority}/{type_url}/{id}?{context_params}{#directive,*} Resource locators also have a simplified file:// URI representation: file:///{id}{#directive,*}
Used in: ,
ResourceLocator.Scheme scheme = 1
URI scheme.
string id = 2
Opaque identifier for the resource. Any '/' will not be escaped during URI encoding and will form part of the URI path. This may end with ‘*’ for glob collection references.
string authority = 3
Logical authority for resource (not necessarily transport network address). Authorities are opaque in the xDS API, data-plane load balancers will map them to concrete network transports such as an xDS management server, e.g. via envoy.config.core.v3.ConfigSource.
string resource_type = 4
Fully qualified resource type (as in type URL without types.googleapis.com/ prefix).
oneof context_param_specifier
exact_context = 5
Additional parameters that can be used to select resource variants. Matches must be exact, i.e. all context parameters must match exactly and there must be no additional context parameters set on the matched resource.
repeated directives = 6
A list of directives that appear in the xDS resource locator #fragment. When encoding to URI form, directives are percent encoded with comma separation.
message
resource_locator.proto:90Directives provide information to data-plane load balancers on how xDS resource names are to be interpreted and potentially further resolved. For example, they may provide alternative resource locators for when primary resolution fails. Directives are not part of resource names and do not appear in a xDS transport discovery request. When encoding to URIs, directives take the form: <directive name>=<string representation of directive value> For example, we can have alt=xdstp://foo/bar or entry=some%20thing. Each directive value type may have its own string encoding, in the case of ResourceLocator there is a recursive URI encoding. Percent encoding applies to the URI encoding of the directive value. Multiple directives are comma-separated, so the reserved characters that require percent encoding in a directive value are [',', '#', '[', ']', '%']. These are the RFC3986 fragment reserved characters with the addition of the xDS scheme specific ','. See https://tools.ietf.org/html/rfc3986#page-49 for further details on URI ABNF and reserved characters.
Used in:
oneof directive
alt = 1
An alternative resource locator for fallback if the resource is unavailable. For example, take the resource locator: xdstp://foo/some-type/some-route-table#alt=xdstp://bar/some-type/another-route-table If the data-plane load balancer is unable to reach `foo` to fetch the resource, it will fallback to `bar`. Alternative resources do not need to have equivalent content, but they should be functional substitutes.
string entry = 2
List collections support inlining of resources via the entry field in Resource. These inlined Resource objects may have an optional name field specified. When specified, the entry directive allows ResourceLocator to directly reference these inlined resources, e.g. xdstp://.../foo#entry=bar.
Used in:
XDSTP = 0
HTTP = 1
FILE = 2
message
resource_name.proto:26xDS resource name. This has a canonical xdstp:// URI representation: xdstp://{authority}/{type_url}/{id}?{context_params} where context_params take the form of URI query parameters. A xDS resource name fully identifies a network resource for transport purposes. xDS resource names in this form appear only in discovery request/response messages used with the xDS transport.
Used in:
string id = 1
Opaque identifier for the resource. Any '/' will not be escaped during URI encoding and will form part of the URI path.
string authority = 2
Logical authority for resource (not necessarily transport network address). Authorities are opaque in the xDS API, data-plane load balancers will map them to concrete network transports such as an xDS management server.
string resource_type = 3
Fully qualified resource type (as in type URL without types.googleapis.com/ prefix).
optional context = 4
Additional parameters that can be used to select resource variants.
message
extension.proto:14Message type for extension configuration.
Used in: , , , ,
string name = 1
The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier.
optional typed_config = 2
The typed config for the extension. The type URL will be used to identify the extension. In the case that the type URL is *xds.type.v3.TypedStruct* (or, for historical reasons, *udpa.type.v1.TypedStruct*), the inner type URL of *TypedStruct* will be utilized. See the :ref:`extension configuration overview <config_overview_extension_configuration>` for further details.