Class protos.google.api.HttpRule (6.0.0)
Represents a HttpRule.
Package
@google-cloud/bigtableConstructors
(constructor)(properties)
constructor(properties?:google.api.IHttpRule);Constructs a new HttpRule.
| Parameter | |
|---|---|
| Name | Description |
properties | IHttpRuleProperties to set |
Properties
additionalBindings
publicadditionalBindings:google.api.IHttpRule[];HttpRule additionalBindings.
body
publicbody:string;HttpRule body.
custom
publiccustom?:(google.api.ICustomHttpPattern|null);HttpRule custom.
delete
publicdelete?:(string|null);HttpRule delete.
get
publicget?:(string|null);HttpRule get.
patch
publicpatch?:(string|null);HttpRule patch.
pattern
publicpattern?:("get"|"put"|"post"|"delete"|"patch"|"custom");HttpRule pattern.
post
publicpost?:(string|null);HttpRule post.
put
publicput?:(string|null);HttpRule put.
responseBody
publicresponseBody:string;HttpRule responseBody.
selector
publicselector:string;HttpRule selector.
Methods
create(properties)
publicstaticcreate(properties?:google.api.IHttpRule):google.api.HttpRule;Creates a new HttpRule instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IHttpRuleProperties to set |
| Returns | |
|---|---|
| Type | Description |
HttpRule | HttpRule instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.api.HttpRule;Decodes a HttpRule message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
HttpRule | HttpRule |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.api.HttpRule;Decodes a HttpRule message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
HttpRule | HttpRule |
encode(message, writer)
publicstaticencode(message:google.api.IHttpRule,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified HttpRule message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IHttpRuleHttpRule message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.api.IHttpRule,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified HttpRule message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IHttpRuleHttpRule message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.api.HttpRule;Creates a HttpRule 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 |
HttpRule | HttpRule |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for HttpRule
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this HttpRule to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.api.HttpRule,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a HttpRule message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | HttpRuleHttpRule |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a HttpRule message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.