Skip to main content

Class: GCSSpec

Represents a GCSSpec.

Properties​

bucketName​

bucketName: string

The name of the destination GCS bucket where Temporal will send data.

gcpProjectId​

gcpProjectId: string

The GCP project ID associated with the GCS bucket and service account.

region​

region: string

The region of the gcs bucket

saId​

saId: string

The customer service account ID that Temporal Cloud impersonates for writing records to the customer's GCS bucket.

Methods​

toJSON()​

toJSON(): object

Converts this GCSSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): GCSSpec & $Properties

Creates a new GCSSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GCSSpec & $Properties

GCSSpec instance

Call Signature​

static create(properties?): GCSSpec

Creates a new GCSSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GCSSpec

GCSSpec instance

decode()​

static decode(reader, length?): GCSSpec & $Properties

Decodes a GCSSpec message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

GCSSpec & $Properties

GCSSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GCSSpec & $Properties

Decodes a GCSSpec message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GCSSpec & $Properties

GCSSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified GCSSpec message. Does not implicitly temporal.api.cloud.sink.v1.GCSSpec.verify|verify messages.

Parameters​

message​

$Properties

GCSSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified GCSSpec message, length delimited. Does not implicitly temporal.api.cloud.sink.v1.GCSSpec.verify|verify messages.

Parameters​

message​

$Properties

GCSSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GCSSpec

Creates a GCSSpec message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

GCSSpec

GCSSpec

toObject()​

static toObject(message, options?): object

Creates a plain object from a GCSSpec message. Also converts values to other types if specified.

Parameters​

message​

GCSSpec

GCSSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object