shade.polaris.io.grpc.lookup.v1.HttpKeyBuilderOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of polaris-all Show documentation
All in one project for polaris-java
There is a newer version: 2.0.0.0
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: grpc/lookup/v1/rls_config.proto

package io.grpc.lookup.v1;

public interface HttpKeyBuilderOrBuilder extends
    // @@protoc_insertion_point(interface_extends:grpc.lookup.v1.HttpKeyBuilder)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   * @return A list containing the hostPatterns.
   */
  java.util.List
      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;
   * @return The count of hostPatterns.
   */
  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;
   * @param index The index of the element to return.
   * @return The hostPatterns at the given index.
   */
  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;
   * @param index The index of the value to return.
   * @return The bytes of the hostPatterns at the given index.
   */
  com.google.protobuf.ByteString
      getHostPatternsBytes(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;
   * @return A list containing the pathPatterns.
   */
  java.util.List
      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;
   * @return The count of pathPatterns.
   */
  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;
   * @param index The index of the element to return.
   * @return The pathPatterns at the given index.
   */
  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;
   * @param index The index of the value to return.
   * @return The bytes of the pathPatterns at the given index.
   */
  com.google.protobuf.ByteString
      getPathPatternsBytes(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;
   */
  java.util.List 
      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;
   */
  io.grpc.lookup.v1.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;
   */
  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;
   */
  java.util.List 
      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;
   */
  io.grpc.lookup.v1.NameMatcherOrBuilder getQueryParametersOrBuilder(
      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;
   */
  java.util.List 
      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;
   */
  io.grpc.lookup.v1.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;
   */
  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;
   */
  java.util.List 
      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;
   */
  io.grpc.lookup.v1.NameMatcherOrBuilder getHeadersOrBuilder(
      int index);

  /**
   *    * 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;
   */
  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;
   */
  boolean containsConstantKeys(
      java.lang.String key);
  /**
   * Use {@link #getConstantKeysMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getConstantKeys();
  /**
   *    * 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;
   */
  java.util.Map
  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;
   */
  /* nullable */
java.lang.String getConstantKeysOrDefault(
      java.lang.String key,
      /* nullable */
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;
   */
  java.lang.String getConstantKeysOrThrow(
      java.lang.String key);
}