Package google.storagetransfer.v1

Indeks

StorageTransferService

Storage Transfer Service dan proto-nya. Mentransfer data antar-bucket Google Cloud Storage atau dari sumber data eksternal ke Google ke bucket Cloud Storage.

CreateAgentPool

rpc CreateAgentPool(CreateAgentPoolRequest) returns (AgentPool)

Membuat resource kumpulan agen.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
CreateTransferJob

rpc CreateTransferJob(CreateTransferJobRequest) returns (TransferJob)

Membuat tugas transfer yang berjalan secara berkala.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
DeleteAgentPool

rpc DeleteAgentPool(DeleteAgentPoolRequest) returns (Empty)

Menghapus kumpulan agen.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
DeleteTransferJob

rpc DeleteTransferJob(DeleteTransferJobRequest) returns (Empty)

Menghapus tugas transfer. Menghapus tugas transfer akan menetapkan statusnya ke DELETED.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
GetAgentPool

rpc GetAgentPool(GetAgentPoolRequest) returns (AgentPool)

Mendapatkan kumpulan agen.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
GetGoogleServiceAccount

rpc GetGoogleServiceAccount(GetGoogleServiceAccountRequest) returns (GoogleServiceAccount)

Menampilkan akun layanan Google yang digunakan oleh Storage Transfer Service untuk mengakses bucket di project tempat transfer berjalan atau di project lain. Setiap akun layanan Google dikaitkan dengan satu project Google Cloud. Pengguna harus menambahkan akun layanan ini ke ACL bucket Google Cloud Storage untuk memberikan akses ke Storage Transfer Service. Akun layanan ini dibuat dan dimiliki oleh Storage Transfer Service dan hanya dapat digunakan oleh Storage Transfer Service.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
GetTransferJob

rpc GetTransferJob(GetTransferJobRequest) returns (TransferJob)

Mendapatkan tugas transfer.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ListAgentPools

rpc ListAgentPools(ListAgentPoolsRequest) returns (ListAgentPoolsResponse)

Mencantumkan kumpulan agen.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ListTransferJobs

rpc ListTransferJobs(ListTransferJobsRequest) returns (ListTransferJobsResponse)

Mencantumkan tugas transfer.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
PauseTransferOperation

rpc PauseTransferOperation(PauseTransferOperationRequest) returns (Empty)

Menjeda operasi transfer.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ResumeTransferOperation

rpc ResumeTransferOperation(ResumeTransferOperationRequest) returns (Empty)

Melanjutkan operasi transfer yang dijeda.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
RunTransferJob

rpc RunTransferJob(RunTransferJobRequest) returns (Operation)

Memulai operasi baru untuk tugas transfer yang ditentukan. TransferJob memiliki maksimum satu TransferOperation aktif. Jika metode ini dipanggil saat TransferOperation aktif, error akan ditampilkan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
UpdateAgentPool

rpc UpdateAgentPool(UpdateAgentPoolRequest) returns (AgentPool)

Memperbarui resource kumpulan agen yang ada.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
UpdateTransferJob

rpc UpdateTransferJob(UpdateTransferJobRequest) returns (TransferJob)

Memperbarui tugas transfer. Memperbarui spesifikasi transfer tugas tidak memengaruhi operasi transfer yang sudah berjalan.

Catatan: Kolom status tugas dapat diubah menggunakan RPC ini (misalnya, untuk menetapkan status tugas ke DELETED, DISABLED, atau ENABLED).

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

AgentPool

Mewakili kumpulan agen.

Kolom
name

string

Wajib. Menentukan string unik yang mengidentifikasi kumpulan agen.

Format: projects/{project_id}/agentPools/{agent_pool_id}
display_name

string

Menentukan deskripsi AgentPool yang ditentukan klien.
state

State

Hanya output. Menentukan status AgentPool.
bandwidth_limit

BandwidthLimit

Menentukan detail batas bandwidth. Jika kolom ini tidak ditentukan, nilai defaultnya ditetapkan sebagai 'Tanpa Batas'.

BandwidthLimit

Menentukan batas bandwidth untuk kumpulan agen.

Kolom
limit_mbps

int64

Kecepatan bandwidth dalam megabyte per detik, yang didistribusikan ke semua agen dalam kumpulan.

Negara bagian/Provinsi

Status AgentPool.

Enum
STATE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
CREATING Ini adalah status inisialisasi. Selama tahap ini, resource dialokasikan untuk AgentPool.
CREATED Menentukan bahwa AgentPool dibuat untuk digunakan. Pada status ini, Agen dapat bergabung dengan AgentPool dan berpartisipasi dalam tugas transfer di kumpulan tersebut.
DELETING Menentukan bahwa penghapusan AgentPool telah dimulai, dan semua resource dijadwalkan untuk dibersihkan dan dibebaskan.

AwsAccessKey

Kunci akses AWS (lihat Kredensial Keamanan AWS).

Untuk informasi tentang kebijakan retensi data kami untuk kredensial pengguna, lihat Kredensial pengguna.

Kolom
access_key_id

string

Wajib. ID kunci akses AWS.
secret_access_key

string

Wajib. Kunci akses rahasia AWS. Kolom ini tidak ditampilkan dalam respons RPC.

AwsS3CompatibleData

Resource AwsS3CompatibleData.

Kolom
bucket_name

string

Wajib. Menentukan nama bucket.
path

string

Menentukan jalur root untuk mentransfer objek.

Harus berupa string kosong atau nama jalur lengkap yang diakhiri dengan '/'. Kolom ini diperlakukan sebagai awalan objek. Dengan demikian, umumnya tidak boleh diawali dengan '/'.
endpoint

string

Wajib. Menentukan endpoint layanan penyimpanan.
region

string

Menentukan region untuk menandatangani permintaan. Kolom ini dapat dibiarkan kosong jika permintaan harus ditandatangani dengan region kosong.
Kolom union data_provider. Menentukan metadata penyedia data yang kompatibel dengan S3. Setiap penyedia mungkin berisi beberapa atribut yang tidak berlaku untuk semua penyedia data yang kompatibel dengan S3. Jika tidak ditentukan, S3CompatibleMetadata akan digunakan secara default. data_provider hanya ada berupa salah satu diantara berikut:
s3_metadata

S3CompatibleMetadata

Metadata yang kompatibel dengan S3.

AwsS3Data

Resource AwsS3Data dapat berupa sumber data, tetapi bukan sink data. Dalam resource AwsS3Data, nama objek adalah nama kunci objek S3.

Kolom
bucket_name

string

Wajib. Nama Bucket S3 (lihat Membuat bucket).
aws_access_key

AwsAccessKey

Hanya input. Kunci akses AWS yang digunakan untuk menandatangani permintaan API ke bucket AWS S3. Izin di bucket harus diberikan ke ID akses kunci akses AWS.

Untuk informasi tentang kebijakan retensi data kami untuk kredensial pengguna, lihat Kredensial pengguna.
path

string

Jalur root untuk mentransfer objek.

Harus berupa string kosong atau nama jalur lengkap yang diakhiri dengan '/'. Kolom ini diperlakukan sebagai awalan objek. Dengan demikian, umumnya tidak boleh diawali dengan '/'.
role_arn

string

Amazon Resource Name (ARN) peran untuk mendukung kredensial sementara melalui AssumeRoleWithWebIdentity. Untuk mengetahui informasi selengkapnya tentang ARN, lihat ARN IAM.

