Represents a Request.
Package
@google-cloud/service-controlConstructors
(constructor)(properties)
constructor(properties?: google.rpc.context.AttributeContext.IRequest);Constructs a new Request.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRequest
Properties to set |
Properties
auth
public auth?: (google.rpc.context.AttributeContext.IAuth|null);Request auth.
headers
public headers: { [k: string]: string };Request headers.
host
public host: string;Request host.
id
public id: string;Request id.
method
public method: string;Request method.
path
public path: string;Request path.
protocol
public protocol: string;Request protocol.
query
public query: string;Request query.
reason
public reason: string;Request reason.
scheme
public scheme: string;Request scheme.
size
public size: (number|Long|string);Request size.
time
public time?: (google.protobuf.ITimestamp|null);Request time.
Methods
create(properties)
public static create(properties?: google.rpc.context.AttributeContext.IRequest): google.rpc.context.AttributeContext.Request;Creates a new Request instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Request | Request instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.rpc.context.AttributeContext.Request;Decodes a Request 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 |
Request | Request |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.rpc.context.AttributeContext.Request;Decodes a Request message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Request | Request |
encode(message, writer)
public static encode(message: google.rpc.context.AttributeContext.IRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Request message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRequest
Request 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.rpc.context.AttributeContext.IRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Request message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRequest
Request 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.rpc.context.AttributeContext.Request;Creates a Request 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 |
Request | Request |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Request
| 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 Request to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.rpc.context.AttributeContext.Request, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Request message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Request
Request |
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 Request message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|