Class protos.google.cloud.compute.v1.PathMatcher (4.5.0)

Represents a PathMatcher.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new PathMatcher.

Parameter
Name Description
properties IPathMatcher

Properties to set

Properties

_defaultRouteAction

public _defaultRouteAction?: "defaultRouteAction";

PathMatcher _defaultRouteAction.

_defaultService

public _defaultService?: "defaultService";

PathMatcher _defaultService.

_defaultUrlRedirect

public _defaultUrlRedirect?: "defaultUrlRedirect";

PathMatcher _defaultUrlRedirect.

_description

public _description?: "description";

PathMatcher _description.

_headerAction

public _headerAction?: "headerAction";

PathMatcher _headerAction.

_name

public _name?: "name";

PathMatcher _name.

defaultRouteAction

public defaultRouteAction?: (google.cloud.compute.v1.IHttpRouteAction|null);

PathMatcher defaultRouteAction.

defaultService

public defaultService?: (string|null);

PathMatcher defaultService.

defaultUrlRedirect

public defaultUrlRedirect?: (google.cloud.compute.v1.IHttpRedirectAction|null);

PathMatcher defaultUrlRedirect.

description

public description?: (string|null);

PathMatcher description.

headerAction

public headerAction?: (google.cloud.compute.v1.IHttpHeaderAction|null);

PathMatcher headerAction.

name

public name?: (string|null);

PathMatcher name.

pathRules

public pathRules: google.cloud.compute.v1.IPathRule[];

PathMatcher pathRules.

routeRules

public routeRules: google.cloud.compute.v1.IHttpRouteRule[];

PathMatcher routeRules.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IPathMatcher): google.cloud.compute.v1.PathMatcher;

Creates a new PathMatcher instance using the specified properties.

Parameter
Name Description
properties IPathMatcher

Properties to set

Returns
Type Description
PathMatcher

PathMatcher instance

decode(reader, length)

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

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

PathMatcher

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PathMatcher

PathMatcher

encode(message, writer)

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

Encodes the specified PathMatcher message. Does not implicitly messages.

Parameters
Name Description
message IPathMatcher

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

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

Parameters
Name Description
message IPathMatcher

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

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

PathMatcher

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PathMatcher

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message PathMatcher

PathMatcher

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