Constructor
new Synopsis(propertiesopt)
Constructs a new Synopsis.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.irm.v1alpha2.ISynopsis |
<optional> |
Properties to set |
- Implements:
-
- ISynopsis
Members
author :google.cloud.irm.v1alpha2.IUser|null|undefined
Synopsis author.
content :string
Synopsis content.
contentType :string
Synopsis contentType.
updateTime :google.protobuf.ITimestamp|null|undefined
Synopsis updateTime.
Methods
(static) create(propertiesopt) → {google.cloud.irm.v1alpha2.Synopsis}
Creates a new Synopsis instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.irm.v1alpha2.ISynopsis |
<optional> |
Properties to set |
(static) decode(reader, lengthopt) → {google.cloud.irm.v1alpha2.Synopsis}
Decodes a Synopsis message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.irm.v1alpha2.Synopsis}
Decodes a Synopsis message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Synopsis message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.irm.v1alpha2.ISynopsis |
Synopsis message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Synopsis message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.irm.v1alpha2.ISynopsis |
Synopsis message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
(static) fromObject(object) → {google.cloud.irm.v1alpha2.Synopsis}
Creates a Synopsis message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Synopsis message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.irm.v1alpha2.Synopsis |
Synopsis |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
(static) verify(message) → {string|null}
Verifies a Synopsis message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
toJSON() → {Object.<string, *>}
Converts this Synopsis to JSON.