Package com.google.cloud.compute.v1

Interface HttpRouteRuleMatchOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HttpRouteRuleMatch, HttpRouteRuleMatch.Builder
    public interface HttpRouteRuleMatchOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFullPathMatch()
      For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
      com.google.protobuf.ByteString getFullPathMatchBytes()
      For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
      HttpHeaderMatch getHeaderMatches​(int index)
      Specifies a list of header match criteria, all of which must match corresponding headers in the request.
      int getHeaderMatchesCount()
      Specifies a list of header match criteria, all of which must match corresponding headers in the request.
      List<HttpHeaderMatch> getHeaderMatchesList()
      Specifies a list of header match criteria, all of which must match corresponding headers in the request.
      HttpHeaderMatchOrBuilder getHeaderMatchesOrBuilder​(int index)
      Specifies a list of header match criteria, all of which must match corresponding headers in the request.
      List<? extends HttpHeaderMatchOrBuilder> getHeaderMatchesOrBuilderList()
      Specifies a list of header match criteria, all of which must match corresponding headers in the request.
      boolean getIgnoreCase()
      Specifies that prefixMatch and fullPathMatch matches are case sensitive.
      MetadataFilter getMetadataFilters​(int index)
      Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients.
      int getMetadataFiltersCount()
      Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients.
      List<MetadataFilter> getMetadataFiltersList()
      Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients.
      MetadataFilterOrBuilder getMetadataFiltersOrBuilder​(int index)
      Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients.
      List<? extends MetadataFilterOrBuilder> getMetadataFiltersOrBuilderList()
      Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients.
      String getPathTemplateMatch()
      If specified, the route is a pattern match expression that must match the :path header once the query string is removed.
      com.google.protobuf.ByteString getPathTemplateMatchBytes()
      If specified, the route is a pattern match expression that must match the :path header once the query string is removed.
      String getPrefixMatch()
      For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch.
      com.google.protobuf.ByteString getPrefixMatchBytes()
      For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch.
      HttpQueryParameterMatch getQueryParameterMatches​(int index)
      Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
      int getQueryParameterMatchesCount()
      Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
      List<HttpQueryParameterMatch> getQueryParameterMatchesList()
      Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
      HttpQueryParameterMatchOrBuilder getQueryParameterMatchesOrBuilder​(int index)
      Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
      List<? extends HttpQueryParameterMatchOrBuilder> getQueryParameterMatchesOrBuilderList()
      Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
      String getRegexMatch()
      For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL.
      com.google.protobuf.ByteString getRegexMatchBytes()
      For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL.
      boolean hasFullPathMatch()
      For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
      boolean hasIgnoreCase()
      Specifies that prefixMatch and fullPathMatch matches are case sensitive.
      boolean hasPathTemplateMatch()
      If specified, the route is a pattern match expression that must match the :path header once the query string is removed.
      boolean hasPrefixMatch()
      For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch.
      boolean hasRegexMatch()
      For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasFullPathMatch

        boolean hasFullPathMatch()
         For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
        optional string full_path_match = 214598875;
        Returns:
        Whether the fullPathMatch field is set.

      • getFullPathMatch

        String getFullPathMatch()
         For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
        optional string full_path_match = 214598875;
        Returns:
        The fullPathMatch.

      • getFullPathMatchBytes

        com.google.protobuf.ByteString getFullPathMatchBytes()
         For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
        optional string full_path_match = 214598875;
        Returns:
        The bytes for fullPathMatch.

      • getHeaderMatchesList

        List<HttpHeaderMatch> getHeaderMatchesList()
         Specifies a list of header match criteria, all of which must match corresponding headers in the request.
        repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

      • getHeaderMatches

        HttpHeaderMatch getHeaderMatches​(int index)
         Specifies a list of header match criteria, all of which must match corresponding headers in the request.
        repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

      • getHeaderMatchesCount

        int getHeaderMatchesCount()
         Specifies a list of header match criteria, all of which must match corresponding headers in the request.
        repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

      • getHeaderMatchesOrBuilderList

        List<? extends HttpHeaderMatchOrBuilder> getHeaderMatchesOrBuilderList()
         Specifies a list of header match criteria, all of which must match corresponding headers in the request.
        repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

      • getHeaderMatchesOrBuilder

        HttpHeaderMatchOrBuilder getHeaderMatchesOrBuilder​(int index)
         Specifies a list of header match criteria, all of which must match corresponding headers in the request.
        repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

      • hasIgnoreCase

        boolean hasIgnoreCase()
         Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.
        optional bool ignore_case = 464324989;
        Returns:
        Whether the ignoreCase field is set.

      • getIgnoreCase

        boolean getIgnoreCase()
         Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.
        optional bool ignore_case = 464324989;
        Returns:
        The ignoreCase.

      • getMetadataFiltersList

        List<MetadataFilter> getMetadataFiltersList()
         Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
        repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

      • getMetadataFilters

        MetadataFilter getMetadataFilters​(int index)
         Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
        repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

      • getMetadataFiltersCount

        int getMetadataFiltersCount()
         Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
        repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

      • getMetadataFiltersOrBuilderList

        List<? extends MetadataFilterOrBuilder> getMetadataFiltersOrBuilderList()
         Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
        repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

      • getMetadataFiltersOrBuilder

        MetadataFilterOrBuilder getMetadataFiltersOrBuilder​(int index)
         Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
        repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

      • hasPathTemplateMatch

        boolean hasPathTemplateMatch()
         If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash ("/") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.
        optional string path_template_match = 292348186;
        Returns:
        Whether the pathTemplateMatch field is set.

      • getPathTemplateMatch

        String getPathTemplateMatch()
         If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash ("/") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.
        optional string path_template_match = 292348186;
        Returns:
        The pathTemplateMatch.

      • getPathTemplateMatchBytes

        com.google.protobuf.ByteString getPathTemplateMatchBytes()
         If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash ("/") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.
        optional string path_template_match = 292348186;
        Returns:
        The bytes for pathTemplateMatch.

      • hasPrefixMatch

        boolean hasPrefixMatch()
         For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
        optional string prefix_match = 257898968;
        Returns:
        Whether the prefixMatch field is set.

      • getPrefixMatch

        String getPrefixMatch()
         For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
        optional string prefix_match = 257898968;
        Returns:
        The prefixMatch.

      • getPrefixMatchBytes

        com.google.protobuf.ByteString getPrefixMatchBytes()
         For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
        optional string prefix_match = 257898968;
        Returns:
        The bytes for prefixMatch.

      • getQueryParameterMatchesList

        List<HttpQueryParameterMatch> getQueryParameterMatchesList()
         Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.
        repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

      • getQueryParameterMatches

        HttpQueryParameterMatch getQueryParameterMatches​(int index)
         Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.
        repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

      • getQueryParameterMatchesCount

        int getQueryParameterMatchesCount()
         Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.
        repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

      • getQueryParameterMatchesOrBuilderList

        List<? extends HttpQueryParameterMatchOrBuilder> getQueryParameterMatchesOrBuilderList()
         Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.
        repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

      • getQueryParameterMatchesOrBuilder

        HttpQueryParameterMatchOrBuilder getQueryParameterMatchesOrBuilder​(int index)
         Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.
        repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

      • hasRegexMatch

        boolean hasRegexMatch()
         For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.
        optional string regex_match = 107387853;
        Returns:
        Whether the regexMatch field is set.

      • getRegexMatch

        String getRegexMatch()
         For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.
        optional string regex_match = 107387853;
        Returns:
        The regexMatch.

      • getRegexMatchBytes

        com.google.protobuf.ByteString getRegexMatchBytes()
         For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.
        optional string regex_match = 107387853;
        Returns:
        The bytes for regexMatch.