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 :Array.<google.api.IHttpRule>

HttpRule additionalBindings.

body :string

HttpRule body.

custom :google.api.ICustomHttpPattern|null|undefined

HttpRule custom.

delete :string

HttpRule delete.

get :string

HttpRule get.

patch :string

HttpRule patch.

pattern :"get"|"put"|"post"|"delete"|"patch"|"custom"|undefined

HttpRule pattern.

post :string

HttpRule post.

put :string

HttpRule put.

responseBody :string

HttpRule responseBody.

selector :string

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

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

(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

(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

(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

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

Verifies a HttpRule message.

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

Plain object to verify

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

Converts this HttpRule to JSON.