package v3

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. final case class Authority(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Authority] with Product with Serializable

    xDS authority information.

    xDS authority information.

    Annotations
    @SerialVersionUID()
  2. final case class CidrRange(addressPrefix: String = "", prefixLen: Option[Int] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CidrRange] with Product with Serializable

    CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a CIDR <https://tools.ietf.org/html/rfc4632>_ range.

    CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a CIDR <https://tools.ietf.org/html/rfc4632>_ range.

    addressPrefix

    IPv4 or IPv6 address, e.g. 192.0.0.0 or 2001:db8::.

    prefixLen

    Length of prefix, e.g. 0, 32. Defaults to 0 when unset.

    Annotations
    @SerialVersionUID()
  3. final case class CollectionEntry(resourceSpecifier: ResourceSpecifier = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CollectionEntry] with Product with Serializable

    xDS collection resource wrapper.

    xDS 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; }

    Annotations
    @SerialVersionUID()
  4. final case class ContextParams(params: Map[String, String] = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ContextParams] with Product with Serializable

    Additional parameters that can be used to select resource variants.

    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.

    Annotations
    @SerialVersionUID()
  5. final case class Resource(name: Option[ResourceName] = _root_.scala.None, version: String = "", resource: Option[Any] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Resource] with Product with Serializable

    xDS resource wrapper.

    xDS resource wrapper. This encapsulates a xDS resource when appearing in an xDS transport discovery response or when accessed as a filesystem object.

    name

    Resource name. This may be omitted for filesystem resources.

    version

    The resource's logical version. It is illegal to have the same named xDS resource name at a given version with different resource payloads.

    resource

    The resource payload, including type URL.

    Annotations
    @SerialVersionUID()
  6. final case class ResourceLocator(scheme: Scheme = ..., id: String = "", authority: String = "", resourceType: String = "", contextParamSpecifier: ContextParamSpecifier = ..., directives: Seq[Directive] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ResourceLocator] with Product with Serializable

    xDS resource locators identify a xDS resource name and instruct the data-plane load balancer on how the resource may be located.

    xDS 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,*}

    scheme

    URI scheme.

    id

    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.

    authority

    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.

    resourceType

    Fully qualified resource type (as in type URL without types.googleapis.com/ prefix).

    directives

    A list of directives that appear in the xDS resource locator #fragment. When encoding to URI form, directives are percent encoded with comma separation.

    Annotations
    @SerialVersionUID()
  7. final case class ResourceName(id: String = "", authority: String = "", resourceType: String = "", context: Option[ContextParams] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ResourceName] with Product with Serializable

    xDS resource name.

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

    id

    Opaque identifier for the resource. Any '/' will not be escaped during URI encoding and will form part of the URI path.

    authority

    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.

    resourceType

    Fully qualified resource type (as in type URL without types.googleapis.com/ prefix).

    context

    Additional parameters that can be used to select resource variants.

    Annotations
    @SerialVersionUID()
  8. final case class TypedExtensionConfig(name: String = "", typedConfig: Option[Any] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[TypedExtensionConfig] with Product with Serializable

    Message type for extension configuration.

    Message type for extension configuration.

    name

    The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier.

    typedConfig

    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.

    Annotations
    @SerialVersionUID()

Value Members

  1. object Authority extends GeneratedMessageCompanion[Authority]
  2. object AuthorityProto extends GeneratedFileObject
  3. object CidrProto extends GeneratedFileObject
  4. object CidrRange extends GeneratedMessageCompanion[CidrRange]
  5. object CollectionEntry extends GeneratedMessageCompanion[CollectionEntry]
  6. object CollectionEntryProto extends GeneratedFileObject
  7. object ContextParams extends GeneratedMessageCompanion[ContextParams]
  8. object ContextParamsProto extends GeneratedFileObject
  9. object ExtensionProto extends GeneratedFileObject
  10. object Resource extends GeneratedMessageCompanion[Resource]
  11. object ResourceLocator extends GeneratedMessageCompanion[ResourceLocator]
  12. object ResourceLocatorProto extends GeneratedFileObject
  13. object ResourceName extends GeneratedMessageCompanion[ResourceName]
  14. object ResourceNameProto extends GeneratedFileObject
  15. object ResourceProto extends GeneratedFileObject
  16. object TypedExtensionConfig extends GeneratedMessageCompanion[TypedExtensionConfig]

Ungrouped