Jika ARN peran diberikan, Layanan Transfer akan mengambil kredensial sementara untuk sesi menggunakan panggilan AssumeRoleWithWebIdentity untuk peran yang diberikan menggunakan GoogleServiceAccount untuk project ini.
cloudfront_domain

string

Opsional. Nama domain distribusi CloudFront yang mengarah ke bucket ini, untuk digunakan saat mengambil.

Lihat Mentransfer dari S3 melalui CloudFront untuk mengetahui informasi selengkapnya.

Format: https://{id}.cloudfront.net atau domain kustom yang valid. Harus diawali dengan https://.
credentials_secret

string

Opsional. Nama Resource secret di Secret Manager.

Kredensial AWS harus disimpan di Secret Manager dalam format JSON:

{ "access_key_id": "ACCESS_KEY_ID", "secret_access_key": "SECRET_ACCESS_KEY" }

GoogleServiceAccount harus diberi roles/secretmanager.secretAccessor untuk resource.

Lihat Mengonfigurasi akses ke sumber: Amazon S3 untuk informasi selengkapnya.

Jika credentials_secret ditentukan, jangan tentukan role_arn atau aws_access_key.

Format: projects/{project_number}/secrets/{secret_name}

Kolom union private_network.

private_network hanya dapat berupa salah satu dari hal berikut:
managed_private_network

bool

Byte keluar melalui jaringan pribadi yang dikelola Google. Jaringan ini dibagikan kepada pengguna Storage Transfer Service lainnya.

AzureBlobStorageData

Resource AzureBlobStorageData dapat berupa sumber data, tetapi bukan sink data. Resource AzureBlobStorageData mewakili satu penampung Azure. Akun penyimpanan menentukan endpoint Azure. Di resource AzureBlobStorageData, nama blob adalah nama kunci blob Azure Blob Storage.

Kolom
storage_account

string

Wajib. Nama akun Azure Storage.
azure_credentials

AzureCredentials

Wajib. Hanya input. Kredensial yang digunakan untuk mengautentikasi permintaan API ke Azure.

Untuk informasi tentang kebijakan retensi data kami untuk kredensial pengguna, lihat Kredensial pengguna.
container

string

Wajib. Penampung yang akan ditransfer dari akun Azure Storage.
path

string

Jalur root untuk mentransfer objek.

Harus berupa string kosong atau nama jalur lengkap yang diakhiri dengan '/'. Kolom ini diperlakukan sebagai awalan objek. Dengan demikian, umumnya tidak boleh diawali dengan '/'.
credentials_secret

string

Opsional. Nama Resource secret di Secret Manager.

Token Azure SAS harus disimpan di Secret Manager dalam format JSON:

{ "sas_token" : "SAS_TOKEN" }

GoogleServiceAccount harus diberi roles/secretmanager.secretAccessor untuk resource.

Lihat Mengonfigurasi akses ke sumber: Microsoft Azure Blob Storage untuk mengetahui informasi selengkapnya.

Jika credentials_secret ditentukan, jangan tentukan azure_credentials.

Format: projects/{project_number}/secrets/{secret_name}

AzureCredentials

Kredensial Azure

Untuk informasi tentang kebijakan retensi data kami untuk kredensial pengguna, lihat Kredensial pengguna.

Kolom
sas_token

string

Wajib. Tanda tangan akses bersama (SAS) Azure.

Untuk informasi selengkapnya tentang SAS, lihat Memberikan akses terbatas ke resource Azure Storage menggunakan tanda tangan akses bersama (SAS).

CreateAgentPoolRequest

Menentukan permintaan yang diteruskan ke CreateAgentPool.

Kolom
project_id

string

Wajib. ID project Google Cloud yang memiliki kumpulan agen.

Otorisasi memerlukan izin IAM berikut pada resource projectId yang ditentukan:

  • storagetransfer.agentpools.create
agent_pool

AgentPool

Wajib. Kumpulan agen yang akan dibuat.
agent_pool_id

string

Wajib. ID kumpulan agen yang akan dibuat.

agent_pool_id harus memenuhi persyaratan berikut:

  • Panjang 128 karakter atau kurang.
  • Tidak diawali dengan string goog.
  • Dimulai dengan karakter ASCII kecil, diikuti dengan:
    • Nol atau lebih: karakter alfabet Latin kecil, angka, tanda hubung (-), titik (.), garis bawah (_), atau tilde (~).
    • Satu atau beberapa angka atau karakter ASCII huruf kecil.

Seperti yang dinyatakan oleh ekspresi reguler: ^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$.

CreateTransferJobRequest

Permintaan diteruskan ke CreateTransferJob.

Kolom
transfer_job

TransferJob

Wajib. Tugas yang akan dibuat.

Otorisasi memerlukan izin IAM berikut pada resource transferJob yang ditentukan:

  • storagetransfer.jobs.create

DeleteAgentPoolRequest

Menentukan permintaan yang diteruskan ke DeleteAgentPool.

Kolom
name

string

Wajib. Nama kumpulan agen yang akan dihapus.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • storagetransfer.agentpools.delete

DeleteTransferJobRequest

Permintaan diteruskan ke DeleteTransferJob.

Kolom
job_name

string

Wajib. Tugas yang akan dihapus.

Otorisasi memerlukan izin IAM berikut pada resource jobName yang ditentukan:

  • storagetransfer.jobs.delete
project_id

string

Wajib. ID project Google Cloud yang memiliki tugas.

ErrorLogEntry

Entri yang menjelaskan error yang telah terjadi.

Kolom
url

string

Wajib. URL yang merujuk ke target (sumber data, penampungan data, atau objek) yang terkait dengan error.
error_details[]

string

Daftar pesan yang membawa detail error.

ErrorSummary

Ringkasan error berdasarkan kode error, serta jumlah dan contoh entri log error.

Kolom
error_code

Code

Wajib.
error_count

int64

Wajib. Jumlah jenis error ini.
error_log_entries[]

ErrorLogEntry

Contoh error.

Maksimum 5 entri log error dicatat untuk kode error tertentu untuk satu operasi transfer.

EventStream

Menentukan opsi Transfer berbasis peristiwa. Transfer berbasis peristiwa memproses aliran peristiwa untuk mentransfer file yang diperbarui.

Kolom
name

string

Wajib. Menentukan nama unik resource seperti ARN AWS SQS dalam bentuk 'arn:aws:sqs:region:account_id:queue_name', atau nama resource langganan Pub/Sub dalam bentuk 'projects/{project}/subscriptions/{sub}'.
event_stream_start_time

Timestamp

Menentukan tanggal dan waktu Storage Transfer Service mulai memproses peristiwa dari aliran data ini. Jika tidak ada waktu mulai yang ditentukan atau waktu mulai sudah berlalu, Layanan Transfer Penyimpanan akan segera mulai memproses.
event_stream_expiration_time

Timestamp

Menentukan data dan waktu saat Storage Transfer Service berhenti memproses peristiwa dari aliran ini. Setelah waktu ini, setiap transfer yang sedang berlangsung akan selesai, tetapi tidak ada transfer baru yang dimulai.

GcsData

Dalam resource GcsData, nama objek adalah nama objek Cloud Storage dan "waktu modifikasi terakhir"-nya merujuk ke properti updated objek Cloud Storage, yang berubah saat konten atau metadata objek diperbarui.

Kolom
bucket_name

string

Wajib. Nama bucket Cloud Storage. Harus memenuhi Persyaratan Nama Bucket.
path

string

Jalur root untuk mentransfer objek.

Harus berupa string kosong atau nama jalur lengkap yang diakhiri dengan '/'. Kolom ini diperlakukan sebagai awalan objek. Dengan demikian, umumnya tidak boleh diawali dengan '/'.

