Collection: transferJobs

Resource: TransferJob

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

JSON representation
{
  "name": string,
  "description": string,
  "projectId": string,
  "transferSpec": {
    object(TransferSpec)
  },
  "schedule": {
    object(Schedule)
  },
  "status": enum(Status),
  "creationTime": string,
  "lastModificationTime": string,
  "deletionTime": string,
}
Field name Type Description
name string A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an INVALID_ARGUMENT error.
description string A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
projectId string The ID of the Google Cloud Platform Console project that owns the job. Required.
transferSpec object(TransferSpec) Transfer specification. Required.
schedule object(Schedule) Schedule specification. Required.
status enum(Status)

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.

creationTime string
(Timestamp format)

This field cannot be changed by user requests.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

lastModificationTime string
(Timestamp format)

This field cannot be changed by user requests.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

deletionTime string
(Timestamp format)

This field cannot be changed by user requests.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Schedule

Transfers can be scheduled to recur or to run just once.

JSON representation
{
  "scheduleStartDate": {
    object(Date)
  },
  "scheduleEndDate": {
    object(Date)
  },
  "startTimeOfDay": {
    object(TimeOfDay)
  },
}
Field name Type Description
scheduleStartDate object(Date) The first day the recurring transfer is scheduled to run. If scheduleStartDate is in the past, the transfer will run for the first time on the following day. Required.
scheduleEndDate object(Date) The last day the recurring transfer will be run. If scheduleEndDate is the same as scheduleStartDate, the transfer will be executed only once.
startTimeOfDay object(TimeOfDay) The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer's start time in a day is specified in your local timezone.

Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

JSON representation
{
  "year": number,
  "month": number,
  "day": number,
}
Field name Type Description
year number Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
month number Month of year. Must be from 1 to 12.
day number Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.

TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

JSON representation
{
  "hours": number,
  "minutes": number,
  "seconds": number,
  "nanos": number,
}
Field name Type Description
hours number Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes number Minutes of hour of day. Must be from 0 to 59.
seconds number Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
nanos number Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Status

The status of the transfer job.

Enum value Description
STATUS_UNSPECIFIED Zero is an illegal value.
ENABLED New transfers will be performed based on the schedule.
DISABLED New transfers will not be scheduled.
DELETED This is a soft delete state. After a transfer job is set to this state, the job and all the transfer executions are subject to garbage collection.

Methods

Method Description
create Creates a transfer job that runs periodically.
get Gets a transfer job.
list Lists transfer jobs.
patch Updates a transfer job.

Send feedback about...

Cloud Storage Documentation