Request (Service Control API v2-rev20240802-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.servicecontrol.v2.model.Request

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Request
extends com.google.api.client.json.GenericJson
```
This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Service Control API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Request()

Constructors
Constructor and Description
`Request()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Request`	`clone()`
`Auth`	`getAuth()` The request authentication.
`Map<String,String>`	`getHeaders()` The HTTP request headers.
`String`	`getHost()` The HTTP request `Host` header value.
`String`	`getId()` The unique ID for a request, which can be propagated to downstream systems.
`String`	`getMethod()` The HTTP request method, such as `GET`, `POST`.
`String`	`getPath()` 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".
`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.
`String`	`getReason()` A special parameter for request reason.
`String`	`getScheme()` The HTTP URL scheme, such as `http` and `https`.
`Long`	`getSize()` The HTTP request size in bytes.
`String`	`getTime()` The timestamp when the `destination` service receives the last byte of the request.
`Request`	`set(String fieldName, Object value)`
`Request`	`setAuth(Auth auth)` The request authentication.
`Request`	`setHeaders(Map<String,String> headers)` The HTTP request headers.
`Request`	`setHost(String host)` The HTTP request `Host` header value.
`Request`	`setId(String id)` The unique ID for a request, which can be propagated to downstream systems.
`Request`	`setMethod(String method)` The HTTP request method, such as `GET`, `POST`.
`Request`	`setPath(String path)` The HTTP URL path, excluding the query parameters.
`Request`	`setProtocol(String protocol)` The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic".
`Request`	`setQuery(String query)` The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears in the first line of the HTTP request.
`Request`	`setReason(String reason)` A special parameter for request reason.
`Request`	`setScheme(String scheme)` The HTTP URL scheme, such as `http` and `https`.
`Request`	`setSize(Long size)` The HTTP request size in bytes.
`Request`	`setTime(String time)` The timestamp when the `destination` service receives the last byte of the request.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Request
```
public Request()
```
- Method Detail
  - getAuth
```
public Auth getAuth()
```
    The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request `Authorization` header or equivalent.
    
    Returns:
    
    value or null for none
  - setAuth
```
public Request setAuth(Auth auth)
```
    The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request `Authorization` header or equivalent.
    
    Parameters:
    
    auth - auth or null for none
  - getHeaders
```
public Map<String,String> getHeaders()
```
    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.
    
    Returns:
    
    value or null for none
  - setHeaders
```
public Request setHeaders(Map<String,String> headers)
```
    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.
    
    Parameters:
    
    headers - headers or null for none
  - getHost
```
public String getHost()
```
    The HTTP request `Host` header value.
    
    Returns:
    
    value or null for none
  - setHost
```
public Request setHost(String host)
```
    The HTTP request `Host` header value.
    
    Parameters:
    
    host - host or null for none
  - getId
```
public 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.
    
    Returns:
    
    value or null for none
  - setId
```
public Request setId(String id)
```
    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.
    
    Parameters:
    
    id - id or null for none
  - getMethod
```
public String getMethod()
```
    The HTTP request method, such as `GET`, `POST`.
    
    Returns:
    
    value or null for none
  - setMethod
```
public Request setMethod(String method)
```
    The HTTP request method, such as `GET`, `POST`.
    
    Parameters:
    
    method - method or null for none
  - getPath
```
public String getPath()
```
    The HTTP URL path, excluding the query parameters.
    
    Returns:
    
    value or null for none
  - setPath
```
public Request setPath(String path)
```
    The HTTP URL path, excluding the query parameters.
    
    Parameters:
    
    path - path or null for none
  - getProtocol
```
public 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.
    
    Returns:
    
    value or null for none
  - setProtocol
```
public Request setProtocol(String protocol)
```
    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.
    
    Parameters:
    
    protocol - protocol or null for none
  - getQuery
```
public 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.
    
    Returns:
    
    value or null for none
  - setQuery
```
public Request setQuery(String query)
```
    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.
    
    Parameters:
    
    query - query or null for none
  - getReason
```
public String getReason()
```
    A special parameter for request reason. It is used by security systems to associate auditing information with a request.
    
    Returns:
    
    value or null for none
  - setReason
```
public Request setReason(String reason)
```
    A special parameter for request reason. It is used by security systems to associate auditing information with a request.
    
    Parameters:
    
    reason - reason or null for none
  - getScheme
```
public String getScheme()
```
    The HTTP URL scheme, such as `http` and `https`.
    
    Returns:
    
    value or null for none
  - setScheme
```
public Request setScheme(String scheme)
```
    The HTTP URL scheme, such as `http` and `https`.
    
    Parameters:
    
    scheme - scheme or null for none
  - getSize
```
public Long getSize()
```
    The HTTP request size in bytes. If unknown, it must be -1.
    
    Returns:
    
    value or null for none
  - setSize
```
public Request setSize(Long size)
```
    The HTTP request size in bytes. If unknown, it must be -1.
    
    Parameters:
    
    size - size or null for none
  - getTime
```
public String getTime()
```
    The timestamp when the `destination` service receives the last byte of the request.
    
    Returns:
    
    value or null for none
  - setTime
```
public Request setTime(String time)
```
    The timestamp when the `destination` service receives the last byte of the request.
    
    Parameters:
    
    time - time or null for none
  - set
```
public Request set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Request clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Request

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Request

Method Detail

getAuth

setAuth

getHeaders

setHeaders

getHost

setHost

getId

setId

getMethod

setMethod

getPath

setPath

getProtocol

setProtocol

getQuery

setQuery

getReason

setReason

getScheme

setScheme

getSize

setSize

getTime

setTime

set

clone