Package k8s.io.api.networking.v1

Class Generated.IngressRule

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Generated.IngressRuleOrBuilder
    Enclosing class:
    Generated
    public static final class Generated.IngressRule
extends com.google.protobuf.GeneratedMessageV3
implements Generated.IngressRuleOrBuilder
     IngressRule represents the rules mapping the paths under a specified host to
 the related backend services. Incoming requests are first evaluated for a host
 match, then routed to the backend associated with the matching IngressRuleValue.
    Protobuf type k8s.io.api.networking.v1.IngressRule
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Generated.IngressRule.Builder
      IngressRule represents the rules mapping the paths under a specified host to the related backend services.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int HOST_FIELD_NUMBER  
      static int INGRESSRULEVALUE_FIELD_NUMBER  
      static com.google.protobuf.Parser<Generated.IngressRule> PARSER
      Deprecated.

      • 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 Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance 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

      • hasHost

        public boolean hasHost()
         host is the fully qualified domain name of a network host, as defined by RFC 3986.
 Note the following deviations from the "host" part of the
 URI as defined in RFC 3986:
 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
    the IP in the Spec of the parent Ingress.
 2. The `:` delimiter is not respected because ports are not allowed.
          Currently the port of an Ingress is implicitly :80 for http and
          :443 for https.
 Both these may change in the future.
 Incoming requests are matched against the host before the
 IngressRuleValue. If the host is unspecified, the Ingress routes all
 traffic based on the specified IngressRuleValue.

 host can be "precise" which is a domain name without the terminating dot of
 a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name
 prefixed with a single wildcard label (e.g. "*.foo.com").
 The wildcard character '*' must appear by itself as the first DNS label and
 matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*").
 Requests will be matched against the Host field in the following way:
 1. If host is precise, the request matches this rule if the http host header is equal to Host.
 2. If host is a wildcard, then the request matches this rule if the http host header
 is to equal to the suffix (removing the first label) of the wildcard rule.
 +optional
        optional string host = 1;
        Specified by:
        hasHost in interface Generated.IngressRuleOrBuilder
        Returns:
        Whether the host field is set.

      • getHost

        public String getHost()
         host is the fully qualified domain name of a network host, as defined by RFC 3986.
 Note the following deviations from the "host" part of the
 URI as defined in RFC 3986:
 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
    the IP in the Spec of the parent Ingress.
 2. The `:` delimiter is not respected because ports are not allowed.
          Currently the port of an Ingress is implicitly :80 for http and
          :443 for https.
 Both these may change in the future.
 Incoming requests are matched against the host before the
 IngressRuleValue. If the host is unspecified, the Ingress routes all
 traffic based on the specified IngressRuleValue.

 host can be "precise" which is a domain name without the terminating dot of
 a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name
 prefixed with a single wildcard label (e.g. "*.foo.com").
 The wildcard character '*' must appear by itself as the first DNS label and
 matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*").
 Requests will be matched against the Host field in the following way:
 1. If host is precise, the request matches this rule if the http host header is equal to Host.
 2. If host is a wildcard, then the request matches this rule if the http host header
 is to equal to the suffix (removing the first label) of the wildcard rule.
 +optional
        optional string host = 1;
        Specified by:
        getHost in interface Generated.IngressRuleOrBuilder
        Returns:
        The host.

      • getHostBytes

        public com.google.protobuf.ByteString getHostBytes()
         host is the fully qualified domain name of a network host, as defined by RFC 3986.
 Note the following deviations from the "host" part of the
 URI as defined in RFC 3986:
 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
    the IP in the Spec of the parent Ingress.
 2. The `:` delimiter is not respected because ports are not allowed.
          Currently the port of an Ingress is implicitly :80 for http and
          :443 for https.
 Both these may change in the future.
 Incoming requests are matched against the host before the
 IngressRuleValue. If the host is unspecified, the Ingress routes all
 traffic based on the specified IngressRuleValue.

 host can be "precise" which is a domain name without the terminating dot of
 a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name
 prefixed with a single wildcard label (e.g. "*.foo.com").
 The wildcard character '*' must appear by itself as the first DNS label and
 matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*").
 Requests will be matched against the Host field in the following way:
 1. If host is precise, the request matches this rule if the http host header is equal to Host.
 2. If host is a wildcard, then the request matches this rule if the http host header
 is to equal to the suffix (removing the first label) of the wildcard rule.
 +optional
        optional string host = 1;
        Specified by:
        getHostBytes in interface Generated.IngressRuleOrBuilder
        Returns:
        The bytes for host.

      • hasIngressRuleValue

        public boolean hasIngressRuleValue()
         IngressRuleValue represents a rule to route requests for this IngressRule.
 If unspecified, the rule defaults to a http catch-all. Whether that sends
 just traffic matching the host to the default backend or all traffic to the
 default backend, is left to the controller fulfilling the Ingress. Http is
 currently the only supported IngressRuleValue.
 +optional
        optional .k8s.io.api.networking.v1.IngressRuleValue ingressRuleValue = 2;
        Specified by:
        hasIngressRuleValue in interface Generated.IngressRuleOrBuilder
        Returns:
        Whether the ingressRuleValue field is set.

      • getIngressRuleValue

        public Generated.IngressRuleValue getIngressRuleValue()
         IngressRuleValue represents a rule to route requests for this IngressRule.
 If unspecified, the rule defaults to a http catch-all. Whether that sends
 just traffic matching the host to the default backend or all traffic to the
 default backend, is left to the controller fulfilling the Ingress. Http is
 currently the only supported IngressRuleValue.
 +optional
        optional .k8s.io.api.networking.v1.IngressRuleValue ingressRuleValue = 2;
        Specified by:
        getIngressRuleValue in interface Generated.IngressRuleOrBuilder
        Returns:
        The ingressRuleValue.

      • getIngressRuleValueOrBuilder

        public Generated.IngressRuleValueOrBuilder getIngressRuleValueOrBuilder()
         IngressRuleValue represents a rule to route requests for this IngressRule.
 If unspecified, the rule defaults to a http catch-all. Whether that sends
 just traffic matching the host to the default backend or all traffic to the
 default backend, is left to the controller fulfilling the Ingress. Http is
 currently the only supported IngressRuleValue.
 +optional
        optional .k8s.io.api.networking.v1.IngressRuleValue ingressRuleValue = 2;
        Specified by:
        getIngressRuleValueOrBuilder in interface Generated.IngressRuleOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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