Class: S3Spec
Represents a S3Spec.
Implements
Constructors
constructor
• new S3Spec(properties?): S3Spec
Constructs a new S3Spec.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IS3Spec | Properties to set |
Returns
Properties
awsAccountId
• awsAccountId: string
The AWS account ID associated with the S3 bucket and the assumed role.
Implementation of
bucketName
• bucketName: string
The name of the destination S3 bucket where Temporal will send data.
Implementation of
kmsArn
• kmsArn: string
The AWS Key Management Service (KMS) ARN used for encryption.
Implementation of
region
• region: string
The region where the S3 bucket is located.
Implementation of
roleName
• roleName: string
The IAM role that Temporal Cloud assumes for writing records to the customer's S3 bucket.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this S3Spec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): S3Spec
Creates a new S3Spec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IS3Spec | Properties to set |
Returns
S3Spec instance
decode
▸ decode(reader, length?): S3Spec
Decodes a S3Spec 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
S3Spec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): S3Spec
Decodes a S3Spec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
S3Spec
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 S3Spec message. Does not implicitly temporal.api.cloud.sink.v1.S3Spec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IS3Spec | S3Spec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified S3Spec message, length delimited. Does not implicitly temporal.api.cloud.sink.v1.S3Spec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IS3Spec | S3Spec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): S3Spec
Creates a S3Spec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
S3Spec
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for S3Spec
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 a S3Spec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | S3Spec | S3Spec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object