Represents a HttpRule.
Package
@google-cloud/bigquery-migrationConstructors
(constructor)(properties)
constructor(properties?: google.api.IHttpRule);Constructs a new HttpRule.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHttpRule
Properties to set |
Properties
additionalBindings
public additionalBindings: google.api.IHttpRule[];HttpRule additionalBindings.
body
public body: string;HttpRule body.
custom
public custom?: (google.api.ICustomHttpPattern|null);HttpRule custom.
delete
public delete?: (string|null);HttpRule delete.
get
public get?: (string|null);HttpRule get.
patch
public patch?: (string|null);HttpRule patch.
pattern
public pattern?: ("get"|"put"|"post"|"delete"|"patch"|"custom");HttpRule pattern.
post
public post?: (string|null);HttpRule post.
put
public put?: (string|null);HttpRule put.
responseBody
public responseBody: string;HttpRule responseBody.
selector
public selector: string;HttpRule selector.
Methods
create(properties)
public static create(properties?: google.api.IHttpRule): google.api.HttpRule;Creates a new HttpRule instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHttpRule
Properties to set |
| Returns | |
|---|---|
| Type | Description |
HttpRule | HttpRule instance |
decode(reader, length)
public static decode(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 |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
HttpRule | HttpRule |
decodeDelimited(reader)
public static decodeDelimited(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)
public static encode(message: google.api.IHttpRule, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HttpRule message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHttpRule
HttpRule 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.IHttpRule, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HttpRule message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHttpRule
HttpRule 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.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)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for HttpRule
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this HttpRule to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(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 |
HttpRule
HttpRule |
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 HttpRule message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|