Class ResourceLocator.Directive

  • All Implemented Interfaces:
    ResourceLocator.DirectiveOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    Enclosing class:
    ResourceLocator

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

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Directive()  
      private Directive​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Field Detail

      • directiveCase_

        private int directiveCase_
      • directive_

        private java.lang.Object directive_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
    • Constructor Detail

      • Directive

        private Directive​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • Directive

        private Directive()
    • Method Detail

      • 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
      • 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.
      • 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
      • 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 java.lang.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.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ResourceLocator.Directive parseFrom​(java.nio.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​(java.io.InputStream input)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ResourceLocator.Directive parseFrom​(java.io.InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static ResourceLocator.Directive parseDelimitedFrom​(java.io.InputStream input)
                                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static ResourceLocator.Directive parseDelimitedFrom​(java.io.InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ResourceLocator.Directive parseFrom​(com.google.protobuf.CodedInputStream input)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ResourceLocator.Directive parseFrom​(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.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
      • 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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • 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.GeneratedMessage
      • getDefaultInstanceForType

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