Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.compute.v1.UrlMap (3.1.2)

Represents an UrlMap.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new UrlMap.

Parameter

Name	Description
properties	`IUrlMap` Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

UrlMap _creationTimestamp.

_defaultRouteAction

public _defaultRouteAction?: "defaultRouteAction";

UrlMap _defaultRouteAction.

_defaultService

public _defaultService?: "defaultService";

UrlMap _defaultService.

_defaultUrlRedirect

public _defaultUrlRedirect?: "defaultUrlRedirect";

UrlMap _defaultUrlRedirect.

_description

public _description?: "description";

UrlMap _description.

_fingerprint

public _fingerprint?: "fingerprint";

UrlMap _fingerprint.

_headerAction

public _headerAction?: "headerAction";

UrlMap _headerAction.

_id

public _id?: "id";

UrlMap _id.

_kind

public _kind?: "kind";

UrlMap _kind.

_name

public _name?: "name";

UrlMap _name.

_region

public _region?: "region";

UrlMap _region.

_selfLink

public _selfLink?: "selfLink";

UrlMap _selfLink.

creationTimestamp

public creationTimestamp?: (string|null);

UrlMap creationTimestamp.

defaultRouteAction

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

UrlMap defaultRouteAction.

defaultService

public defaultService?: (string|null);

UrlMap defaultService.

defaultUrlRedirect

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

UrlMap defaultUrlRedirect.

description

public description?: (string|null);

UrlMap description.

fingerprint

public fingerprint?: (string|null);

UrlMap fingerprint.

headerAction

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

UrlMap headerAction.

hostRules

public hostRules: google.cloud.compute.v1.IHostRule[];

UrlMap hostRules.

id

public id?: (number|Long|string|null);

UrlMap id.

kind

public kind?: (string|null);

UrlMap kind.

name

public name?: (string|null);

UrlMap name.

pathMatchers

public pathMatchers: google.cloud.compute.v1.IPathMatcher[];

UrlMap pathMatchers.

region

public region?: (string|null);

UrlMap region.

selfLink

public selfLink?: (string|null);

UrlMap selfLink.

tests

public tests: google.cloud.compute.v1.IUrlMapTest[];

UrlMap tests.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IUrlMap): google.cloud.compute.v1.UrlMap;

Creates a new UrlMap instance using the specified properties.

Parameter

Name	Description
properties	`IUrlMap` Properties to set

Returns

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

decode(reader, length)

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

Decodes an UrlMap 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.UrlMap	UrlMap

decodeDelimited(reader)

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

Decodes an UrlMap 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.UrlMap	UrlMap

encode(message, writer)

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

Encodes the specified UrlMap message. Does not implicitly messages.

Parameters

Name	Description
message	`IUrlMap` UrlMap 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.IUrlMap, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IUrlMap` UrlMap 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.UrlMap;

Creates an UrlMap 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.UrlMap	UrlMap

toJSON()

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

Converts this UrlMap to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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