HttpRule

google.api. HttpRule

Represents a HttpRule.

Constructor

new HttpRule(propertiesopt)

Constructs a new HttpRule.

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

Properties to set
Implements:
  • IHttpRule

Members

additionalBindings

HttpRule additionalBindings.

body

HttpRule body.

custom

HttpRule custom.

delete

HttpRule delete.

get

HttpRule get.

patch

HttpRule patch.

pattern

HttpRule pattern.

post

HttpRule post.

put

HttpRule put.

responseBody

HttpRule responseBody.

selector

HttpRule selector.

Methods

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

Creates a new HttpRule instance using the specified properties.

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

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

HttpRule instance

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

Decodes a HttpRule 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.HttpRule

HttpRule
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.HttpRule}

Decodes a HttpRule 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.HttpRule

HttpRule
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 HttpRule message. Does not implicitly verify messages.

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

HttpRule 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 HttpRule message, length delimited. Does not implicitly verify messages.

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

HttpRule 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.HttpRule}

Creates a HttpRule 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.HttpRule

HttpRule

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for HttpRule

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 HttpRule message. Also converts values to other types if specified.

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

HttpRule
options $protobuf.IConversionOptions <optional>

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

Plain object

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

Verifies a HttpRule 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 HttpRule to JSON.

Returns:
Type Description
Object.<string, *>

JSON object