com.github.udpa.xds.core.v3

Class ResourceLocator.Directive

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.github.udpa.xds.core.v3.ResourceLocator.Directive

All Implemented Interfaces:

ResourceLocator.DirectiveOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

ResourceLocator

public static final class ResourceLocator.Directive
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceLocator.Directive.Builder Directives provide information to data-plane load balancers on how xDS resource names are to be interpreted and potentially further resolved.
static class	ResourceLocator.Directive.DirectiveCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALT_FIELD_NUMBER
static int	ENTRY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ResourceLocator	getAlt() An alternative resource locator for fallback if the resource is unavailable.
ResourceLocatorOrBuilder	getAltOrBuilder() An alternative resource locator for fallback if the resource is unavailable.
static ResourceLocator.Directive	getDefaultInstance()
ResourceLocator.Directive	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<ResourceLocator.Directive>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAlt() An alternative resource locator for fallback if the resource is unavailable.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ResourceLocator.Directive.Builder	newBuilder()
static ResourceLocator.Directive.Builder	newBuilder(ResourceLocator.Directive prototype)
ResourceLocator.Directive.Builder	newBuilderForType()
protected ResourceLocator.Directive.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ResourceLocator.Directive	parseDelimitedFrom(InputStream input)
static ResourceLocator.Directive	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceLocator.Directive	parseFrom(byte[] data)
static ResourceLocator.Directive	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceLocator.Directive	parseFrom(ByteBuffer data)
static ResourceLocator.Directive	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceLocator.Directive	parseFrom(com.google.protobuf.ByteString data)
static ResourceLocator.Directive	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceLocator.Directive	parseFrom(com.google.protobuf.CodedInputStream input)
static ResourceLocator.Directive	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceLocator.Directive	parseFrom(InputStream input)
static ResourceLocator.Directive	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ResourceLocator.Directive>	parser()
ResourceLocator.Directive.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ALT_FIELD_NUMBER

public static final int ALT_FIELD_NUMBER

See Also:

Constant Field Values

ENTRY_FIELD_NUMBER

public static final int ENTRY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getDirectiveCase

public ResourceLocator.Directive.DirectiveCase getDirectiveCase()

Specified by:

getDirectiveCase in interface ResourceLocator.DirectiveOrBuilder

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ResourceLocator.Directive parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceLocator.Directive parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceLocator.Directive parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceLocator.Directive parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceLocator.Directive parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceLocator.Directive parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceLocator.Directive parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static ResourceLocator.Directive parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static ResourceLocator.Directive parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static ResourceLocator.Directive parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static ResourceLocator.Directive parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static ResourceLocator.Directive parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public ResourceLocator.Directive.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ResourceLocator.Directive.Builder newBuilder()

newBuilder

public static ResourceLocator.Directive.Builder newBuilder(ResourceLocator.Directive prototype)

toBuilder

public ResourceLocator.Directive.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ResourceLocator.Directive.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ResourceLocator.Directive getDefaultInstance()

parser

public static com.google.protobuf.Parser<ResourceLocator.Directive> parser()

getParserForType

public com.google.protobuf.Parser<ResourceLocator.Directive> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ResourceLocator.Directive getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder