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

Modifier and Type	Method and Description
boolean	containsHeaders(String key) The HTTP request headers.
AttributeContext.Auth	getAuth() The request authentication.
AttributeContext.AuthOrBuilder	getAuthOrBuilder() 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.
com.google.protobuf.ByteString	getPathBytes() The HTTP URL path.
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 first byte of the request.
com.google.protobuf.TimestampOrBuilder	getTimeOrBuilder() The timestamp when the `destination` service receives the first byte of the request.
boolean	hasAuth() The request authentication.
boolean	hasTime() The timestamp when the `destination` service receives the first byte of the request.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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;

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

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(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
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;

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;

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;

getPath

String getPath()

 The HTTP URL path.
 

string path = 4;

Returns:

The path.

getPathBytes

com.google.protobuf.ByteString getPathBytes()

 The HTTP URL path.
 

string path = 4;

Returns:

The bytes for path.

getHost

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

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

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 first 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 first 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 first 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

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

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;