Represents an Example.
Package
@google-cloud/cesConstructors
(constructor)(properties)
constructor
(
properties
?:
google
.
cloud
.
ces
.
v1beta
.
IExample
);
Constructs a new Example.
Properties
createTime
public
createTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Example createTime.
description
public
description
:
string
;
Example description.
displayName
public
displayName
:
string
;
Example displayName.
entryAgent
public
entryAgent
:
string
;
Example entryAgent.
etag
public
etag
:
string
;
Example etag.
invalid
public
invalid
:
boolean
;
Example invalid.
messages
public
messages
:
google
.
cloud
.
ces
.
v1beta
.
IMessage
[];
Example messages.
name
public
name
:
string
;
Example name.
updateTime
public
updateTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Example updateTime.
Methods
create(properties)
public
static
create
(
properties
?:
google
.
cloud
.
ces
.
v1beta
.
IExample
)
:
google
.
cloud
.
ces
.
v1beta
.
Example
;
Creates a new Example instance using the specified properties.
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
cloud
.
ces
.
v1beta
.
Example
;
Decodes an Example 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
.
cloud
.
ces
.
v1beta
.
Example
;
Decodes an Example 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
.
cloud
.
ces
.
v1beta
.
IExample
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Example message. Does not implicitly messages.
message
writer
$protobuf.Writer
Writer to encode to
$protobuf.Writer
Writer
encodeDelimited(message, writer)
public
static
encodeDelimited
(
message
:
google
.
cloud
.
ces
.
v1beta
.
IExample
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Example 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
.
cloud
.
ces
.
v1beta
.
Example
;
Creates an Example 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 Example
typeUrlPrefix
string
your custom typeUrlPrefix(default "type.googleapis.com")
string
The default type url
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this Example to JSON.
{ [k: string]: any }
JSON object
toObject(message, options)
public
static
toObject
(
message
:
google
.
cloud
.
ces
.
v1beta
.
Example
,
options
?:
$protobuf
.
IConversionOptions
)
:
{
[
k
:
string
]
:
any
};
Creates a plain object from an Example 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 an Example message.
message
{ [k: string]: any }
Plain object to verify
(string|null)
null
if valid, otherwise the reason why it is not