Nilai jalur root harus memenuhi Persyaratan Nama Objek.
managed_folder_transfer_enabled

bool

Pratinjau. Mengaktifkan transfer folder terkelola antar-bucket Cloud Storage. Tetapkan opsi ini di gcs_data_source.

Jika ditetapkan ke benar:

  • Folder terkelola di bucket sumber ditransfer ke bucket tujuan.
  • Folder terkelola di bucket tujuan akan ditimpa. Opsi OVERWRITE lainnya tidak didukung.

Lihat Mentransfer folder terkelola Cloud Storage.

GetAgentPoolRequest

Menentukan permintaan yang diteruskan ke GetAgentPool.

Kolom
name

string

Wajib. Nama kumpulan agen yang akan didapatkan.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • storagetransfer.agentpools.get

GetGoogleServiceAccountRequest

Permintaan diteruskan ke GetGoogleServiceAccount.

Kolom
project_id

string

Wajib. ID project Google Cloud yang terkait dengan akun layanan Google.

Otorisasi memerlukan izin IAM berikut pada resource projectId yang ditentukan:

  • storagetransfer.projects.getServiceAccount

GetTransferJobRequest

Permintaan diteruskan ke GetTransferJob.

Kolom
job_name

string

Wajib. Tugas yang akan dilakukan.

Otorisasi memerlukan izin IAM berikut pada resource jobName yang ditentukan:

  • storagetransfer.jobs.get
project_id

string

Wajib. ID project Google Cloud yang memiliki tugas.

GoogleServiceAccount

Akun layanan Google

Kolom
account_email

string

Alamat email akun layanan.
subject_id

string

ID unik untuk akun layanan.

HdfsData

Resource HdfsData menentukan jalur dalam entity HDFS (misalnya, cluster). Semua setelan khusus cluster, seperti namenode dan port, dikonfigurasi pada agen transfer yang melayani permintaan, sehingga HdfsData hanya berisi jalur root ke data dalam transfer kami.

Kolom
path

string

Jalur root untuk mentransfer file.

HttpData

Resource HttpData menentukan daftar objek di web yang akan ditransfer melalui HTTP. Informasi objek yang akan ditransfer terdapat dalam file yang dirujuk oleh URL. Baris pertama dalam file harus berupa "TsvHttpData-1.0", yang menentukan format file. Baris berikutnya menentukan informasi daftar objek, satu objek per entri daftar. Setiap entri memiliki kolom yang dipisahkan tab berikut:

  • URL HTTP — Lokasi objek.

  • Panjang — Ukuran objek dalam byte.

  • MD5 — Hash MD5 objek yang dienkode base64.

Untuk contoh file TSV yang valid, lihat Mentransfer data dari URL.

Saat mentransfer data berdasarkan daftar URL, perhatikan hal-hal berikut:

  • Saat objek yang berada di http(s)://hostname:port/<URL-path> ditransfer ke sink data, nama objek di sink data adalah <hostname>/<URL-path>.

  • Jika ukuran objek yang ditentukan tidak cocok dengan ukuran sebenarnya dari objek yang diambil, objek tidak akan ditransfer.

  • Jika MD5 yang ditentukan tidak cocok dengan MD5 yang dihitung dari byte yang ditransfer, transfer objek akan gagal.

  • Pastikan setiap URL yang Anda tentukan dapat diakses secara publik. Misalnya, di Cloud Storage, Anda dapat membagikan objek secara publik dan mendapatkan link ke objek tersebut.

  • Layanan Transfer Penyimpanan mematuhi aturan robots.txt dan mewajibkan server HTTP sumber untuk mendukung permintaan Range dan menampilkan header Content-Length dalam setiap respons.

  • ObjectConditions tidak berpengaruh saat memfilter objek yang akan ditransfer.

Kolom
list_url

string

Wajib. URL yang mengarah ke file yang menyimpan entri daftar objek. File ini harus mengizinkan akses publik. Saat ini, hanya URL dengan skema HTTP dan HTTPS yang didukung.

ListAgentPoolsRequest

Permintaan diteruskan ke ListAgentPools.

Kolom
project_id

string

Wajib. ID project Google Cloud yang memiliki tugas.

Otorisasi memerlukan izin IAM berikut pada resource projectId yang ditentukan:

  • storagetransfer.agentpools.list
filter

string

Daftar parameter kueri opsional yang ditentukan sebagai teks JSON dalam bentuk:

{"agentPoolNames":["agentpool1","agentpool2",...]}

Karena agentPoolNames mendukung beberapa nilai, nilainya harus ditentukan dengan notasi array. Jika filter kosong atau tidak diberikan, daftar akan menampilkan semua kumpulan agen untuk project.
page_size

int32

Ukuran halaman daftar. Nilai maksimum yang diizinkan adalah 256.
page_token

string

Token halaman daftar.

ListAgentPoolsResponse

Respons dari ListAgentPools.

Kolom
agent_pools[]

AgentPool

Daftar kumpulan agen.
next_page_token

string

Token halaman berikutnya daftar.

ListTransferJobsRequest

projectId, jobNames, dan jobStatuses adalah parameter kueri yang dapat ditentukan saat mencantumkan tugas transfer.

Kolom
filter

string

Wajib. Daftar parameter kueri yang ditentukan sebagai teks JSON dalam bentuk:

{
  "projectId":"my_project_id",
  "jobNames":["jobid1","jobid2",...],
  "jobStatuses":["status1","status2",...],
  "dataBackend":"QUERY_REPLICATION_CONFIGS",
  "sourceBucket":"source-bucket-name",
  "sinkBucket":"sink-bucket-name",
}

Format JSON dalam contoh hanya untuk ditampilkan; berikan parameter kueri tanpa spasi atau pemisah baris.

  • projectId wajib diisi.
  • Karena jobNames dan jobStatuses mendukung beberapa nilai, nilainya harus ditentukan dengan notasi array. jobNames dan jobStatuses bersifat opsional. Nilai yang valid tidak peka huruf besar/kecil:
  • Tentukan "dataBackend":"QUERY_REPLICATION_CONFIGS" untuk menampilkan daftar tugas replikasi lintas bucket.
  • Batasi hasil ke tugas dari bucket tertentu dengan sourceBucket dan/atau ke bucket tertentu dengan sinkBucket.

Otorisasi memerlukan izin IAM berikut pada resource filter yang ditentukan:

  • storagetransfer.jobs.list
page_size

int32

Ukuran halaman daftar. Nilai maksimum yang diizinkan adalah 256.
page_token

string

Token halaman daftar.

ListTransferJobsResponse

Respons dari ListTransferJobs.

Kolom
transfer_jobs[]

TransferJob

Daftar tugas transfer.
next_page_token

string

Token halaman berikutnya daftar.

LoggingConfig

Menentukan perilaku logging untuk operasi transfer.

Log dapat dikirim ke Cloud Logging untuk semua jenis transfer. Lihat Membaca log transfer untuk mengetahui detailnya.

Kolom
log_actions[]

LoggableAction

Menentukan tindakan yang akan dicatat dalam log. Jika kosong, tidak ada log yang dibuat.
log_action_states[]

LoggableActionState

Status saat log_actions dicatat dalam log. Jika kosong, tidak ada log yang dibuat.
enable_onprem_gcs_transfer_logs

bool

Untuk transfer PosixFilesystem, mengaktifkan log transfer sistem file, bukan, atau sebagai tambahan, Cloud Logging.

