Package io.grpc.lookup.v1

Interface HttpKeyBuilderOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsConstantKeys​(java.lang.String key)
      You can optionally set one or more specific key/value pairs to be added to the key_map.
      java.util.Map<java.lang.String,​java.lang.String> getConstantKeys()
      Deprecated.
      int getConstantKeysCount()
      You can optionally set one or more specific key/value pairs to be added to the key_map.
      java.util.Map<java.lang.String,​java.lang.String> getConstantKeysMap()
      You can optionally set one or more specific key/value pairs to be added to the key_map.
      java.lang.String getConstantKeysOrDefault​(java.lang.String key, java.lang.String defaultValue)
      You can optionally set one or more specific key/value pairs to be added to the key_map.
      java.lang.String getConstantKeysOrThrow​(java.lang.String key)
      You can optionally set one or more specific key/value pairs to be added to the key_map.
      NameMatcher getHeaders​(int index)
      List of headers to try to match.
      int getHeadersCount()
      List of headers to try to match.
      java.util.List<NameMatcher> getHeadersList()
      List of headers to try to match.
      NameMatcherOrBuilder getHeadersOrBuilder​(int index)
      List of headers to try to match.
      java.util.List<? extends NameMatcherOrBuilder> getHeadersOrBuilderList()
      List of headers to try to match.
      java.lang.String getHostPatterns​(int index)
      host_pattern is an ordered list of host template patterns for the desired value.
      com.google.protobuf.ByteString getHostPatternsBytes​(int index)
      host_pattern is an ordered list of host template patterns for the desired value.
      int getHostPatternsCount()
      host_pattern is an ordered list of host template patterns for the desired value.
      java.util.List<java.lang.String> getHostPatternsList()
      host_pattern is an ordered list of host template patterns for the desired value.
      java.lang.String getPathPatterns​(int index)
      path_pattern is an ordered list of path template patterns for the desired value.
      com.google.protobuf.ByteString getPathPatternsBytes​(int index)
      path_pattern is an ordered list of path template patterns for the desired value.
      int getPathPatternsCount()
      path_pattern is an ordered list of path template patterns for the desired value.
      java.util.List<java.lang.String> getPathPatternsList()
      path_pattern is an ordered list of path template patterns for the desired value.
      NameMatcher getQueryParameters​(int index)
      List of query parameter names to try to match.
      int getQueryParametersCount()
      List of query parameter names to try to match.
      java.util.List<NameMatcher> getQueryParametersList()
      List of query parameter names to try to match.
      NameMatcherOrBuilder getQueryParametersOrBuilder​(int index)
      List of query parameter names to try to match.
      java.util.List<? extends NameMatcherOrBuilder> getQueryParametersOrBuilderList()
      List of query parameter names to try to match.

      • 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

      • getHostPatternsList

        java.util.List<java.lang.String> getHostPatternsList()
         host_pattern is an ordered list of host template patterns for the desired
 value.  If any host_pattern values are specified, then at least one must
 match, and the last one wins and sets any specified variables.  A host
 consists of labels separated by dots. Each label is matched against the
 label in the pattern as follows:
 - "*": Matches any single label.
 - "**": Matches zero or more labels (first or last part of host only).
 - "{<name>=...}": One or more label capture, where "..." can be any
 template that does not include a capture.
 - "{<name>}": A single label capture. Identical to {<name>=*}.

 Examples:
 - "example.com": Only applies to the exact host example.com.
 - "*.example.com": Matches subdomains of example.com.
 - "**.example.com": matches example.com, and all levels of subdomains.
 - "{project}.example.com": Extracts the third level subdomain.
 - "{project=**}.example.com": Extracts the third level+ subdomains.
 - "{project=**}": Extracts the entire host.
        repeated string host_patterns = 1;
        Returns:
        A list containing the hostPatterns.

      • getHostPatternsCount

        int getHostPatternsCount()
         host_pattern is an ordered list of host template patterns for the desired
 value.  If any host_pattern values are specified, then at least one must
 match, and the last one wins and sets any specified variables.  A host
 consists of labels separated by dots. Each label is matched against the
 label in the pattern as follows:
 - "*": Matches any single label.
 - "**": Matches zero or more labels (first or last part of host only).
 - "{<name>=...}": One or more label capture, where "..." can be any
 template that does not include a capture.
 - "{<name>}": A single label capture. Identical to {<name>=*}.

 Examples:
 - "example.com": Only applies to the exact host example.com.
 - "*.example.com": Matches subdomains of example.com.
 - "**.example.com": matches example.com, and all levels of subdomains.
 - "{project}.example.com": Extracts the third level subdomain.
 - "{project=**}.example.com": Extracts the third level+ subdomains.
 - "{project=**}": Extracts the entire host.
        repeated string host_patterns = 1;
        Returns:
        The count of hostPatterns.

      • getHostPatterns

        java.lang.String getHostPatterns​(int index)
         host_pattern is an ordered list of host template patterns for the desired
 value.  If any host_pattern values are specified, then at least one must
 match, and the last one wins and sets any specified variables.  A host
 consists of labels separated by dots. Each label is matched against the
 label in the pattern as follows:
 - "*": Matches any single label.
 - "**": Matches zero or more labels (first or last part of host only).
 - "{<name>=...}": One or more label capture, where "..." can be any
 template that does not include a capture.
 - "{<name>}": A single label capture. Identical to {<name>=*}.

 Examples:
 - "example.com": Only applies to the exact host example.com.
 - "*.example.com": Matches subdomains of example.com.
 - "**.example.com": matches example.com, and all levels of subdomains.
 - "{project}.example.com": Extracts the third level subdomain.
 - "{project=**}.example.com": Extracts the third level+ subdomains.
 - "{project=**}": Extracts the entire host.
        repeated string host_patterns = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The hostPatterns at the given index.

      • getHostPatternsBytes

        com.google.protobuf.ByteString getHostPatternsBytes​(int index)
         host_pattern is an ordered list of host template patterns for the desired
 value.  If any host_pattern values are specified, then at least one must
 match, and the last one wins and sets any specified variables.  A host
 consists of labels separated by dots. Each label is matched against the
 label in the pattern as follows:
 - "*": Matches any single label.
 - "**": Matches zero or more labels (first or last part of host only).
 - "{<name>=...}": One or more label capture, where "..." can be any
 template that does not include a capture.
 - "{<name>}": A single label capture. Identical to {<name>=*}.

 Examples:
 - "example.com": Only applies to the exact host example.com.
 - "*.example.com": Matches subdomains of example.com.
 - "**.example.com": matches example.com, and all levels of subdomains.
 - "{project}.example.com": Extracts the third level subdomain.
 - "{project=**}.example.com": Extracts the third level+ subdomains.
 - "{project=**}": Extracts the entire host.
        repeated string host_patterns = 1;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the hostPatterns at the given index.

      • getPathPatternsList

        java.util.List<java.lang.String> getPathPatternsList()
         path_pattern is an ordered list of path template patterns for the desired
 value.  If any path_pattern values are specified, then at least one must
 match, and the last one wins and sets any specified variables.  A path
 consists of segments separated by slashes. Each segment is matched against
 the segment in the pattern as follows:
 - "*": Matches any single segment.
 - "**": Matches zero or more segments (first or last part of path only).
 - "{<name>=...}": One or more segment capture, where "..." can be any
 template that does not include a capture.
 - "{<name>}": A single segment capture. Identical to {<name>=*}.
 A custom method may also be specified by appending ":" and the custom
 method name or "*" to indicate any custom method (including no custom
 method).  For example, "/*/projects/{project_id}/**:*" extracts
 `{project_id}` for any version, resource and custom method that includes
 it.  By default, any custom method will be matched.

 Examples:
 - "/v1/{name=messages/*}": extracts a name like "messages/12345".
 - "/v1/messages/{message_id}": extracts a message_id like "12345".
 - "/v1/users/{user_id}/messages/{message_id}": extracts two key values.
        repeated string path_patterns = 2;
        Returns:
        A list containing the pathPatterns.

      • getPathPatternsCount

        int getPathPatternsCount()
         path_pattern is an ordered list of path template patterns for the desired
 value.  If any path_pattern values are specified, then at least one must
 match, and the last one wins and sets any specified variables.  A path
 consists of segments separated by slashes. Each segment is matched against
 the segment in the pattern as follows:
 - "*": Matches any single segment.
 - "**": Matches zero or more segments (first or last part of path only).
 - "{<name>=...}": One or more segment capture, where "..." can be any
 template that does not include a capture.
 - "{<name>}": A single segment capture. Identical to {<name>=*}.
 A custom method may also be specified by appending ":" and the custom
 method name or "*" to indicate any custom method (including no custom
 method).  For example, "/*/projects/{project_id}/**:*" extracts
 `{project_id}` for any version, resource and custom method that includes
 it.  By default, any custom method will be matched.

 Examples:
 - "/v1/{name=messages/*}": extracts a name like "messages/12345".
 - "/v1/messages/{message_id}": extracts a message_id like "12345".
 - "/v1/users/{user_id}/messages/{message_id}": extracts two key values.
        repeated string path_patterns = 2;
        Returns:
        The count of pathPatterns.

      • getPathPatterns

        java.lang.String getPathPatterns​(int index)
         path_pattern is an ordered list of path template patterns for the desired
 value.  If any path_pattern values are specified, then at least one must
 match, and the last one wins and sets any specified variables.  A path
 consists of segments separated by slashes. Each segment is matched against
 the segment in the pattern as follows:
 - "*": Matches any single segment.
 - "**": Matches zero or more segments (first or last part of path only).
 - "{<name>=...}": One or more segment capture, where "..." can be any
 template that does not include a capture.
 - "{<name>}": A single segment capture. Identical to {<name>=*}.
 A custom method may also be specified by appending ":" and the custom
 method name or "*" to indicate any custom method (including no custom
 method).  For example, "/*/projects/{project_id}/**:*" extracts
 `{project_id}` for any version, resource and custom method that includes
 it.  By default, any custom method will be matched.

 Examples:
 - "/v1/{name=messages/*}": extracts a name like "messages/12345".
 - "/v1/messages/{message_id}": extracts a message_id like "12345".
 - "/v1/users/{user_id}/messages/{message_id}": extracts two key values.
        repeated string path_patterns = 2;
        Parameters:
        index - The index of the element to return.
        Returns:
        The pathPatterns at the given index.

      • getPathPatternsBytes

        com.google.protobuf.ByteString getPathPatternsBytes​(int index)
         path_pattern is an ordered list of path template patterns for the desired
 value.  If any path_pattern values are specified, then at least one must
 match, and the last one wins and sets any specified variables.  A path
 consists of segments separated by slashes. Each segment is matched against
 the segment in the pattern as follows:
 - "*": Matches any single segment.
 - "**": Matches zero or more segments (first or last part of path only).
 - "{<name>=...}": One or more segment capture, where "..." can be any
 template that does not include a capture.
 - "{<name>}": A single segment capture. Identical to {<name>=*}.
 A custom method may also be specified by appending ":" and the custom
 method name or "*" to indicate any custom method (including no custom
 method).  For example, "/*/projects/{project_id}/**:*" extracts
 `{project_id}` for any version, resource and custom method that includes
 it.  By default, any custom method will be matched.

 Examples:
 - "/v1/{name=messages/*}": extracts a name like "messages/12345".
 - "/v1/messages/{message_id}": extracts a message_id like "12345".
 - "/v1/users/{user_id}/messages/{message_id}": extracts two key values.
        repeated string path_patterns = 2;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the pathPatterns at the given index.

      • getQueryParametersList

        java.util.List<NameMatcher> getQueryParametersList()
         List of query parameter names to try to match.
 For example: ["parent", "name", "resource.name"]
 We extract all the specified query_parameters (case-sensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given parameter appears multiple times (?foo=a&foo=b) we
 will report it as a comma-separated string (foo=a,b).
        repeated .grpc.lookup.v1.NameMatcher query_parameters = 3;

      • getQueryParameters

        NameMatcher getQueryParameters​(int index)
         List of query parameter names to try to match.
 For example: ["parent", "name", "resource.name"]
 We extract all the specified query_parameters (case-sensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given parameter appears multiple times (?foo=a&foo=b) we
 will report it as a comma-separated string (foo=a,b).
        repeated .grpc.lookup.v1.NameMatcher query_parameters = 3;

      • getQueryParametersCount

        int getQueryParametersCount()
         List of query parameter names to try to match.
 For example: ["parent", "name", "resource.name"]
 We extract all the specified query_parameters (case-sensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given parameter appears multiple times (?foo=a&foo=b) we
 will report it as a comma-separated string (foo=a,b).
        repeated .grpc.lookup.v1.NameMatcher query_parameters = 3;

      • getQueryParametersOrBuilderList

        java.util.List<? extends NameMatcherOrBuilder> getQueryParametersOrBuilderList()
         List of query parameter names to try to match.
 For example: ["parent", "name", "resource.name"]
 We extract all the specified query_parameters (case-sensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given parameter appears multiple times (?foo=a&foo=b) we
 will report it as a comma-separated string (foo=a,b).
        repeated .grpc.lookup.v1.NameMatcher query_parameters = 3;

      • getQueryParametersOrBuilder

        NameMatcherOrBuilder getQueryParametersOrBuilder​(int index)
         List of query parameter names to try to match.
 For example: ["parent", "name", "resource.name"]
 We extract all the specified query_parameters (case-sensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given parameter appears multiple times (?foo=a&foo=b) we
 will report it as a comma-separated string (foo=a,b).
        repeated .grpc.lookup.v1.NameMatcher query_parameters = 3;

      • getHeadersList

        java.util.List<NameMatcher> getHeadersList()
         List of headers to try to match.
 We extract all the specified header values (case-insensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given header appears multiple times in the request we will
 report it as a comma-separated string, in standard HTTP fashion.
        repeated .grpc.lookup.v1.NameMatcher headers = 4;

      • getHeaders

        NameMatcher getHeaders​(int index)
         List of headers to try to match.
 We extract all the specified header values (case-insensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given header appears multiple times in the request we will
 report it as a comma-separated string, in standard HTTP fashion.
        repeated .grpc.lookup.v1.NameMatcher headers = 4;

      • getHeadersCount

        int getHeadersCount()
         List of headers to try to match.
 We extract all the specified header values (case-insensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given header appears multiple times in the request we will
 report it as a comma-separated string, in standard HTTP fashion.
        repeated .grpc.lookup.v1.NameMatcher headers = 4;

      • getHeadersOrBuilderList

        java.util.List<? extends NameMatcherOrBuilder> getHeadersOrBuilderList()
         List of headers to try to match.
 We extract all the specified header values (case-insensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given header appears multiple times in the request we will
 report it as a comma-separated string, in standard HTTP fashion.
        repeated .grpc.lookup.v1.NameMatcher headers = 4;

      • getHeadersOrBuilder

        NameMatcherOrBuilder getHeadersOrBuilder​(int index)
         List of headers to try to match.
 We extract all the specified header values (case-insensitively).  If any
 are marked as "required_match" and are not present, this keybuilder fails
 to match.  If a given header appears multiple times in the request we will
 report it as a comma-separated string, in standard HTTP fashion.
        repeated .grpc.lookup.v1.NameMatcher headers = 4;

      • getConstantKeysCount

        int getConstantKeysCount()
         You can optionally set one or more specific key/value pairs to be added to
 the key_map.  This can be useful to identify which builder built the key,
 for example if you are suppressing a lot of information from the URL, but
 need to separately cache and request URLs with that content.
        map<string, string> constant_keys = 5;

      • containsConstantKeys

        boolean containsConstantKeys​(java.lang.String key)
         You can optionally set one or more specific key/value pairs to be added to
 the key_map.  This can be useful to identify which builder built the key,
 for example if you are suppressing a lot of information from the URL, but
 need to separately cache and request URLs with that content.
        map<string, string> constant_keys = 5;

      • getConstantKeys

        @Deprecated
java.util.Map<java.lang.String,​java.lang.String> getConstantKeys()
        Deprecated.
        Use getConstantKeysMap() instead.

      • getConstantKeysMap

        java.util.Map<java.lang.String,​java.lang.String> getConstantKeysMap()
         You can optionally set one or more specific key/value pairs to be added to
 the key_map.  This can be useful to identify which builder built the key,
 for example if you are suppressing a lot of information from the URL, but
 need to separately cache and request URLs with that content.
        map<string, string> constant_keys = 5;

      • getConstantKeysOrDefault

        java.lang.String getConstantKeysOrDefault​(java.lang.String key,
                                          java.lang.String defaultValue)
         You can optionally set one or more specific key/value pairs to be added to
 the key_map.  This can be useful to identify which builder built the key,
 for example if you are suppressing a lot of information from the URL, but
 need to separately cache and request URLs with that content.
        map<string, string> constant_keys = 5;

      • getConstantKeysOrThrow

        java.lang.String getConstantKeysOrThrow​(java.lang.String key)
         You can optionally set one or more specific key/value pairs to be added to
 the key_map.  This can be useful to identify which builder built the key,
 for example if you are suppressing a lot of information from the URL, but
 need to separately cache and request URLs with that content.
        map<string, string> constant_keys = 5;