Represents a HttpRule.
Package
@google-cloud/datacatalog!Constructors
(constructor)(properties)
constructor(properties?: google.api.IHttpRule);Constructs a new HttpRule.
| Type | Name | Description |
|---|---|---|
| IHttpRule | properties |
Properties to set |
Properties
additionalBindings
public additionalBindings: google.api.IHttpRule[];HttpRule additionalBindings.
| Type | Description |
|---|---|
| google.api.IHttpRule[] |
body
public body: string;HttpRule body.
| Type | Description |
|---|---|
| string |
custom
public custom?: (google.api.ICustomHttpPattern|null);HttpRule custom.
| Type | Description |
|---|---|
| (google.api.ICustomHttpPattern|null) |
delete
public delete?: (string|null);HttpRule delete.
| Type | Description |
|---|---|
| (string|null) |
get
public get?: (string|null);HttpRule get.
| Type | Description |
|---|---|
| (string|null) |
patch
public patch?: (string|null);HttpRule patch.
| Type | Description |
|---|---|
| (string|null) |
pattern
public pattern?: ("get"|"put"|"post"|"delete"|"patch"|"custom");HttpRule pattern.
| Type | Description |
|---|---|
| ("get"|"put"|"post"|"delete"|"patch"|"custom") |
post
public post?: (string|null);HttpRule post.
| Type | Description |
|---|---|
| (string|null) |
put
public put?: (string|null);HttpRule put.
| Type | Description |
|---|---|
| (string|null) |
responseBody
public responseBody: string;HttpRule responseBody.
| Type | Description |
|---|---|
| string |
selector
public selector: string;HttpRule selector.
| Type | Description |
|---|---|
| string |
Methods
create(properties)
public static create(properties?: google.api.IHttpRule): google.api.HttpRule;Creates a new HttpRule instance using the specified properties.
| Type | Name | Description |
|---|---|---|
| IHttpRule | properties |
Properties to set |
| Type | Description |
|---|---|
| google.api.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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| Type | Description |
|---|---|
| google.api.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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.api.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.
| Type | Name | Description |
|---|---|---|
| IHttpRule | message |
HttpRule message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| IHttpRule | message |
HttpRule message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.api.HttpRule | HttpRule |
toJSON()
public toJSON(): { [k: string]: any };Converts this HttpRule to JSON.
| 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.
| Type | Name | Description |
|---|---|---|
| google.api.HttpRule | message |
HttpRule |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a HttpRule message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|