Opsi ini mengabaikan [LoggableAction] dan [LoggableActionState]. Jika setelan ini ditetapkan, Cloud Logging juga akan diaktifkan untuk transfer ini.

LoggableAction

Tindakan yang dapat dicatat ke dalam log.

Enum
LOGGABLE_ACTION_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
FIND Mencantumkan objek dalam bucket.
DELETE Menghapus objek di sumber atau tujuan.
COPY Menyalin objek ke Google Cloud Storage.

LoggableActionState

Status tindakan yang dapat dicatat dalam log.

Enum
LOGGABLE_ACTION_STATE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
SUCCEEDED LoggableAction berhasil diselesaikan. Tindakan SUCCEEDED dicatat ke dalam log sebagai INFO.
FAILED LoggableAction dihentikan dalam status error. Tindakan FAILED dicatat ke dalam log sebagai ERROR.

MetadataOptions

Menentukan opsi metadata untuk menjalankan transfer.

Kolom
mode

Mode

Menentukan cara setiap atribut mode file harus ditangani oleh transfer. Secara default, mode tidak dipertahankan. Hanya berlaku untuk transfer yang melibatkan sistem file POSIX, dan diabaikan untuk transfer lainnya.
gid

GID

Menentukan cara setiap atribut ID grup POSIX (GID) file harus ditangani oleh transfer. Secara default, GID tidak dipertahankan. Hanya berlaku untuk transfer yang melibatkan sistem file POSIX, dan diabaikan untuk transfer lainnya.
uid

UID

Menentukan cara setiap atribut ID pengguna (UID) POSIX file harus ditangani oleh transfer. Secara default, UID tidak dipertahankan. Hanya berlaku untuk transfer yang melibatkan sistem file POSIX, dan diabaikan untuk transfer lainnya.
acl

Acl

Menentukan cara setiap ACL objek harus dipertahankan untuk transfer antar-bucket Google Cloud Storage. Jika tidak ditentukan, perilaku defaultnya sama dengan ACL_DESTINATION_BUCKET_DEFAULT.
storage_class

StorageClass

Menentukan class penyimpanan yang akan ditetapkan pada objek yang ditransfer ke bucket Google Cloud Storage. Jika tidak ditentukan, perilaku default-nya sama dengan STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT.
temporary_hold

TemporaryHold

Menentukan cara status penangguhan sementara setiap objek harus dipertahankan untuk transfer antar-bucket Google Cloud Storage. Jika tidak ditentukan, perilaku default-nya sama dengan TEMPORARY_HOLD_PRESERVE.
kms_key

KmsKey

Menentukan cara kunci enkripsi yang dikelola pelanggan (CMEK) Cloud KMS setiap objek dipertahankan untuk transfer antar-bucket Google Cloud Storage. Jika tidak ditentukan, perilaku default-nya sama dengan KMS_KEY_DESTINATION_BUCKET_DEFAULT.
time_created

TimeCreated

Menentukan cara metadata timeCreated setiap objek dipertahankan untuk transfer. Jika tidak ditentukan, perilaku default-nya sama dengan TIME_CREATED_SKIP. Perilaku ini didukung untuk transfer ke bucket Cloud Storage dari sumber Cloud Storage, Amazon S3, penyimpanan yang kompatibel dengan S3, dan Azure.

Acl

Opsi untuk menangani ACL objek Cloud Storage.

Enum
ACL_UNSPECIFIED Perilaku ACL tidak ditentukan.
ACL_DESTINATION_BUCKET_DEFAULT Gunakan ACL objek default bucket tujuan, jika berlaku.
ACL_PRESERVE Mempertahankan ACL asli objek. Hal ini mengharuskan akun layanan memiliki izin storage.objects.getIamPolicy untuk objek sumber. Akses level bucket yang seragam tidak boleh diaktifkan di bucket sumber atau tujuan.

GID

Opsi untuk menangani atribut GID file.

Enum
GID_UNSPECIFIED Perilaku GID tidak ditentukan.
GID_SKIP Jangan pertahankan GID selama tugas transfer.
GID_NUMBER Mempertahankan GID selama tugas transfer.

KmsKey

Opsi untuk menangani setelan KmsKey untuk objek Google Cloud Storage.

Enum
KMS_KEY_UNSPECIFIED Perilaku KmsKey tidak ditentukan.
KMS_KEY_DESTINATION_BUCKET_DEFAULT Gunakan setelan enkripsi default bucket tujuan.
KMS_KEY_PRESERVE Mempertahankan kunci enkripsi yang dikelola pelanggan (CMEK) Cloud KMS asli objek jika ada. Objek yang tidak menggunakan kunci enkripsi Cloud KMS akan dienkripsi menggunakan setelan enkripsi bucket tujuan.

Mode

Opsi untuk menangani atribut mode file.

Enum
MODE_UNSPECIFIED Perilaku mode tidak ditentukan.
MODE_SKIP Jangan pertahankan mode selama tugas transfer.
MODE_PRESERVE Mempertahankan mode selama tugas transfer.

StorageClass

Opsi untuk menangani class penyimpanan objek Google Cloud Storage.

Enum
STORAGE_CLASS_UNSPECIFIED Perilaku class penyimpanan tidak ditentukan.
STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT Gunakan kelas penyimpanan default bucket tujuan.
STORAGE_CLASS_PRESERVE Mempertahankan kelas penyimpanan asli objek. Hal ini hanya didukung untuk transfer dari bucket Google Cloud Storage. Class penyimpanan REGIONAL dan MULTI_REGIONAL akan dipetakan ke STANDARD untuk memastikan class tersebut dapat ditulis ke bucket tujuan.
STORAGE_CLASS_STANDARD Tetapkan kelas penyimpanan ke STANDARD.
STORAGE_CLASS_NEARLINE Tetapkan class penyimpanan ke NEARLINE.
STORAGE_CLASS_COLDLINE Tetapkan class penyimpanan ke COLDLINE.
STORAGE_CLASS_ARCHIVE Tetapkan class penyimpanan ke ARCHIVE.

TemporaryHold

Opsi untuk menangani penangguhan sementara untuk objek Google Cloud Storage.

Enum
TEMPORARY_HOLD_UNSPECIFIED Perilaku penangguhan sementara tidak ditentukan.
TEMPORARY_HOLD_SKIP Jangan tetapkan penangguhan sementara pada objek tujuan.
TEMPORARY_HOLD_PRESERVE Mempertahankan status penangguhan sementara asli objek.

TimeCreated

Opsi untuk menangani metadata timeCreated untuk objek Google Cloud Storage.

Enum
TIME_CREATED_UNSPECIFIED Perilaku TimeCreated tidak ditentukan.
TIME_CREATED_SKIP Jangan pertahankan metadata timeCreated dari objek sumber.
TIME_CREATED_PRESERVE_AS_CUSTOM_TIME Mempertahankan metadata timeCreated atau lastModified objek sumber di kolom customTime dalam objek tujuan. Perhatikan bahwa nilai apa pun yang disimpan di kolom customTime objek sumber tidak akan disebarkan ke objek tujuan.

UID

Opsi untuk menangani atribut UID file.

Enum
UID_UNSPECIFIED Perilaku UID tidak ditentukan.
UID_SKIP Jangan pertahankan UID selama tugas transfer.
UID_NUMBER Mempertahankan UID selama tugas transfer.

NotificationConfig

Spesifikasi untuk mengonfigurasi notifikasi yang dipublikasikan ke Pub/Sub. Notifikasi dipublikasikan ke topik yang disediakan pelanggan menggunakan PubsubMessage.attributes berikut:

