Class protos.google.cloud.compute.v1.HttpHeaderOption (3.0.0)

Represents a HttpHeaderOption.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IHttpHeaderOption);

Constructs a new HttpHeaderOption.

Parameter

Name	Description
properties	`IHttpHeaderOption` Properties to set

Properties

_headerName

public _headerName?: "headerName";

HttpHeaderOption _headerName.

_headerValue

public _headerValue?: "headerValue";

HttpHeaderOption _headerValue.

_replace

public _replace?: "replace";

HttpHeaderOption _replace.

headerName

public headerName?: (string|null);

HttpHeaderOption headerName.

headerValue

public headerValue?: (string|null);

HttpHeaderOption headerValue.

replace

public replace?: (boolean|null);

HttpHeaderOption replace.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IHttpHeaderOption): google.cloud.compute.v1.HttpHeaderOption;

Creates a new HttpHeaderOption instance using the specified properties.

Parameter

Name	Description
properties	`IHttpHeaderOption` Properties to set

Returns

Type	Description
google.cloud.compute.v1.HttpHeaderOption	HttpHeaderOption instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.HttpHeaderOption;

Decodes a HttpHeaderOption message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.compute.v1.HttpHeaderOption	HttpHeaderOption

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.HttpHeaderOption;

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.compute.v1.HttpHeaderOption	HttpHeaderOption

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IHttpHeaderOption, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified HttpHeaderOption message. Does not implicitly messages.

Parameters

Name	Description
message	`IHttpHeaderOption` HttpHeaderOption 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.cloud.compute.v1.IHttpHeaderOption, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IHttpHeaderOption` HttpHeaderOption 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.cloud.compute.v1.HttpHeaderOption;

Creates a HttpHeaderOption 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
google.cloud.compute.v1.HttpHeaderOption	HttpHeaderOption

toJSON()

public toJSON(): { [k: string]: any };

Converts this HttpHeaderOption to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.HttpHeaderOption, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.cloud.compute.v1.HttpHeaderOption` HttpHeaderOption
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 HttpHeaderOption 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