Class google.api.CustomHttpPattern (2.1.1)

Represents a CustomHttpPattern.

Package

@google-cloud/scheduler!

Constructors

(constructor)(properties)

constructor(properties?: google.api.ICustomHttpPattern);

Constructs a new CustomHttpPattern.

Parameter
Name Description
properties ICustomHttpPattern

Properties to set

Properties

kind

public kind: string;

CustomHttpPattern kind.

Property Value
Type Description
string

path

public path: string;

CustomHttpPattern path.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.api.ICustomHttpPattern): google.api.CustomHttpPattern;

Creates a new CustomHttpPattern instance using the specified properties.

Parameter
Name Description
properties ICustomHttpPattern

Properties to set
Returns
Type Description
CustomHttpPattern

CustomHttpPattern instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.CustomHttpPattern;

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

CustomHttpPattern

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.CustomHttpPattern;

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

CustomHttpPattern

encode(message, writer)

public static encode(message: google.api.ICustomHttpPattern, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CustomHttpPattern message. Does not implicitly verify messages.

Parameters
Name Description
message ICustomHttpPattern

CustomHttpPattern 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.api.ICustomHttpPattern, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICustomHttpPattern

CustomHttpPattern 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.api.CustomHttpPattern;

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

CustomHttpPattern

toJSON()

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

Converts this CustomHttpPattern to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: google.api.CustomHttpPattern, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message CustomHttpPattern

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