Package com.google.rpc.context
Interface AttributeContext.RequestOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
AttributeContext.Request
,AttributeContext.Request.Builder
- Enclosing class:
- AttributeContext
public static interface AttributeContext.RequestOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
containsHeaders(java.lang.String key)
The HTTP request headers.AttributeContext.Auth
getAuth()
The request authentication.AttributeContext.AuthOrBuilder
getAuthOrBuilder()
The request authentication.java.util.Map<java.lang.String,java.lang.String>
getHeaders()
Deprecated.int
getHeadersCount()
The HTTP request headers.java.util.Map<java.lang.String,java.lang.String>
getHeadersMap()
The HTTP request headers.java.lang.String
getHeadersOrDefault(java.lang.String key, java.lang.String defaultValue)
The HTTP request headers.java.lang.String
getHeadersOrThrow(java.lang.String key)
The HTTP request headers.java.lang.String
getHost()
The HTTP request `Host` header value.com.google.protobuf.ByteString
getHostBytes()
The HTTP request `Host` header value.java.lang.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.java.lang.String
getMethod()
The HTTP request method, such as `GET`, `POST`.com.google.protobuf.ByteString
getMethodBytes()
The HTTP request method, such as `GET`, `POST`.java.lang.String
getPath()
The HTTP URL path, excluding the query parameters.com.google.protobuf.ByteString
getPathBytes()
The HTTP URL path, excluding the query parameters.java.lang.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".java.lang.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.java.lang.String
getReason()
A special parameter for request reason.com.google.protobuf.ByteString
getReasonBytes()
A special parameter for request reason.java.lang.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.com.google.protobuf.TimestampOrBuilder
getTimeOrBuilder()
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.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getId
java.lang.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;
- 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;
- Returns:
- The bytes for id.
-
getMethod
java.lang.String getMethod()
The HTTP request method, such as `GET`, `POST`.
string method = 2;
- Returns:
- The method.
-
getMethodBytes
com.google.protobuf.ByteString getMethodBytes()
The HTTP request method, such as `GET`, `POST`.
string method = 2;
- 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;
-
containsHeaders
boolean containsHeaders(java.lang.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;
-
getHeaders
@Deprecated java.util.Map<java.lang.String,java.lang.String> getHeaders()
Deprecated.UsegetHeadersMap()
instead.
-
getHeadersMap
java.util.Map<java.lang.String,java.lang.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;
-
getHeadersOrDefault
java.lang.String getHeadersOrDefault(java.lang.String key, java.lang.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;
-
getHeadersOrThrow
java.lang.String getHeadersOrThrow(java.lang.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;
-
getPath
java.lang.String getPath()
The HTTP URL path, excluding the query parameters.
string path = 4;
- Returns:
- The path.
-
getPathBytes
com.google.protobuf.ByteString getPathBytes()
The HTTP URL path, excluding the query parameters.
string path = 4;
- Returns:
- The bytes for path.
-
getHost
java.lang.String getHost()
The HTTP request `Host` header value.
string host = 5;
- Returns:
- The host.
-
getHostBytes
com.google.protobuf.ByteString getHostBytes()
The HTTP request `Host` header value.
string host = 5;
- Returns:
- The bytes for host.
-
getScheme
java.lang.String getScheme()
The HTTP URL scheme, such as `http` and `https`.
string scheme = 6;
- Returns:
- The scheme.
-
getSchemeBytes
com.google.protobuf.ByteString getSchemeBytes()
The HTTP URL scheme, such as `http` and `https`.
string scheme = 6;
- Returns:
- The bytes for scheme.
-
getQuery
java.lang.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;
- 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;
- 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;
- 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;
- Returns:
- The time.
-
getTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getTimeOrBuilder()
The timestamp when the `destination` service receives the last byte of the request.
.google.protobuf.Timestamp time = 9;
-
getSize
long getSize()
The HTTP request size in bytes. If unknown, it must be -1.
int64 size = 10;
- Returns:
- The size.
-
getProtocol
java.lang.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;
- 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;
- Returns:
- The bytes for protocol.
-
getReason
java.lang.String getReason()
A special parameter for request reason. It is used by security systems to associate auditing information with a request.
string reason = 12;
- 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;
- 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;
- 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;
- Returns:
- The auth.
-
getAuthOrBuilder
AttributeContext.AuthOrBuilder getAuthOrBuilder()
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;
-
-