Class protos.google.backstory.Http (0.10.1)

Represents a Http.

Implements

Package

@google-cloud/chronicle

Constructors

(constructor)(properties)

constructor(properties?: google.backstory.IHttp);

Constructs a new Http.

Parameter
Name Description
properties IHttp

Properties to set

Properties

method

public method: string;

Http method.

referralUrl

public referralUrl: string;

Http referralUrl.

responseCode

public responseCode: number;

Http responseCode.

userAgent

public userAgent: string;

Http userAgent.

Methods

create(properties)

public static create(properties?: google.backstory.IHttp): google.backstory.Http;

Creates a new Http instance using the specified properties.

Parameter
Name Description
properties IHttp

Properties to set

Returns
Type Description
Http

Http instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.backstory.Http;

Decodes a Http 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
Http

Http

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.backstory.Http;

Decodes a Http message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Http

Http

encode(message, writer)

public static encode(message: google.backstory.IHttp, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Http message. Does not implicitly messages.

Parameters
Name Description
message IHttp

Http 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.backstory.IHttp, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Http message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IHttp

Http 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.backstory.Http;

Creates a Http 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
Http

Http

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Http

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 Http to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.backstory.Http, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Http message. Also converts values to other types if specified.

Parameters
Name Description
message Http

Http

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 Http message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not