Package io.grpc.serviceconfig

Class XdsConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, XdsConfigOrBuilder, Serializable
    public final class XdsConfig
extends com.google.protobuf.GeneratedMessageV3
implements XdsConfigOrBuilder
     Configuration for xds LB policy.
    Protobuf type grpc.service_config.XdsConfig
    See Also:
    Serialized Form

    • Field Detail

      • BALANCER_NAME_FIELD_NUMBER

        public static final int BALANCER_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CHILD_POLICY_FIELD_NUMBER

        public static final int CHILD_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FALLBACK_POLICY_FIELD_NUMBER

        public static final int FALLBACK_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EDS_SERVICE_NAME_FIELD_NUMBER

        public static final int EDS_SERVICE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LRS_LOAD_REPORTING_SERVER_NAME_FIELD_NUMBER

        public static final int LRS_LOAD_REPORTING_SERVER_NAME_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

      • getBalancerName

        @Deprecated
public String getBalancerName()
        Deprecated.
        grpc.service_config.XdsConfig.balancer_name is deprecated. See service_config.proto;l=432
         Name of balancer to connect to.
        string balancer_name = 1 [deprecated = true];
        Specified by:
        getBalancerName in interface XdsConfigOrBuilder
        Returns:
        The balancerName.

      • getBalancerNameBytes

        @Deprecated
