Represents a BoolValue.
Package
@google-cloud/kms!Constructors
(constructor)(properties)
constructor
(
properties
?:
google
.
protobuf
.
IBoolValue
);
Constructs a new BoolValue.
Type | Name | Description |
---|---|---|
IBoolValue
|
properties | Properties to set |
Properties
value
public
value
:
boolean
;
BoolValue value.
Type | Description |
---|---|
boolean |
Methods
create(properties)
public
static
create
(
properties
?:
google
.
protobuf
.
IBoolValue
)
:
google
.
protobuf
.
BoolValue
;
Creates a new BoolValue instance using the specified properties.
Type | Name | Description |
---|---|---|
IBoolValue
|
properties | Properties to set |
Type | Description |
---|---|
google.protobuf.BoolValue | BoolValue instance |
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
protobuf
.
BoolValue
;
Decodes a BoolValue 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.protobuf.BoolValue | BoolValue |
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
protobuf
.
BoolValue
;
Decodes a BoolValue 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.protobuf.BoolValue | BoolValue |
encode(message, writer)
public
static
encode
(
message
:
google
.
protobuf
.
IBoolValue
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified BoolValue message. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IBoolValue
|
message | BoolValue 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
.
protobuf
.
IBoolValue
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified BoolValue message, length delimited. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IBoolValue
|
message | BoolValue 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
.
protobuf
.
BoolValue
;
Creates a BoolValue 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.protobuf.BoolValue | BoolValue |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this BoolValue to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public
static
toObject
(
message
:
google
.
protobuf
.
BoolValue
,
options
?:
$protobuf
.
IConversionOptions
)
:
{
[
k
:
string
]
:
any
};
Creates a plain object from a BoolValue message. Also converts values to other types if specified.
Type | Name | Description |
---|---|---|
google.protobuf.BoolValue
|
message | BoolValue |
$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 BoolValue message.
Type | Name | Description |
---|---|---|
{ [k: string]: any }
|
message | Plain object to verify |
Type | Description |
---|---|
(string|null) | |