Class: ExportSinkSpec
Represents an ExportSinkSpec.
Properties
enabled
• enabled: boolean
A flag indicating whether the export sink is enabled or not.
gcs
• Optional gcs: null | $Properties
This is a feature under development. We will allow GCS sink support for GCP Namespaces. The GCS configuration details when destination_type is GCS.
name
• name: string
The unique name of the export sink, it can't be changed once set.
s3
• Optional s3: null | $Properties
The S3 configuration details when destination_type is S3.
Methods
toJSON
▸ toJSON(): Object
Converts this ExportSinkSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ExportSinkSpec & $Properties
Creates a new ExportSinkSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ExportSinkSpec instance
▸ create(properties?): ExportSinkSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ExportSinkSpec & $Properties
Decodes an ExportSinkSpec 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
ExportSinkSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ExportSinkSpec & $Properties
Decodes an ExportSinkSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ExportSinkSpec
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 ExportSinkSpec message. Does not implicitly temporal.api.cloud.namespace.v1.ExportSinkSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ExportSinkSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ExportSinkSpec message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.ExportSinkSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ExportSinkSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ExportSinkSpec
Creates an ExportSinkSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ExportSinkSpec
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ExportSinkSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ExportSinkSpec | ExportSinkSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object