Class protos.google.cloud.networkservices.v1.GrpcRoute.HeaderMatch (0.2.1)

Represents a HeaderMatch.

Package

@google-cloud/networkservices

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkservices.v1.GrpcRoute.IHeaderMatch);

Constructs a new HeaderMatch.

Parameter
Name Description
properties IHeaderMatch

Properties to set

Properties

key

public key: string;

HeaderMatch key.

type

public type: (google.cloud.networkservices.v1.GrpcRoute.HeaderMatch.Type|keyof typeof google.cloud.networkservices.v1.GrpcRoute.HeaderMatch.Type);

HeaderMatch type.

value

public value: string;

HeaderMatch value.

Methods

create(properties)

public static create(properties?: google.cloud.networkservices.v1.GrpcRoute.IHeaderMatch): google.cloud.networkservices.v1.GrpcRoute.HeaderMatch;

Creates a new HeaderMatch instance using the specified properties.

Parameter
Name Description
properties IHeaderMatch

Properties to set

Returns
Type Description
HeaderMatch

HeaderMatch instance

decode(reader, length)

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

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

HeaderMatch

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkservices.v1.GrpcRoute.HeaderMatch;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HeaderMatch

HeaderMatch

encode(message, writer)

public static encode(message: google.cloud.networkservices.v1.GrpcRoute.IHeaderMatch, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified HeaderMatch message. Does not implicitly messages.

Parameters
Name Description
message IHeaderMatch

HeaderMatch 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.networkservices.v1.GrpcRoute.IHeaderMatch, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IHeaderMatch

HeaderMatch 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.networkservices.v1.GrpcRoute.HeaderMatch;

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

HeaderMatch

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HeaderMatch

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HeaderMatch

HeaderMatch

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