PubsubMessage.data berisi resource TransferOperation yang diformat sesuai dengan PayloadFormat yang ditentukan.

Kolom
pubsub_topic

string

Wajib. Topic.name topik Pub/Sub yang akan memublikasikan notifikasi. Harus dalam format: projects/{project}/topics/{topic}. Tidak cocok dengan format ini akan menyebabkan error INVALID_ARGUMENT.
event_types[]

EventType

Jenis peristiwa yang diinginkan notifikasinya. Jika kosong, kirim notifikasi untuk semua jenis peristiwa.
payload_format

PayloadFormat

Wajib. Format payload pesan notifikasi yang diinginkan.

EventType

Enum untuk menentukan jenis peristiwa yang notifikasinya akan dipublikasikan.

Jenis peristiwa tambahan dapat ditambahkan di masa mendatang. Klien harus mengabaikan jenis peristiwa yang tidak dikenal dengan aman atau menentukan secara eksplisit jenis peristiwa yang siap diterima.

Enum
EVENT_TYPE_UNSPECIFIED Nilai ilegal, untuk menghindari izin default.
TRANSFER_OPERATION_SUCCESS TransferOperation selesai dengan status SUCCESS.
TRANSFER_OPERATION_FAILED TransferOperation selesai dengan status FAILED.
TRANSFER_OPERATION_ABORTED TransferOperation selesai dengan status ABORTED.

PayloadFormat

Enum untuk menentukan format payload pesan notifikasi.

Enum
PAYLOAD_FORMAT_UNSPECIFIED Nilai ilegal, untuk menghindari izin default.
NONE Tidak ada payload yang disertakan dengan notifikasi.
JSON TransferOperation diformat sebagai respons JSON, dalam application/json.

ObjectConditions

Kondisi yang menentukan objek mana yang ditransfer. Hanya berlaku untuk Sumber Data Cloud seperti S3, Azure, dan Cloud Storage.

"Waktu perubahan terakhir" mengacu pada waktu perubahan terakhir pada konten atau metadata objek — khususnya, ini adalah properti updated objek Cloud Storage, kolom LastModified objek S3, dan header Last-Modified blob Azure.

Transfer dengan sumber atau tujuan PosixFilesystem tidak mendukung ObjectConditions.

Kolom
min_time_elapsed_since_last_modification

Duration

Memastikan bahwa objek tidak ditransfer hingga waktu minimum tertentu berlalu setelah "waktu perubahan terakhir". Saat TransferOperation dimulai, objek dengan "waktu perubahan terakhir" hanya ditransfer jika waktu yang berlalu antara start_time TransferOperation dan "waktu perubahan terakhir" objek sama dengan atau lebih besar dari nilai min_time_elapsed_since_last_modification`. Objek yang tidak memiliki "waktu perubahan terakhir" juga ditransfer.
max_time_elapsed_since_last_modification

Duration

Memastikan bahwa objek tidak ditransfer jika waktu maksimum tertentu telah berlalu sejak "waktu perubahan terakhir". Saat TransferOperation dimulai, objek dengan "waktu perubahan terakhir" hanya ditransfer jika waktu yang berlalu antara start_time TransferOperation dan "waktu perubahan terakhir" objek kurang dari nilai max_time_elapsed_since_last_modification`. Objek yang tidak memiliki "waktu perubahan terakhir" juga ditransfer.
include_prefixes[]

string

Jika Anda menentukan include_prefixes, Storage Transfer Service akan menggunakan item dalam array include_prefixes untuk menentukan objek yang akan disertakan dalam transfer. Objek harus diawali dengan salah satu include_prefixes yang cocok untuk disertakan dalam transfer. Jika exclude_prefixes ditentukan, objek tidak boleh dimulai dengan exclude_prefixes yang ditentukan untuk disertakan dalam transfer.

Berikut adalah persyaratan include_prefixes:

  • Setiap awalan include dapat berisi urutan karakter Unicode, dengan panjang maksimum 1.024 byte jika berenkode UTF8, dan tidak boleh berisi karakter Enter atau Line Feed. Pencocokan karakter pengganti dan pencocokan ekspresi reguler tidak didukung.

  • Setiap awalan include harus menghilangkan garis miring di awal. Misalnya, untuk menyertakan objek s3://my-aws-bucket/logs/y=2015/requests.gz, tentukan awalan include sebagai logs/y=2015/requests.gz.

  • Tidak ada nilai include-prefix yang boleh kosong, jika ditentukan.

  • Setiap awalan include harus menyertakan bagian yang berbeda dari namespace objek. Tidak ada awalan include-prefix yang dapat menjadi awalan dari awalan include-prefix lain.

Ukuran maksimum include_prefixes adalah 1.000.

Untuk mengetahui informasi selengkapnya, lihat Memfilter objek dari transfer.
exclude_prefixes[]

string

Jika Anda menentukan exclude_prefixes, Storage Transfer Service akan menggunakan item dalam array exclude_prefixes untuk menentukan objek mana yang akan dikecualikan dari transfer. Objek tidak boleh diawali dengan salah satu exclude_prefixes yang cocok untuk disertakan dalam transfer.

Berikut adalah persyaratan exclude_prefixes:

  • Setiap awalan pengecualian dapat berisi urutan karakter Unicode apa pun, dengan panjang maksimum 1.024 byte jika dienkode UTF8, dan tidak boleh berisi karakter Enter atau Line Feed. Pencocokan karakter pengganti dan pencocokan ekspresi reguler tidak didukung.

  • Setiap awalan pengecualian harus menghilangkan garis miring di awal. Misalnya, untuk mengecualikan objek s3://my-aws-bucket/logs/y=2015/requests.gz, tentukan awalan pengecualian sebagai logs/y=2015/requests.gz.

  • Tidak ada nilai exclude-prefix yang boleh kosong, jika ditentukan.

  • Setiap awalan pengecualian harus mengecualikan bagian yang berbeda dari namespace objek. Tidak ada awalan exclude-prefix yang dapat menjadi awalan dari awalan exclude-prefix lainnya.

  • Jika include_prefixes ditentukan, setiap awalan pengecualian harus diawali dengan nilai jalur yang disertakan secara eksplisit oleh include_prefixes.

Ukuran maksimum exclude_prefixes adalah 1.000.

Untuk mengetahui informasi selengkapnya, lihat Memfilter objek dari transfer.
last_modified_since

Timestamp

Jika ditentukan, hanya objek dengan "waktu terakhir diubah" pada atau setelah stempel waktu ini dan objek yang tidak memiliki "waktu terakhir diubah" yang akan ditransfer.

Kolom last_modified_since dan last_modified_before dapat digunakan bersama untuk pemrosesan data yang dikelompokkan. Misalnya, pertimbangkan skrip yang memproses data setiap hari sekaligus. Untuk itu, Anda harus menetapkan setiap kolom sebagai berikut:

  • last_modified_since ke awal hari

  • last_modified_before hingga akhir hari
last_modified_before

Timestamp

Jika ditentukan, hanya objek dengan "waktu perubahan terakhir" sebelum stempel waktu ini dan objek yang tidak memiliki "waktu perubahan terakhir" yang akan ditransfer.

PauseTransferOperationRequest

Permintaan diteruskan ke PauseTransferOperation.

Kolom
name

string

Wajib. Nama operasi transfer.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • storagetransfer.operations.pause

PosixFilesystem

Resource sistem file POSIX.

Kolom
root_directory

string

Jalur direktori root ke sistem file.

ReplicationSpec

