Class: ExportSink
Represents an ExportSink.
Implements
Constructors
constructor
• new ExportSink(properties?): ExportSink
Constructs a new ExportSink.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IExportSink | Properties to set |
Returns
Properties
errorMessage
• errorMessage: string
An error message describing any issues with the export sink, if applicable.
Implementation of
health
• health: Health
The health status of the export sink.
Implementation of
lastHealthCheckTime
• Optional lastHealthCheckTime: null | ITimestamp
The timestamp of the last health check performed on the export sink.
Implementation of
IExportSink.lastHealthCheckTime
latestDataExportTime
• Optional latestDataExportTime: null | ITimestamp
The timestamp of the latest successful data export.
Implementation of
IExportSink.latestDataExportTime
name
• name: string
The unique name of the export sink, once set it can't be changed
Implementation of
resourceVersion
• resourceVersion: string
The version of the export sink resource.
Implementation of
spec
• Optional spec: null | IExportSinkSpec
The specification details of the export sink.
Implementation of
state
• state: ResourceState
The current state of the export sink.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this ExportSink to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ExportSink
Creates a new ExportSink instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IExportSink | Properties to set |
Returns
ExportSink instance
decode
▸ decode(reader, length?): ExportSink
Decodes an ExportSink message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
ExportSink
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ExportSink
Decodes an ExportSink message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ExportSink
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified ExportSink message. Does not implicitly temporal.api.cloud.namespace.v1.ExportSink.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IExportSink | ExportSink message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ExportSink message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.ExportSink.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IExportSink | ExportSink message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ExportSink
Creates an ExportSink message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ExportSink
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ExportSink
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ExportSink message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ExportSink | ExportSink |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object