CloudStorageConfig

import type { CloudStorageConfig } from "https://googleapis.deno.dev/v1/pubsub:v1.ts";

Configuration for a Cloud Storage subscription.

interface CloudStorageConfig {

avroConfig?: AvroConfig;

bucket?: string;

filenameDatetimeFormat?: string;

filenamePrefix?: string;

filenameSuffix?: string;

maxBytes?: bigint;

maxDuration?: number;

serviceAccountEmail?: string;

readonly state?:

| "STATE_UNSPECIFIED"

| "ACTIVE"

| "PERMISSION_DENIED"

| "NOT_FOUND"

| "IN_TRANSIT_LOCATION_RESTRICTION";

textConfig?: TextConfig;

}

§Properties

avroConfig?: AvroConfig

[src]

Optional. If set, message data will be written to Cloud Storage in Avro format.

bucket?: string

[src]

Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).

filenameDatetimeFormat?: string

[src]

Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.

filenamePrefix?: string

[src]

Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.

filenameSuffix?: string

[src]

Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".

maxBytes?: bigint

[src]

Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.

maxDuration?: number

[src]

Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.

serviceAccountEmail?: string

[src]

Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "PERMISSION_DENIED" | "NOT_FOUND" | "IN_TRANSIT_LOCATION_RESTRICTION"

[src]

Output only. An output-only field that indicates whether or not the subscription can receive messages.

textConfig?: TextConfig

[src]

Optional. If set, message data will be written to Cloud Storage in text format.