Menentukan konfigurasi untuk tugas replikasi lintas bucket. Replikasi lintas bucket menyalin objek baru atau yang diperbarui dari bucket Cloud Storage sumber ke bucket Cloud Storage tujuan. Objek yang ada di bucket sumber tidak disalin oleh tugas replikasi lintas bucket baru.

Kolom
object_conditions

ObjectConditions

Kondisi objek yang menentukan objek mana yang ditransfer. Untuk tugas replikasi, hanya include_prefixes dan exclude_prefixes yang didukung.
transfer_options

TransferOptions

Menentukan opsi metadata yang akan diterapkan selama replikasi. Opsi hapus tidak didukung. Jika opsi hapus ditentukan, permintaan akan gagal dengan error INVALID_ARGUMENT.
Kolom union data_source. Sumber data yang akan direplikasi. data_source hanya ada berupa salah satu diantara berikut:
gcs_data_source

GcsData

Bucket Cloud Storage tempat objek direplikasi.
Kolom union data_sink. Tujuan untuk objek yang direplikasi. data_sink hanya ada berupa salah satu diantara berikut:
gcs_data_sink

GcsData

Bucket Cloud Storage tempat objek direplikasi.

ResumeTransferOperationRequest

Permintaan diteruskan ke ResumeTransferOperation.

Kolom
name

string

Wajib. Nama operasi transfer.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • storagetransfer.operations.resume

RunTransferJobRequest

Permintaan diteruskan ke RunTransferJob.

Kolom
job_name

string

Wajib. Nama tugas transfer.

Otorisasi memerlukan izin IAM berikut pada resource jobName yang ditentukan:

  • storagetransfer.jobs.run
project_id

string

Wajib. ID project Google Cloud yang memiliki tugas transfer.

S3CompatibleMetadata

S3CompatibleMetadata berisi kolom metadata yang berlaku untuk jenis dasar penyedia data yang kompatibel dengan S3.

Kolom
auth_method

AuthMethod

Menentukan metode autentikasi dan otorisasi yang digunakan oleh layanan penyimpanan. Jika tidak ditentukan, Layanan Transfer akan mencoba menentukan metode autentikasi yang tepat untuk digunakan.
request_model

RequestModel

Menentukan model permintaan API yang digunakan untuk memanggil layanan penyimpanan. Jika tidak ditentukan, nilai default RequestModel REQUEST_MODEL_VIRTUAL_HOSTED_STYLE akan digunakan.
protocol

NetworkProtocol

Menentukan protokol jaringan agen. Jika tidak ditentukan, nilai default NetworkProtocol NETWORK_PROTOCOL_HTTPS akan digunakan.
list_api

ListApi

Listing API yang akan digunakan untuk menemukan objek. Jika tidak ditentukan, Layanan Transfer akan mencoba menentukan API yang tepat untuk digunakan.

AuthMethod

Metode autentikasi dan otorisasi yang digunakan oleh layanan penyimpanan.

Enum
AUTH_METHOD_UNSPECIFIED AuthMethod tidak ditentukan.
AUTH_METHOD_AWS_SIGNATURE_V4 Permintaan autentikasi dengan AWS SigV4.
AUTH_METHOD_AWS_SIGNATURE_V2 Permintaan autentikasi dengan AWS SigV2.

ListApi

Listing API yang akan digunakan untuk menemukan objek.

Enum
LIST_API_UNSPECIFIED ListApi tidak ditentukan.
LIST_OBJECTS_V2 Lakukan listingan menggunakan ListObjectsV2 API.
LIST_OBJECTS ListObjects API lama.

NetworkProtocol

Protokol jaringan agen untuk mengakses layanan penyimpanan.

Enum
NETWORK_PROTOCOL_UNSPECIFIED NetworkProtocol tidak ditentukan.
NETWORK_PROTOCOL_HTTPS Lakukan permintaan menggunakan HTTPS.
NETWORK_PROTOCOL_HTTP Tidak direkomendasikan: Opsi ini mengirim data dalam cleartext. Hal ini hanya sesuai dalam jaringan tertutup atau untuk data yang tersedia secara publik. Melakukan permintaan menggunakan HTTP.

RequestModel

Model permintaan API.

Enum
REQUEST_MODEL_UNSPECIFIED RequestModel tidak ditentukan.
REQUEST_MODEL_VIRTUAL_HOSTED_STYLE Melakukan permintaan menggunakan Gaya Virtual Hosted. Contoh: https://bucket-name.s3.region.amazonaws.com/key-name
REQUEST_MODEL_PATH_STYLE Melakukan permintaan menggunakan Gaya Jalur. Contoh: https://s3.region.amazonaws.com/bucket-name/key-name

Jadwal

Transfer dapat dijadwalkan untuk berulang atau berjalan hanya sekali.

Kolom
schedule_start_date

Date

Wajib. Tanggal mulai transfer. Batas tanggal ditentukan relatif terhadap waktu UTC. Jika schedule_start_date dan start_time_of_day sudah berlalu dibandingkan dengan waktu pembuatan tugas, transfer akan dimulai sehari setelah Anda menjadwalkan permintaan transfer.

Catatan: Saat memulai tugas pada atau mendekati tengah malam UTC, tugas mungkin dimulai lebih lambat dari yang diharapkan. Misalnya, jika Anda mengirim permintaan keluar pada 1 Juni satu milidetik sebelum tengah malam UTC dan server Storage Transfer Service menerima permintaan pada 2 Juni, server akan membuat TransferJob dengan schedule_start_date ditetapkan ke 2 Juni dan start_time_of_day ditetapkan ke tengah malam UTC. TransferOperation terjadwal pertama akan berlangsung pada 3 Juni pada tengah malam UTC.
schedule_end_date

Date

Hari terakhir transfer berjalan. Batas tanggal ditentukan relatif terhadap waktu UTC. Tugas berjalan sekali per 24 jam dalam panduan berikut:

  • Jika schedule_end_date dan schedule_start_date sama dan di masa mendatang relatif terhadap UTC, transfer hanya akan dijalankan satu kali.
  • Jika schedule_end_date lebih lambat dari schedule_start_date dan schedule_end_date berada di masa mendatang relatif terhadap UTC, tugas akan berjalan setiap hari pada start_time_of_day hingga schedule_end_date.
start_time_of_day

TimeOfDay

Waktu dalam UTC saat tugas transfer dijadwalkan untuk dijalankan. Transfer mungkin dimulai lebih lambat dari waktu ini.

Jika start_time_of_day tidak ditentukan:

  • Transfer satu kali akan langsung berjalan.
  • Transfer berulang langsung berjalan, dan setiap hari pada tengah malam UTC, melalui schedule_end_date.

Jika start_time_of_day ditentukan:

  • Transfer satu kali dijalankan pada waktu yang ditentukan.
  • Transfer berulang berjalan pada waktu yang ditentukan setiap hari, melalui schedule_end_date.
end_time_of_day

TimeOfDay

Waktu dalam UTC saat tidak ada operasi transfer lebih lanjut yang dijadwalkan. Dikombinasikan dengan schedule_end_date, end_time_of_day menentukan tanggal dan waktu akhir untuk memulai operasi transfer baru. Kolom ini harus lebih besar dari atau sama dengan stempel waktu yang sesuai dengan kombinasi schedule_start_date dan start_time_of_day, dan tunduk pada hal berikut:

  • Jika end_time_of_day tidak ditetapkan dan schedule_end_date ditetapkan, nilai default 23:59:59 akan digunakan untuk end_time_of_day.

  • Jika end_time_of_day ditetapkan dan schedule_end_date tidak ditetapkan, INVALID_ARGUMENT akan ditampilkan.
