Package com.google.rpc.context

Interface AttributeContext.RequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
AttributeContext.Request, AttributeContext.Request.Builder
Enclosing class:
AttributeContext
public static interface AttributeContext.RequestOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsHeaders(String key)
    The HTTP request headers.
    AttributeContext.Auth
    getAuth()
    The request authentication.
    Map<String,String>
    getHeaders()
    Deprecated.
    int
    getHeadersCount()
    The HTTP request headers.
    Map<String,String>
    getHeadersMap()
    The HTTP request headers.
    String
    getHeadersOrDefault(String key, String defaultValue)
    The HTTP request headers.
    String
    getHeadersOrThrow(String key)
    The HTTP request headers.
    String
    getHost()
    The HTTP request `Host` header value.
    com.google.protobuf.ByteString
    getHostBytes()
    The HTTP request `Host` header value.
    String
    getId()
    The unique ID for a request, which can be propagated to downstream systems.
    com.google.protobuf.ByteString
    getIdBytes()
    The unique ID for a request, which can be propagated to downstream systems.
    String
    getMethod()
    The HTTP request method, such as `GET`, `POST`.
    com.google.protobuf.ByteString
    getMethodBytes()
    The HTTP request method, such as `GET`, `POST`.
    String
    getPath()
    The HTTP URL path, excluding the query parameters.
    com.google.protobuf.ByteString
    getPathBytes()
    The HTTP URL path, excluding the query parameters.
    String
    getProtocol()
    The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic".
    com.google.protobuf.ByteString
    getProtocolBytes()
    The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic".
    String
    getQuery()
    The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears in the first line of the HTTP request.
    com.google.protobuf.ByteString
    getQueryBytes()
    The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears in the first line of the HTTP request.
    String
    getReason()
    A special parameter for request reason.
    com.google.protobuf.ByteString
    getReasonBytes()
    A special parameter for request reason.
    String
    getScheme()
    The HTTP URL scheme, such as `http` and `https`.
    com.google.protobuf.ByteString
    getSchemeBytes()
    The HTTP URL scheme, such as `http` and `https`.
    long
    getSize()
    The HTTP request size in bytes.
    com.google.protobuf.Timestamp
    getTime()
    The timestamp when the `destination` service receives the last byte of the request.
    boolean
    hasAuth()
    The request authentication.
    boolean
    hasTime()
    The timestamp when the `destination` service receives the last byte of the request.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getId

      String getId()
       The unique ID for a request, which can be propagated to downstream
 systems. The ID should have low probability of collision
 within a single day for a specific service.
      string id = 1 [json_name = "id"];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       The unique ID for a request, which can be propagated to downstream
 systems. The ID should have low probability of collision
 within a single day for a specific service.
      string id = 1 [json_name = "id"];
      Returns:
      The bytes for id.

    • getMethod

      String getMethod()
       The HTTP request method, such as `GET`, `POST`.
      string method = 2 [json_name = "method"];
      Returns:
      The method.

    • getMethodBytes

      com.google.protobuf.ByteString getMethodBytes()
       The HTTP request method, such as `GET`, `POST`.
      string method = 2 [json_name = "method"];
      Returns:
      The bytes for method.

    • getHeadersCount

      int getHeadersCount()
       The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lowercased, because HTTP header keys are case-insensitive.
      map<string, string> headers = 3 [json_name = "headers"];

    • containsHeaders

      boolean containsHeaders(String key)
       The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lowercased, because HTTP header keys are case-insensitive.
      map<string, string> headers = 3 [json_name = "headers"];

    • getHeaders

      @Deprecated Map<String,String> getHeaders()
      Deprecated.
      Use getHeadersMap() instead.

    • getHeadersMap

      Map<String,String> getHeadersMap()
       The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lowercased, because HTTP header keys are case-insensitive.
      map<string, string> headers = 3 [json_name = "headers"];

    • getHeadersOrDefault

      String getHeadersOrDefault(String key, String defaultValue)
       The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lowercased, because HTTP header keys are case-insensitive.
      map<string, string> headers = 3 [json_name = "headers"];

    • getHeadersOrThrow

      String getHeadersOrThrow(String key)
       The HTTP request headers. If multiple headers share the same key, they
 must be merged according to the HTTP spec. All header keys must be
 lowercased, because HTTP header keys are case-insensitive.
      map<string, string> headers = 3 [json_name = "headers"];

    • getPath

      String getPath()
       The HTTP URL path, excluding the query parameters.
      string path = 4 [json_name = "path"];
      Returns:
      The path.

    • getPathBytes

      com.google.protobuf.ByteString getPathBytes()
       The HTTP URL path, excluding the query parameters.
      string path = 4 [json_name = "path"];
      Returns:
      The bytes for path.

    • getHost

      String getHost()
       The HTTP request `Host` header value.
      string host = 5 [json_name = "host"];
      Returns:
      The host.

    • getHostBytes

      com.google.protobuf.ByteString getHostBytes()
       The HTTP request `Host` header value.
      string host = 5 [json_name = "host"];
      Returns:
      The bytes for host.

    • getScheme

      String getScheme()
       The HTTP URL scheme, such as `http` and `https`.
      string scheme = 6 [json_name = "scheme"];
      Returns:
      The scheme.

    • getSchemeBytes

      com.google.protobuf.ByteString getSchemeBytes()
       The HTTP URL scheme, such as `http` and `https`.
      string scheme = 6 [json_name = "scheme"];
      Returns:
      The bytes for scheme.

    • getQuery

      String getQuery()
       The HTTP URL query in the format of `name1=value1&name2=value2`, as it
 appears in the first line of the HTTP request. No decoding is performed.
      string query = 7 [json_name = "query"];
      Returns:
      The query.

    • getQueryBytes

      com.google.protobuf.ByteString getQueryBytes()
       The HTTP URL query in the format of `name1=value1&name2=value2`, as it
 appears in the first line of the HTTP request. No decoding is performed.
      string query = 7 [json_name = "query"];
      Returns:
      The bytes for query.

    • hasTime

      boolean hasTime()
       The timestamp when the `destination` service receives the last byte of
 the request.
      .google.protobuf.Timestamp time = 9 [json_name = "time"];
      Returns:
      Whether the time field is set.

    • getTime

      com.google.protobuf.Timestamp getTime()
       The timestamp when the `destination` service receives the last byte of
 the request.
      .google.protobuf.Timestamp time = 9 [json_name = "time"];
      Returns:
      The time.

    • getSize

      long getSize()
       The HTTP request size in bytes. If unknown, it must be -1.
      int64 size = 10 [json_name = "size"];
      Returns:
      The size.

    • getProtocol

      String getProtocol()
       The network protocol used with the request, such as "http/1.1",
 "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See
 https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
 for details.
      string protocol = 11 [json_name = "protocol"];
      Returns:
      The protocol.

    • getProtocolBytes

      com.google.protobuf.ByteString getProtocolBytes()
       The network protocol used with the request, such as "http/1.1",
 "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See
 https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
 for details.
      string protocol = 11 [json_name = "protocol"];
      Returns:
      The bytes for protocol.

    • getReason

      String getReason()
       A special parameter for request reason. It is used by security systems
 to associate auditing information with a request.
      string reason = 12 [json_name = "reason"];
      Returns:
      The reason.

    • getReasonBytes

      com.google.protobuf.ByteString getReasonBytes()
       A special parameter for request reason. It is used by security systems
 to associate auditing information with a request.
      string reason = 12 [json_name = "reason"];
      Returns:
      The bytes for reason.

    • hasAuth

      boolean hasAuth()
       The request authentication. May be absent for unauthenticated requests.
 Derived from the HTTP request `Authorization` header or equivalent.
      .google.rpc.context.AttributeContext.Auth auth = 13 [json_name = "auth"];
      Returns:
      Whether the auth field is set.

    • getAuth

      AttributeContext.Auth getAuth()
       The request authentication. May be absent for unauthenticated requests.
 Derived from the HTTP request `Authorization` header or equivalent.
      .google.rpc.context.AttributeContext.Auth auth = 13 [json_name = "auth"];
      Returns:
      The auth.