Class protos.google.cloud.compute.v1.HttpHeaderMatch (4.6.0)

Represents a HttpHeaderMatch.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new HttpHeaderMatch.

Parameter
Name Description
properties IHttpHeaderMatch

Properties to set

Properties

_exactMatch

public _exactMatch?: "exactMatch";

HttpHeaderMatch _exactMatch.

_headerName

public _headerName?: "headerName";

HttpHeaderMatch _headerName.

_invertMatch

public _invertMatch?: "invertMatch";

HttpHeaderMatch _invertMatch.

_prefixMatch

public _prefixMatch?: "prefixMatch";

HttpHeaderMatch _prefixMatch.

_presentMatch

public _presentMatch?: "presentMatch";

HttpHeaderMatch _presentMatch.

_rangeMatch

public _rangeMatch?: "rangeMatch";

HttpHeaderMatch _rangeMatch.

_regexMatch

public _regexMatch?: "regexMatch";

HttpHeaderMatch _regexMatch.

_suffixMatch

public _suffixMatch?: "suffixMatch";

HttpHeaderMatch _suffixMatch.

exactMatch

public exactMatch?: (string|null);

HttpHeaderMatch exactMatch.

headerName

public headerName?: (string|null);

HttpHeaderMatch headerName.

invertMatch

public invertMatch?: (boolean|null);

HttpHeaderMatch invertMatch.

prefixMatch

public prefixMatch?: (string|null);

HttpHeaderMatch prefixMatch.

presentMatch

public presentMatch?: (boolean|null);

HttpHeaderMatch presentMatch.

rangeMatch

public rangeMatch?: (google.cloud.compute.v1.IInt64RangeMatch|null);

HttpHeaderMatch rangeMatch.

regexMatch

public regexMatch?: (string|null);

HttpHeaderMatch regexMatch.

suffixMatch

public suffixMatch?: (string|null);

HttpHeaderMatch suffixMatch.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IHttpHeaderMatch): google.cloud.compute.v1.HttpHeaderMatch;

Creates a new HttpHeaderMatch instance using the specified properties.

Parameter
Name Description
properties IHttpHeaderMatch

Properties to set

Returns
Type Description
HttpHeaderMatch

HttpHeaderMatch instance

decode(reader, length)

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

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

HttpHeaderMatch

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HttpHeaderMatch

HttpHeaderMatch

encode(message, writer)

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

Encodes the specified HttpHeaderMatch message. Does not implicitly messages.

Parameters
Name Description
message IHttpHeaderMatch

HttpHeaderMatch 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.IHttpHeaderMatch, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IHttpHeaderMatch

HttpHeaderMatch 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.HttpHeaderMatch;

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

HttpHeaderMatch

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HttpHeaderMatch

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HttpHeaderMatch

HttpHeaderMatch

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 HttpHeaderMatch 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