Skip to main content

Class: CustomHttpPattern

A custom pattern is used for defining custom HTTP verb.

Properties​

kind​

kind: string

The name of this custom HTTP verb.

path​

path: string

The path matched by this custom verb.

Methods​

toJSON()​

toJSON(): object

Converts this CustomHttpPattern to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CustomHttpPattern & $Properties

Creates a new CustomHttpPattern instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CustomHttpPattern & $Properties

CustomHttpPattern instance

Call Signature​

static create(properties?): CustomHttpPattern

Creates a new CustomHttpPattern instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CustomHttpPattern

CustomHttpPattern instance

decode()​

static decode(reader, length?): CustomHttpPattern & $Properties

Decodes a CustomHttpPattern message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

CustomHttpPattern & $Properties

CustomHttpPattern

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CustomHttpPattern & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CustomHttpPattern & $Properties

CustomHttpPattern

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified CustomHttpPattern message. Does not implicitly google.api.CustomHttpPattern.verify|verify messages.

Parameters​

message​

$Properties

CustomHttpPattern message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CustomHttpPattern message, length delimited. Does not implicitly google.api.CustomHttpPattern.verify|verify messages.

Parameters​

message​

$Properties

CustomHttpPattern message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CustomHttpPattern

Creates a CustomHttpPattern message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CustomHttpPattern

CustomHttpPattern

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CustomHttpPattern

CustomHttpPattern

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object