Constructor
new CloudEvent(propertiesopt)
Constructs a new CloudEvent.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.eventarc.publishing.v1.ICloudEvent |
<optional> |
Properties to set |
- Implements:
-
- ICloudEvent
Classes
Members
attributes
CloudEvent attributes.
binaryData
CloudEvent binaryData.
data
CloudEvent data.
id
CloudEvent id.
protoData
CloudEvent protoData.
source
CloudEvent source.
specVersion
CloudEvent specVersion.
textData
CloudEvent textData.
type
CloudEvent type.
Methods
toJSON() → {Object.<string, *>}
Converts this CloudEvent to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.eventarc.publishing.v1.CloudEvent}
Creates a new CloudEvent instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.eventarc.publishing.v1.ICloudEvent |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.eventarc.publishing.v1.CloudEvent |
CloudEvent instance |
(static) decode(reader, lengthopt) → {google.cloud.eventarc.publishing.v1.CloudEvent}
Decodes a CloudEvent 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 |
Returns:
| Type | Description |
|---|---|
| google.cloud.eventarc.publishing.v1.CloudEvent |
CloudEvent |
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.eventarc.publishing.v1.CloudEvent}
Decodes a CloudEvent message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.eventarc.publishing.v1.CloudEvent |
CloudEvent |
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 CloudEvent message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.eventarc.publishing.v1.ICloudEvent |
CloudEvent message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified CloudEvent message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.eventarc.publishing.v1.ICloudEvent |
CloudEvent message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.eventarc.publishing.v1.CloudEvent}
Creates a CloudEvent message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.eventarc.publishing.v1.CloudEvent |
CloudEvent |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for CloudEvent
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a CloudEvent message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.eventarc.publishing.v1.CloudEvent |
CloudEvent |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a CloudEvent message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|