com.github.udpa.xds.core.v3

Class ResourceLocator.Directive.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>

com.github.udpa.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.GeneratedMessageV3.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

Method Summary

Modifier and Type	Method and Description
ResourceLocator.Directive.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ResourceLocator.Directive	build()
ResourceLocator.Directive	buildPartial()
ResourceLocator.Directive.Builder	clear()
ResourceLocator.Directive.Builder	clearAlt() An alternative resource locator for fallback if the resource is unavailable.
ResourceLocator.Directive.Builder	clearDirective()
ResourceLocator.Directive.Builder	clearEntry() List collections support inlining of resources via the entry field in Resource.
ResourceLocator.Directive.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ResourceLocator.Directive.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ResourceLocator.Directive.Builder	clone()
ResourceLocator	getAlt() An alternative resource locator for fallback if the resource is unavailable.
ResourceLocator.Builder	getAltBuilder() An alternative resource locator for fallback if the resource is unavailable.
ResourceLocatorOrBuilder	getAltOrBuilder() An alternative resource locator for fallback if the resource is unavailable.
ResourceLocator.Directive	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
ResourceLocator.Directive.DirectiveCase	getDirectiveCase()
String	getEntry() List collections support inlining of resources via the entry field in Resource.
com.google.protobuf.ByteString	getEntryBytes() List collections support inlining of resources via the entry field in Resource.
boolean	hasAlt() An alternative resource locator for fallback if the resource is unavailable.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ResourceLocator.Directive.Builder	mergeAlt(ResourceLocator value) An alternative resource locator for fallback if the resource is unavailable.
ResourceLocator.Directive.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ResourceLocator.Directive.Builder	mergeFrom(com.google.protobuf.Message other)
ResourceLocator.Directive.Builder	mergeFrom(ResourceLocator.Directive other)
ResourceLocator.Directive.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ResourceLocator.Directive.Builder	setAlt(ResourceLocator.Builder builderForValue) An alternative resource locator for fallback if the resource is unavailable.
ResourceLocator.Directive.Builder	setAlt(ResourceLocator value) An alternative resource locator for fallback if the resource is unavailable.
ResourceLocator.Directive.Builder	setEntry(String value) List collections support inlining of resources via the entry field in Resource.
ResourceLocator.Directive.Builder	setEntryBytes(com.google.protobuf.ByteString value) List collections support inlining of resources via the entry field in Resource.
ResourceLocator.Directive.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ResourceLocator.Directive.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ResourceLocator.Directive.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone

public ResourceLocator.Directive.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>

setField

public ResourceLocator.Directive.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>

clearField

public ResourceLocator.Directive.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>

clearOneof

public ResourceLocator.Directive.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>

setRepeatedField

public ResourceLocator.Directive.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>

addRepeatedField

public ResourceLocator.Directive.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>

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

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

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

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

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

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) = { ... }

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) = { ... }

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) = { ... }

setUnknownFields

public final ResourceLocator.Directive.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>

mergeUnknownFields

public final ResourceLocator.Directive.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceLocator.Directive.Builder>