repeat_interval

Duration

Interval antara awal setiap TransferOperation terjadwal. Jika tidak ditentukan, nilai defaultnya adalah 24 jam. Nilai ini tidak boleh kurang dari 1 jam.

TransferCounters

Kumpulan penghitung yang melaporkan progres operasi transfer.

Kolom
objects_found_from_source

int64

Objek yang ditemukan di sumber data yang dijadwalkan untuk ditransfer, tidak termasuk objek yang difilter berdasarkan kondisi objek atau dilewati karena sinkronisasi.
bytes_found_from_source

int64

Byte yang ditemukan di sumber data yang dijadwalkan untuk ditransfer, tidak termasuk byte yang difilter berdasarkan kondisi objek atau dilewati karena sinkronisasi.
objects_found_only_from_sink

int64

Objek yang hanya ditemukan di sink data yang dijadwalkan untuk dihapus.
bytes_found_only_from_sink

int64

Byte yang hanya ditemukan di sink data yang dijadwalkan untuk dihapus.
objects_from_source_skipped_by_sync

int64

Objek di sumber data yang tidak ditransfer karena sudah ada di sink data.
bytes_from_source_skipped_by_sync

int64

Byte di sumber data yang tidak ditransfer karena sudah ada di sink data.
objects_copied_to_sink

int64

Objek yang disalin ke sink data.
bytes_copied_to_sink

int64

Byte yang disalin ke sink data.
objects_deleted_from_source

int64

Objek yang dihapus dari sumber data.
bytes_deleted_from_source

int64

Byte yang dihapus dari sumber data.
objects_deleted_from_sink

int64

Objek yang dihapus dari sink data.
bytes_deleted_from_sink

int64

Byte yang dihapus dari sink data.
objects_from_source_failed

int64

Objek di sumber data yang gagal ditransfer atau gagal dihapus setelah ditransfer.
bytes_from_source_failed

int64

Byte di sumber data yang gagal ditransfer atau gagal dihapus setelah ditransfer.
objects_failed_to_delete_from_sink

int64

Objek yang gagal dihapus dari sink data.
bytes_failed_to_delete_from_sink

int64

Byte yang gagal dihapus dari sink data.
directories_found_from_source

int64

Hanya untuk transfer yang melibatkan PosixFilesystem.

Jumlah direktori yang ditemukan saat mencantumkan. Misalnya, jika direktori utama transfer adalah base/ dan ada dua direktori lain, a/ dan b/ di bawah direktori ini, jumlah setelah mencantumkan base/, base/a/, dan base/b/ adalah 3.
directories_failed_to_list_from_source

int64

Hanya untuk transfer yang melibatkan PosixFilesystem.

Jumlah kegagalan listingan untuk setiap direktori yang ditemukan di sumber. Kemungkinan kegagalan saat mencantumkan direktori mencakup kegagalan izin atau kegagalan pemblokiran. Jika pencantuman direktori gagal, tidak ada file dalam direktori yang ditransfer.
directories_successfully_listed_from_source

int64

Hanya untuk transfer yang melibatkan PosixFilesystem.

Jumlah listingan yang berhasil untuk setiap direktori yang ditemukan di sumber.
intermediate_objects_cleaned_up

int64

Jumlah objek perantara yang berhasil dibersihkan.
intermediate_objects_failed_cleaned_up

int64

Jumlah objek perantara yang gagal dibersihkan.

TransferJob

Resource ini mewakili konfigurasi tugas transfer yang berjalan secara berkala.

Kolom
name

string

Nama unik (dalam project transfer) yang ditetapkan saat tugas dibuat. Jika kolom ini kosong di CreateTransferJobRequest, Storage Transfer Service akan menetapkan nama unik. Jika tidak, nama yang ditentukan akan digunakan sebagai nama unik untuk tugas ini.

Jika nama yang ditentukan sedang digunakan oleh tugas, permintaan pembuatan akan gagal dengan error ALREADY_EXISTS.

Nama ini harus diawali dengan awalan "transferJobs/" dan diakhiri dengan huruf atau angka, dan tidak boleh lebih dari 128 karakter. Untuk transfer yang melibatkan PosixFilesystem, nama ini harus dimulai dengan transferJobs/OPI secara khusus. Untuk semua jenis transfer lainnya, nama ini tidak boleh diawali dengan transferJobs/OPI.

Contoh Non-PosixFilesystem: "transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"

Contoh PosixFilesystem: "transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"

Aplikasi tidak boleh mengandalkan penegakan persyaratan penamaan yang melibatkan OPI.

Nama tugas yang tidak valid akan gagal dengan error INVALID_ARGUMENT.
description

string

Deskripsi yang diberikan oleh pengguna untuk tugas. Panjang maksimumnya adalah 1.024 byte jika dienkode Unicode.
project_id

string

ID project Google Cloud yang memiliki tugas.
transfer_spec

TransferSpec

Spesifikasi transfer.
replication_spec

ReplicationSpec

Spesifikasi replikasi.
notification_config

NotificationConfig

Konfigurasi notifikasi.
logging_config

LoggingConfig

Konfigurasi logging.
schedule

Schedule

Menentukan jadwal untuk tugas transfer. Kolom ini bersifat opsional. Jika kolom tidak ditetapkan, tugas tidak akan pernah mengeksekusi transfer, kecuali jika Anda memanggil RunTransferJob atau memperbarui tugas agar memiliki jadwal yang tidak kosong.
event_stream

EventStream

Menentukan aliran peristiwa untuk tugas transfer untuk transfer berbasis peristiwa. Jika EventStream ditentukan, kolom Jadwal akan diabaikan.
status

Status

Status tugas. Nilai ini HARUS ditentukan untuk CreateTransferJobRequests.

Catatan: Efek status tugas baru terjadi selama tugas berikutnya dijalankan. Misalnya, jika Anda mengubah status tugas dari ENABLED menjadi DISABLED, dan operasi yang dihasilkan oleh transfer sedang berjalan, perubahan status tidak akan memengaruhi operasi saat ini.
creation_time

Timestamp

Hanya output. Waktu saat tugas transfer dibuat.
last_modification_time

Timestamp

Hanya output. Waktu saat tugas transfer terakhir diubah.
deletion_time

Timestamp

Hanya output. Waktu saat tugas transfer dihapus.
latest_operation_name

string

Nama TransferOperation yang baru saja dimulai dari JobConfig ini. Ada jika TransferOperation telah dibuat untuk JobConfig ini.

Status

Status tugas transfer.

Enum
STATUS_UNSPECIFIED Nol adalah nilai yang tidak sah.
ENABLED Transfer baru dilakukan berdasarkan jadwal.
DISABLED Transfer baru tidak dijadwalkan.
DELETED Ini adalah status penghapusan sementara. Setelah tugas transfer ditetapkan ke status ini, tugas dan semua eksekusi transfer akan dikenai pembersihan sampah. Tugas transfer menjadi memenuhi syarat untuk pengumpulan sampah 30 hari setelah statusnya ditetapkan ke DELETED.

TransferManifest

Menentukan lokasi manifes.

Kolom
location

string

Menentukan jalur ke manifes di Cloud Storage. Akun layanan yang dikelola Google untuk transfer harus memiliki izin storage.objects.get untuk objek ini. Contoh jalurnya adalah gs://bucket_name/path/manifest.csv.

TransferOperation

Deskripsi eksekusi transfer.

Kolom
name

string

ID unik global yang ditetapkan oleh sistem.
project_id

