CustomHttpPattern

google.api. CustomHttpPattern

Represents a CustomHttpPattern.

Constructor

new CustomHttpPattern(propertiesopt)

Constructs a new CustomHttpPattern.

Parameters:
Name Type Attributes Description
properties google.api.ICustomHttpPattern <optional>

Properties to set
Implements:
  • ICustomHttpPattern

Members

kind

CustomHttpPattern kind.

path

CustomHttpPattern path.

Methods

(static) create(propertiesopt) → {google.api.CustomHttpPattern}

Creates a new CustomHttpPattern instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.api.ICustomHttpPattern <optional>

Properties to set
Returns:
Type Description
google.api.CustomHttpPattern

CustomHttpPattern instance

(static) decode(reader, lengthopt) → {google.api.CustomHttpPattern}

Decodes a CustomHttpPattern message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.api.CustomHttpPattern

CustomHttpPattern
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.api.CustomHttpPattern}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.api.CustomHttpPattern

CustomHttpPattern
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.api.ICustomHttpPattern

CustomHttpPattern message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.api.ICustomHttpPattern

CustomHttpPattern message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.api.CustomHttpPattern}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.api.CustomHttpPattern

CustomHttpPattern

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for CustomHttpPattern

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.api.CustomHttpPattern

CustomHttpPattern
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a CustomHttpPattern message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this CustomHttpPattern to JSON.

Returns:
Type Description
Object.<string, *>

JSON object