Class ResourceLocator.Directive.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<ResourceLocator.Directive.Builder>
com.google.protobuf.GeneratedMessage.Builder<ResourceLocator.Directive.Builder>
com.github.xds.core.v3.ResourceLocator.Directive.Builder
All Implemented Interfaces:
ResourceLocator.DirectiveOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ResourceLocator.Directive
public static final class ResourceLocator.Directive.Builder extends com.google.protobuf.GeneratedMessage.Builder<ResourceLocator.Directive.Builder> implements ResourceLocator.DirectiveOrBuilder
Directives 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.
Protobuf type xds.core.v3.ResourceLocator.Directive

  • Field Details

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ResourceLocator.Directive.Builder>

    • clear

      public ResourceLocator.Directive.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ResourceLocator.Directive.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ResourceLocator.Directive.Builder>

    • getDefaultInstanceForType

      public ResourceLocator.Directive getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ResourceLocator.Directive build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ResourceLocator.Directive buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • buildPartial0

      private void buildPartial0(ResourceLocator.Directive result)

    • buildPartialOneofs

      private void buildPartialOneofs(ResourceLocator.Directive result)

    • mergeFrom

      public ResourceLocator.Directive.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResourceLocator.Directive.Builder>

    • mergeFrom

      public ResourceLocator.Directive.Builder mergeFrom(ResourceLocator.Directive other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ResourceLocator.Directive.Builder>

    • mergeFrom

      public ResourceLocator.Directive.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResourceLocator.Directive.Builder>
      Throws:
      IOException

    • getDirectiveCase

      public ResourceLocator.Directive.DirectiveCase getDirectiveCase()
      Specified by:
      getDirectiveCase in interface ResourceLocator.DirectiveOrBuilder

    • clearDirective

      public ResourceLocator.Directive.Builder clearDirective()

    • hasAlt

      public boolean hasAlt()
      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.
      .xds.core.v3.ResourceLocator alt = 1;
      Specified by:
      hasAlt in interface ResourceLocator.DirectiveOrBuilder
      Returns:
      Whether the alt field is set.

    • getAlt

      public ResourceLocator getAlt()
      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.
      .xds.core.v3.ResourceLocator alt = 1;
      Specified by:
      getAlt in interface ResourceLocator.DirectiveOrBuilder
      Returns:
      The alt.

    • setAlt

      public ResourceLocator.Directive.Builder setAlt(ResourceLocator value)
      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.
      .xds.core.v3.ResourceLocator alt = 1;

    • setAlt

      public ResourceLocator.Directive.Builder setAlt(ResourceLocator.Builder builderForValue)
      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.
      .xds.core.v3.ResourceLocator alt = 1;

    • mergeAlt

      public ResourceLocator.Directive.Builder mergeAlt(ResourceLocator value)
      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.
      .xds.core.v3.ResourceLocator alt = 1;

    • clearAlt

      public ResourceLocator.Directive.Builder clearAlt()
      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.
      .xds.core.v3.ResourceLocator alt = 1;

    • getAltBuilder

      public ResourceLocator.Builder getAltBuilder()
      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.
      .xds.core.v3.ResourceLocator alt = 1;

    • getAltOrBuilder

      public ResourceLocatorOrBuilder getAltOrBuilder()
      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.
      .xds.core.v3.ResourceLocator alt = 1;
      Specified by:
      getAltOrBuilder in interface ResourceLocator.DirectiveOrBuilder

    • internalGetAltFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<ResourceLocator, ResourceLocator.Builder, ResourceLocatorOrBuilder> internalGetAltFieldBuilder()
      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.
      .xds.core.v3.ResourceLocator alt = 1;

    • hasEntry

      public boolean hasEntry()
      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.
      string entry = 2 [(.validate.rules) = { ... }
      Specified by:
      hasEntry in interface ResourceLocator.DirectiveOrBuilder
      Returns:
      Whether the entry field is set.

    • getEntry

      public String getEntry()
      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.
      string entry = 2 [(.validate.rules) = { ... }
      Specified by:
      getEntry in interface ResourceLocator.DirectiveOrBuilder
      Returns:
      The entry.

    • getEntryBytes

      public com.google.protobuf.ByteString getEntryBytes()
      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.
      string entry = 2 [(.validate.rules) = { ... }
      Specified by:
      getEntryBytes in interface ResourceLocator.DirectiveOrBuilder
      Returns:
      The bytes for entry.

    • setEntry

      public ResourceLocator.Directive.Builder setEntry(String value)
      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.
      string entry = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The entry to set.
      Returns:
      This builder for chaining.

    • clearEntry

      public ResourceLocator.Directive.Builder clearEntry()
      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.
      string entry = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setEntryBytes

      public ResourceLocator.Directive.Builder setEntryBytes(com.google.protobuf.ByteString value)
      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.
      string entry = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for entry to set.
      Returns:
      This builder for chaining.