Represents a CloudEventAttributeValue.
Package
@google-cloud/eventarc-publishingConstructors
(constructor)(properties)
constructor(properties?: google.cloud.eventarc.publishing.v1.CloudEvent.ICloudEventAttributeValue);Constructs a new CloudEventAttributeValue.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICloudEventAttributeValue
Properties to set |
Properties
attr
public attr?: ("ceBoolean"|"ceInteger"|"ceString"|"ceBytes"|"ceUri"|"ceUriRef"|"ceTimestamp");CloudEventAttributeValue attr.
ceBoolean
public ceBoolean?: (boolean|null);CloudEventAttributeValue ceBoolean.
ceBytes
public ceBytes?: (Uint8Array|Buffer|string|null);CloudEventAttributeValue ceBytes.
ceInteger
public ceInteger?: (number|null);CloudEventAttributeValue ceInteger.
ceString
public ceString?: (string|null);CloudEventAttributeValue ceString.
ceTimestamp
public ceTimestamp?: (google.protobuf.ITimestamp|null);CloudEventAttributeValue ceTimestamp.
ceUri
public ceUri?: (string|null);CloudEventAttributeValue ceUri.
ceUriRef
public ceUriRef?: (string|null);CloudEventAttributeValue ceUriRef.
Methods
create(properties)
public static create(properties?: google.cloud.eventarc.publishing.v1.CloudEvent.ICloudEventAttributeValue): google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue;Creates a new CloudEventAttributeValue instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICloudEventAttributeValue
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CloudEventAttributeValue |
CloudEventAttributeValue instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue;Decodes a CloudEventAttributeValue message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
CloudEventAttributeValue |
CloudEventAttributeValue |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue;Decodes a CloudEventAttributeValue message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CloudEventAttributeValue |
CloudEventAttributeValue |
encode(message, writer)
public static encode(message: google.cloud.eventarc.publishing.v1.CloudEvent.ICloudEventAttributeValue, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CloudEventAttributeValue message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICloudEventAttributeValue
CloudEventAttributeValue message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.eventarc.publishing.v1.CloudEvent.ICloudEventAttributeValue, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CloudEventAttributeValue message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICloudEventAttributeValue
CloudEventAttributeValue message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue;Creates a CloudEventAttributeValue message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
CloudEventAttributeValue |
CloudEventAttributeValue |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CloudEventAttributeValue
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this CloudEventAttributeValue to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CloudEventAttributeValue message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CloudEventAttributeValue
CloudEventAttributeValue |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a CloudEventAttributeValue message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|