string

ID project Google Cloud yang memiliki operasi.
transfer_spec

TransferSpec

Spesifikasi transfer.
notification_config

NotificationConfig

Konfigurasi notifikasi.
logging_config

LoggingConfig

Konfigurasi Cloud Logging.
start_time

Timestamp

Waktu mulai eksekusi transfer ini.
end_time

Timestamp

Waktu berakhir eksekusi transfer ini.
status

Status

Status operasi transfer.
counters

TransferCounters

Informasi tentang progres operasi transfer.
error_breakdowns[]

ErrorSummary

Merangkum error yang ditemukan dengan contoh entri log error.
transfer_job_name

string

Nama tugas transfer yang memicu operasi transfer ini.

Status

Status TransferOperation.

Enum
STATUS_UNSPECIFIED Nol adalah nilai yang tidak sah.
IN_PROGRESS Sedang berlangsung.
PAUSED Dijeda.
SUCCESS Berhasil diselesaikan.
FAILED Dihentikan karena kegagalan yang tidak dapat dipulihkan.
ABORTED Dibatalkan oleh pengguna.
QUEUED Tertunda untuk sementara oleh sistem. Pengguna tidak perlu melakukan tindakan apa pun.
SUSPENDING Operasi ini menangguhkan dan menghabiskan pekerjaan yang sedang berlangsung hingga selesai.

TransferOptions

TransferOptions menentukan tindakan yang akan dilakukan pada objek dalam transfer.

Kolom
overwrite_objects_already_existing_in_sink

bool

Kapan harus menimpa objek yang sudah ada di sink. Secara default, hanya objek yang berbeda dari sumber yang akan ditimpa. Jika benar, semua objek di sink yang namanya cocok dengan objek di sumber akan ditimpa dengan objek sumber.
delete_objects_unique_in_sink

bool

Apakah objek yang hanya ada di sink harus dihapus.

Catatan: Opsi ini dan delete_objects_from_source_after_transfer saling eksklusif.
delete_objects_from_source_after_transfer

bool

Apakah objek harus dihapus dari sumber setelah ditransfer ke sink.

Catatan: Opsi ini dan delete_objects_unique_in_sink saling eksklusif.
overwrite_when

OverwriteWhen

Kapan harus menimpa objek yang sudah ada di sink. Jika tidak ditetapkan, perilaku overwrite ditentukan oleh overwrite_objects_already_existing_in_sink.
metadata_options

MetadataOptions

Merepresentasikan opsi metadata yang dipilih untuk tugas transfer.

OverwriteWhen

Menentukan kapan harus menimpa objek di sink saat objek dengan nama yang cocok ditemukan di sumber.

Enum
OVERWRITE_WHEN_UNSPECIFIED Perilaku penggantian tidak ditentukan.
DIFFERENT Menimpa objek tujuan dengan objek sumber, hanya jika objek memiliki nama yang sama, tetapi nilai checksum atau ETag HTTP-nya berbeda.
NEVER Tidak pernah menimpa objek tujuan jika objek sumber memiliki nama yang sama. Dalam hal ini, objek sumber tidak ditransfer.
ALWAYS Selalu timpa objek tujuan dengan objek sumber, meskipun nilai checksum atau Etag HTTP sama.

TransferSpec

Konfigurasi untuk menjalankan transfer.

Kolom
object_conditions

ObjectConditions

Hanya objek yang memenuhi kondisi objek ini yang disertakan dalam kumpulan objek sumber data dan sink data. Kondisi objek berdasarkan "waktu perubahan terakhir" objek tidak mengecualikan objek di sink data.
transfer_options

TransferOptions

Jika opsi delete_objects_unique_in_sink adalah true dan kondisi objek berbasis waktu seperti 'waktu perubahan terakhir' ditentukan, permintaan akan gagal dengan error INVALID_ARGUMENT.
transfer_manifest

TransferManifest

File manifes menyediakan daftar objek yang akan ditransfer dari sumber data. Kolom ini mengarah ke lokasi file manifes. Jika tidak, seluruh bucket sumber akan digunakan. ObjectConditions tetap berlaku.
source_agent_pool_name

string

Menentukan nama kumpulan agen yang terkait dengan sumber data posix. Jika tidak ditentukan, nama default akan digunakan.
sink_agent_pool_name

string

Menentukan nama kumpulan agen yang terkait dengan sink data posix. Jika tidak ditentukan, nama default akan digunakan.
Kolom union data_sink. Sink tulis untuk data. data_sink hanya ada berupa salah satu diantara berikut:
gcs_data_sink

GcsData

Penampung data Cloud Storage.
posix_data_sink

PosixFilesystem

Penampung data Sistem File POSIX.
Kolom union data_source. Sumber baca data. data_source hanya ada berupa salah satu diantara berikut:
gcs_data_source

GcsData

Sumber data Cloud Storage.
aws_s3_data_source

AwsS3Data

Sumber data AWS S3.
http_data_source

HttpData

Sumber data URL HTTP.
posix_data_source

PosixFilesystem

Sumber data Filesystem POSIX.
azure_blob_storage_data_source

AzureBlobStorageData

Sumber data Azure Blob Storage.
aws_s3_compatible_data_source

AwsS3CompatibleData

Sumber data yang kompatibel dengan AWS S3.
hdfs_data_source

HdfsData

Sumber data cluster HDFS.

Kolom union intermediate_data_location.

intermediate_data_location hanya dapat berupa salah satu dari hal berikut:
gcs_intermediate_data_location

GcsData

Untuk transfer antar-sistem file, menentukan bucket Cloud Storage yang akan digunakan sebagai lokasi perantara untuk mentransfer data.

Lihat Mentransfer data antar-sistem file untuk mengetahui informasi selengkapnya.

UpdateAgentPoolRequest

Menentukan permintaan yang diteruskan ke UpdateAgentPool.

Kolom
agent_pool

AgentPool

Wajib. Kumpulan agen yang akan diperbarui. agent_pool diharapkan menentukan kolom berikut:

Otorisasi memerlukan izin IAM berikut pada resource agentPool yang ditentukan:

  • storagetransfer.agentpools.update
update_mask

FieldMask

Mask kolom kolom di agentPool yang akan diperbarui dalam permintaan ini. Kolom agentPool berikut dapat diperbarui:

UpdateTransferJobRequest

Permintaan diteruskan ke UpdateTransferJob.

Kolom
job_name

string

Wajib. Nama tugas yang akan diperbarui.

Otorisasi memerlukan izin IAM berikut pada resource jobName yang ditentukan:

  • storagetransfer.jobs.update
project_id

string

Wajib. ID project Google Cloud yang memiliki tugas.
transfer_job

TransferJob

Wajib. Tugas yang akan diperbarui. transferJob diharapkan menentukan satu atau beberapa dari lima kolom: description, transfer_spec, notification_config, logging_config, dan status. UpdateTransferJobRequest yang menentukan kolom lain akan ditolak dengan error INVALID_ARGUMENT. Memperbarui status tugas ke DELETED memerlukan izin storagetransfer.jobs.delete.
update_transfer_job_field_mask

FieldMask

Mask kolom untuk kolom di transferJob yang akan diperbarui dalam permintaan ini. Kolom di transferJob yang dapat diperbarui adalah: description, transfer_spec, notification_config, logging_config, dan status. Untuk memperbarui transfer_spec tugas, spesifikasi transfer lengkap harus diberikan. Spesifikasi yang tidak lengkap dan tidak memiliki kolom wajib diisi akan ditolak dengan error INVALID_ARGUMENT.