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

Represents a HttpRouteRule.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new HttpRouteRule.

Parameter
Name Description
properties IHttpRouteRule

Properties to set

Properties

_description

public _description?: "description";

HttpRouteRule _description.

_headerAction

public _headerAction?: "headerAction";

HttpRouteRule _headerAction.

_priority

public _priority?: "priority";

HttpRouteRule _priority.

_routeAction

public _routeAction?: "routeAction";

HttpRouteRule _routeAction.

_service

public _service?: "service";

HttpRouteRule _service.

_urlRedirect

public _urlRedirect?: "urlRedirect";

HttpRouteRule _urlRedirect.

description

public description?: (string|null);

HttpRouteRule description.

headerAction

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

HttpRouteRule headerAction.

matchRules

public matchRules: google.cloud.compute.v1.IHttpRouteRuleMatch[];

HttpRouteRule matchRules.

priority

public priority?: (number|null);

HttpRouteRule priority.

routeAction

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

HttpRouteRule routeAction.

service

public service?: (string|null);

HttpRouteRule service.

urlRedirect

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

HttpRouteRule urlRedirect.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IHttpRouteRule): google.cloud.compute.v1.HttpRouteRule;

Creates a new HttpRouteRule instance using the specified properties.

Parameter
Name Description
properties IHttpRouteRule

Properties to set

Returns
Type Description
HttpRouteRule

HttpRouteRule instance

decode(reader, length)

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

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

HttpRouteRule

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HttpRouteRule

HttpRouteRule

encode(message, writer)

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

Encodes the specified HttpRouteRule message. Does not implicitly messages.

Parameters
Name Description
message IHttpRouteRule

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

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

Parameters
Name Description
message IHttpRouteRule

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

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

HttpRouteRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HttpRouteRule

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HttpRouteRule

HttpRouteRule

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