public com.google.protobuf.ByteString getBalancerNameBytes()
        Deprecated.
        grpc.service_config.XdsConfig.balancer_name is deprecated. See service_config.proto;l=432
         Name of balancer to connect to.
        string balancer_name = 1 [deprecated = true];
        Specified by:
        getBalancerNameBytes in interface XdsConfigOrBuilder
        Returns:
        The bytes for balancerName.

      • getChildPolicyList

        public List<LoadBalancingConfig> getChildPolicyList()
         Optional.  What LB policy to use for intra-locality routing.
 If unset, will use whatever algorithm is specified by the balancer.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig child_policy = 2;
        Specified by:
        getChildPolicyList in interface XdsConfigOrBuilder

      • getChildPolicyOrBuilderList

        public List<? extends LoadBalancingConfigOrBuilder> getChildPolicyOrBuilderList()
         Optional.  What LB policy to use for intra-locality routing.
 If unset, will use whatever algorithm is specified by the balancer.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig child_policy = 2;
        Specified by:
        getChildPolicyOrBuilderList in interface XdsConfigOrBuilder

      • getChildPolicyCount

        public int getChildPolicyCount()
         Optional.  What LB policy to use for intra-locality routing.
 If unset, will use whatever algorithm is specified by the balancer.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig child_policy = 2;
        Specified by:
        getChildPolicyCount in interface XdsConfigOrBuilder

      • getChildPolicy

        public LoadBalancingConfig getChildPolicy​(int index)
         Optional.  What LB policy to use for intra-locality routing.
 If unset, will use whatever algorithm is specified by the balancer.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig child_policy = 2;
        Specified by:
        getChildPolicy in interface XdsConfigOrBuilder

      • getChildPolicyOrBuilder

        public LoadBalancingConfigOrBuilder getChildPolicyOrBuilder​(int index)
         Optional.  What LB policy to use for intra-locality routing.
 If unset, will use whatever algorithm is specified by the balancer.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig child_policy = 2;
        Specified by:
        getChildPolicyOrBuilder in interface XdsConfigOrBuilder

      • getFallbackPolicyList

        public List<LoadBalancingConfig> getFallbackPolicyList()
         Optional.  What LB policy to use in fallback mode.  If not
 specified, defaults to round_robin.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig fallback_policy = 3;
        Specified by:
        getFallbackPolicyList in interface XdsConfigOrBuilder

      • getFallbackPolicyOrBuilderList

        public List<? extends LoadBalancingConfigOrBuilder> getFallbackPolicyOrBuilderList()
         Optional.  What LB policy to use in fallback mode.  If not
 specified, defaults to round_robin.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig fallback_policy = 3;
        Specified by:
        getFallbackPolicyOrBuilderList in interface XdsConfigOrBuilder

      • getFallbackPolicyCount

        public int getFallbackPolicyCount()
         Optional.  What LB policy to use in fallback mode.  If not
 specified, defaults to round_robin.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig fallback_policy = 3;
        Specified by:
        getFallbackPolicyCount in interface XdsConfigOrBuilder

      • getFallbackPolicy

        public LoadBalancingConfig getFallbackPolicy​(int index)
         Optional.  What LB policy to use in fallback mode.  If not
 specified, defaults to round_robin.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig fallback_policy = 3;
        Specified by:
        getFallbackPolicy in interface XdsConfigOrBuilder

      • getFallbackPolicyOrBuilder

        public LoadBalancingConfigOrBuilder getFallbackPolicyOrBuilder​(int index)
         Optional.  What LB policy to use in fallback mode.  If not
 specified, defaults to round_robin.
 Multiple LB policies can be specified; clients will iterate through
 the list in order and stop at the first policy that they support.
        repeated .grpc.service_config.LoadBalancingConfig fallback_policy = 3;
        Specified by:
        getFallbackPolicyOrBuilder in interface XdsConfigOrBuilder

      • getEdsServiceName

        public String getEdsServiceName()
         Optional.  Name to use in EDS query.  If not present, defaults to
 the server name from the target URI.
        string eds_service_name = 4;
        Specified by:
        getEdsServiceName in interface XdsConfigOrBuilder
        Returns:
        The edsServiceName.

      • getEdsServiceNameBytes

        public com.google.protobuf.ByteString getEdsServiceNameBytes()
         Optional.  Name to use in EDS query.  If not present, defaults to
 the server name from the target URI.
        string eds_service_name = 4;
        Specified by:
        getEdsServiceNameBytes in interface XdsConfigOrBuilder
        Returns:
        The bytes for edsServiceName.

      • hasLrsLoadReportingServerName

        public boolean hasLrsLoadReportingServerName()
         LRS server to send load reports to.
 If not present, load reporting will be disabled.
 If set to the empty string, load reporting will be sent to the same
 server that we obtained CDS data from.
        .google.protobuf.StringValue lrs_load_reporting_server_name = 5;
        Specified by:
        hasLrsLoadReportingServerName in interface XdsConfigOrBuilder
        Returns:
        Whether the lrsLoadReportingServerName field is set.

      • getLrsLoadReportingServerName

        public com.google.protobuf.StringValue getLrsLoadReportingServerName()
         LRS server to send load reports to.
 If not present, load reporting will be disabled.
 If set to the empty string, load reporting will be sent to the same
 server that we obtained CDS data from.
        .google.protobuf.StringValue lrs_load_reporting_server_name = 5;
        Specified by:
        getLrsLoadReportingServerName in interface XdsConfigOrBuilder
        Returns:
        The lrsLoadReportingServerName.

      • getLrsLoadReportingServerNameOrBuilder

        public com.google.protobuf.StringValueOrBuilder getLrsLoadReportingServerNameOrBuilder()
         LRS server to send load reports to.
 If not present, load reporting will be disabled.
 If set to the empty string, load reporting will be sent to the same
 server that we obtained CDS data from.
        .google.protobuf.StringValue lrs_load_reporting_server_name = 5;
        Specified by:
        getLrsLoadReportingServerNameOrBuilder in interface XdsConfigOrBuilder

      • 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 XdsConfig parseFrom​(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static XdsConfig parseFrom​(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static XdsConfig parseFrom​(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static XdsConfig parseFrom​(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static XdsConfig parseFrom​(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static XdsConfig parseFrom​(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static XdsConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Throws:
        IOException

      • newBuilderForType

        public XdsConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public XdsConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected XdsConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static XdsConfig getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<XdsConfig> 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 XdsConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder