Interface AttributeContext.RequestOrBuilder (2.49.0)

Version latest

• 2.49.0 (latest)
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public static interface AttributeContext.RequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsHeaders(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAuth()

public abstract 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
Type	Description
AttributeContext.Auth	The auth.

getAuthOrBuilder()

public abstract 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;

Returns
Type	Description
AttributeContext.AuthOrBuilder

getHeaders() (deprecated)

public abstract Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
Type	Description
Map<String,String>

getHeadersCount()

public abstract 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;

Returns
Type	Description
int

getHeadersMap()

public abstract 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;

Returns
Type	Description
Map<String,String>

getHeadersOrDefault(String key, String defaultValue)

public abstract 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;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getHeadersOrThrow(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getHost()

public abstract String getHost()

The HTTP request Host header value.

string host = 5;

Returns
Type	Description
String	The host.

getHostBytes()

public abstract ByteString getHostBytes()

The HTTP request Host header value.

string host = 5;

Returns
Type	Description
ByteString	The bytes for host.

getId()

public abstract 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
Type	Description
String	The id.

getIdBytes()

public abstract 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
Type	Description
ByteString	The bytes for id.

getMethod()

public abstract String getMethod()

The HTTP request method, such as GET, POST.

string method = 2;

Returns
Type	Description
String	The method.

getMethodBytes()

public abstract ByteString getMethodBytes()

The HTTP request method, such as GET, POST.

string method = 2;

Returns
Type	Description
ByteString	The bytes for method.

getPath()

public abstract String getPath()

The HTTP URL path, excluding the query parameters.

string path = 4;

Returns
Type	Description
String	The path.

getPathBytes()

public abstract ByteString getPathBytes()

The HTTP URL path, excluding the query parameters.

string path = 4;

Returns
Type	Description
ByteString	The bytes for path.

getProtocol()

public abstract 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
Type	Description
String	The protocol.

getProtocolBytes()

public abstract 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
Type	Description
ByteString	The bytes for protocol.

getQuery()

public abstract 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
Type	Description
String	The query.

getQueryBytes()

public abstract 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
Type	Description
ByteString	The bytes for query.

getReason()

public abstract 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
Type	Description
String	The reason.

getReasonBytes()

public abstract 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
Type	Description
ByteString	The bytes for reason.

getScheme()

public abstract String getScheme()

The HTTP URL scheme, such as http and https.

string scheme = 6;

Returns
Type	Description
String	The scheme.

getSchemeBytes()

public abstract ByteString getSchemeBytes()

The HTTP URL scheme, such as http and https.

string scheme = 6;

Returns
Type	Description
ByteString	The bytes for scheme.

getSize()

public abstract long getSize()

The HTTP request size in bytes. If unknown, it must be -1.

int64 size = 10;

Returns
Type	Description
long	The size.

getTime()

public abstract Timestamp getTime()

The timestamp when the destination service receives the last byte of the request.

.google.protobuf.Timestamp time = 9;

Returns
Type	Description
Timestamp	The time.

getTimeOrBuilder()

public abstract TimestampOrBuilder getTimeOrBuilder()

The timestamp when the destination service receives the last byte of the request.

.google.protobuf.Timestamp time = 9;

Returns
Type	Description
TimestampOrBuilder

hasAuth()

public abstract 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
Type	Description
boolean	Whether the auth field is set.

hasTime()

public abstract boolean hasTime()

The timestamp when the destination service receives the last byte of the request.

.google.protobuf.Timestamp time = 9;

Returns
Type	Description
boolean	Whether the time field is set.