Represents a HttpRequest.
Package
@google-cloud/service-controlConstructors
(constructor)(properties)
constructor(properties?: google.api.servicecontrol.v1.IHttpRequest);Constructs a new HttpRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHttpRequest
Properties to set |
Properties
cacheFillBytes
public cacheFillBytes: (number|Long|string);HttpRequest cacheFillBytes.
cacheHit
public cacheHit: boolean;HttpRequest cacheHit.
cacheLookup
public cacheLookup: boolean;HttpRequest cacheLookup.
cacheValidatedWithOriginServer
public cacheValidatedWithOriginServer: boolean;HttpRequest cacheValidatedWithOriginServer.
latency
public latency?: (google.protobuf.IDuration|null);HttpRequest latency.
protocol
public protocol: string;HttpRequest protocol.
referer
public referer: string;HttpRequest referer.
remoteIp
public remoteIp: string;HttpRequest remoteIp.
requestMethod
public requestMethod: string;HttpRequest requestMethod.
requestSize
public requestSize: (number|Long|string);HttpRequest requestSize.
requestUrl
public requestUrl: string;HttpRequest requestUrl.
responseSize
public responseSize: (number|Long|string);HttpRequest responseSize.
serverIp
public serverIp: string;HttpRequest serverIp.
status
public status: number;HttpRequest status.
userAgent
public userAgent: string;HttpRequest userAgent.
Methods
create(properties)
public static create(properties?: google.api.servicecontrol.v1.IHttpRequest): google.api.servicecontrol.v1.HttpRequest;Creates a new HttpRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHttpRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
HttpRequest | HttpRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.servicecontrol.v1.HttpRequest;Decodes a HttpRequest message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
HttpRequest | HttpRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.servicecontrol.v1.HttpRequest;Decodes a HttpRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
HttpRequest | HttpRequest |
encode(message, writer)
public static encode(message: google.api.servicecontrol.v1.IHttpRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HttpRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHttpRequest
HttpRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.api.servicecontrol.v1.IHttpRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HttpRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHttpRequest
HttpRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.api.servicecontrol.v1.HttpRequest;Creates a HttpRequest message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
HttpRequest | HttpRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for HttpRequest
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this HttpRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.api.servicecontrol.v1.HttpRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a HttpRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
HttpRequest
HttpRequest |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a HttpRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|