Represents a HttpRule.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor
(
properties
?:
google
.
api
.
IHttpRule
);
Constructs a new HttpRule.
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.
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.
reader
( Reader
| Uint8Array
)
Reader or buffer to decode from
length
number
Message length if known beforehand
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
api
.
HttpRule
;
Decodes a HttpRule message from the specified reader or buffer, length delimited.
reader
( Reader
| Uint8Array
)
Reader or buffer to decode from
encode(message, writer)
public
static
encode
(
message
:
google
.
api
.
IHttpRule
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified HttpRule message. Does not implicitly messages.
message
writer
$protobuf.Writer
Writer to encode to
$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.
message
writer
$protobuf.Writer
Writer to encode to
$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.
object
{ [k: string]: any }
Plain object
getTypeUrl(typeUrlPrefix)
public
static
getTypeUrl
(
typeUrlPrefix
?:
string
)
:
string
;
Gets the default type url for HttpRule
typeUrlPrefix
string
your custom typeUrlPrefix(default "type.googleapis.com")
string
The default type url
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this HttpRule to JSON.
{ [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.
message
options
$protobuf.IConversionOptions
Conversion options
{ [k: string]: any }
Plain object
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a HttpRule message.
message
{ [k: string]: any }
Plain object to verify
(string|null)
null
if valid, otherwise the reason why it is not
