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