gcs_storage_transfer_onetime_job_between_buckets_quickstart.py

1import datetime
2
3from google.cloud import storage_transfer
4
5
6def create_transfer_job(
7    project_id: str,
8    description: str,
9    source_bucket: str,
10    sink_bucket: str,
11    schedule_start_date: datetime.date,
12):
13    """Creates a one-time transfer job."""
14
15    client = storage_transfer.StorageTransferServiceClient()
16
17    # The transfer job configuration
18    transfer_job_request = storage_transfer.CreateTransferJobRequest(
19        transfer_job=storage_transfer.TransferJob(
20            project_id=project_id,
21            description=description,
22            status=storage_transfer.TransferJob.Status.ENABLED,
23            transfer_spec=storage_transfer.TransferSpec(
24                gcs_data_source=storage_transfer.GcsData(bucket_name=source_bucket),
25                gcs_data_sink=storage_transfer.GcsData(bucket_name=sink_bucket),
26            ),
27            schedule=storage_transfer.Schedule(
28                schedule_start_date=storage_transfer.Date(
29                    year=schedule_start_date.year,
30                    month=schedule_start_date.month,
31                    day=schedule_start_date.day,
32                ),
33                # If schedule_end_date is not set, the job will run indefinitely
34                # at the set interval. For a one-time transfer, we set the same
35                # start and end date.
36                schedule_end_date=storage_transfer.Date(
37                    year=schedule_start_date.year,
38                    month=schedule_start_date.month,
39                    day=schedule_start_date.day,
40                ),
41            ),
42        )
43    )
44
45    result = client.create_transfer_job(request=transfer_job_request)
46
47    print(f"Created transfer_job: {result.name}")
48
49
50if __name__ == "__main__":
51    # TODO: Replace with your project ID
52    # project_id = "my-project-id"
53
54    # TODO: Replace with the description of the transfer
55    # description = "My transfer job"
56
57    # TODO: Replace with your source GCS bucket name
58    # source_bucket = "my-source-bucket"
59
60    # TODO: Replace with your destination GCS bucket name
61    # sink_bucket = "my-sink-bucket"
62
63    create_transfer_job(
64        project_id="your-project-id",
65        description="One-time transfer job",
66        source_bucket="your-source-bucket",
67        sink_bucket="your-destination-bucket",
68        schedule_start_date=datetime.date.today(),
69    )