TransferJob

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

This resource represents the configuration of a transfer job that runs periodically.

interface TransferJob {

readonly creationTime?: Date;

readonly deletionTime?: Date;

description?: string;

eventStream?: EventStream;

readonly lastModificationTime?: Date;

latestOperationName?: string;

loggingConfig?: LoggingConfig;

name?: string;

notificationConfig?: NotificationConfig;

projectId?: string;

replicationSpec?: ReplicationSpec;

schedule?: Schedule;

status?:

| "STATUS_UNSPECIFIED"

| "ENABLED"

| "DISABLED"

| "DELETED";

transferSpec?: TransferSpec;

}

§Properties

readonly creationTime?: Date

[src]

Output only. The time that the transfer job was created.

readonly deletionTime?: Date

[src]

Output only. The time that the transfer job was deleted.

description?: string

[src]

A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.

eventStream?: EventStream

[src]

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

readonly lastModificationTime?: Date

[src]

Output only. The time that the transfer job was last modified.

latestOperationName?: string

[src]

The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.

loggingConfig?: LoggingConfig

[src]

Logging configuration.

name?: string

[src]

A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with "transferJobs/" prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involving PosixFilesystem, this name must start with transferJobs/OPI specifically. For all other transfer types, this name must not start with transferJobs/OPI. Non-PosixFilesystem example: "transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$" PosixFilesystem example: "transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$" Applications must not rely on the enforcement of naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error.

notificationConfig?: NotificationConfig

[src]

Notification configuration.

projectId?: string

[src]

The ID of the Google Cloud project that owns the job.

replicationSpec?: ReplicationSpec

[src]

Replication specification.

schedule?: Schedule

[src]

Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.

status?: "STATUS_UNSPECIFIED" | "ENABLED" | "DISABLED" | "DELETED"

[src]

Status of the job. This value MUST be specified for CreateTransferJobRequests. Note: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.

transferSpec?: TransferSpec

[src]

Transfer specification.