TransferOptions

TransferOptions は、転送内のオブジェクトに対して実行されるアクションを定義します。

JSON 表現
{
  "overwriteObjectsAlreadyExistingInSink": boolean,
  "deleteObjectsUniqueInSink": boolean,
  "deleteObjectsFromSourceAfterTransfer": boolean,
  "overwriteWhen": enum (OverwriteWhen),
  "metadataOptions": {
    object (MetadataOptions)
  }
}
フィールド
overwriteObjectsAlreadyExistingInSink

boolean

シンクにすでに存在するオブジェクトを上書きするタイミング。デフォルトでは、転送元と異なるオブジェクトのみが上書きされます。true の場合、名前がソースのオブジェクトと一致するシンク内のすべてのオブジェクトが、ソース オブジェクトで上書きされます。

deleteObjectsUniqueInSink

boolean

シンク内にのみ存在するオブジェクトを削除するかどうか。

注: このオプションと deleteObjectsFromSourceAfterTransfer は相互に排他的です。

deleteObjectsFromSourceAfterTransfer

boolean

シンクに転送した後、ソースからオブジェクトを削除するかどうか。

注: このオプションと deleteObjectsUniqueInSink は相互に排他的です。

overwriteWhen

enum (OverwriteWhen)

シンクにすでに存在するオブジェクトを上書きするタイミング。設定しない場合、上書き動作は overwriteObjectsAlreadyExistingInSink によって決まります。

metadataOptions

object (MetadataOptions)

転送ジョブに選択したメタデータ オプションを表します。

OverwriteWhen

名前が一致するオブジェクトがソースで見つかった場合に、シンクのオブジェクトを上書きするタイミングを指定します。

列挙型
OVERWRITE_WHEN_UNSPECIFIED 上書き動作は指定されていません。
DIFFERENT オブジェクトの名前が同じで HTTP ETag またはチェックサムの値が異なる場合にのみ、宛先オブジェクトをソース オブジェクトで上書きします。
NEVER 転送元のオブジェクトの名前が同じ場合、転送先のオブジェクトが上書きされることはありません。この場合、ソース オブジェクトは転送されません。
ALWAYS HTTP ETag またはチェックサムの値が同じであっても、転送先のオブジェクトは転送元のオブジェクトで常に上書きされます。

MetadataOptions

転送の実行に使用するメタデータ オプションを指定します。

JSON 表現
{
  "symlink": enum (Symlink),
  "mode": enum (Mode),
  "gid": enum (GID),
  "uid": enum (UID),
  "acl": enum (Acl),
  "storageClass": enum (StorageClass),
  "temporaryHold": enum (TemporaryHold),
  "kmsKey": enum (KmsKey),
  "timeCreated": enum (TimeCreated)
}
フィールド
mode

enum (Mode)

転送で各ファイルの mode 属性をどのように処理するかを指定します。デフォルトでは、モードは保持されません。POSIX ファイル システムに関連する転送にのみ適用され、他の転送では無視されます。

gid

enum (GID)

各ファイルの POSIX グループ ID(GID)属性を転送でどのように処理するかを指定します。デフォルトでは、GID は保持されません。POSIX ファイル システムに関連する転送にのみ適用され、他の転送では無視されます。

uid

enum (UID)

各ファイルの POSIX ユーザー ID(UID)属性を転送でどのように処理するかを指定します。デフォルトでは、UID は保持されません。POSIX ファイル システムに関連する転送にのみ適用され、他の転送では無視されます。

acl

enum (Acl)

Google Cloud Storage バケット間の転送で各オブジェクトの ACL を保持する方法を指定する。指定しない場合、デフォルトの動作は ACL_DESTINATION_BUCKET_DEFAULT と同じです。

storageClass

enum (StorageClass)

Google Cloud Storage バケットに転送されるオブジェクトに設定するストレージ クラスを指定します。指定しない場合、デフォルトの動作は STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT と同じです。

temporaryHold

enum (TemporaryHold)

Google Cloud Storage バケット間の転送で各オブジェクトの一時保留ステータスを保持する方法を指定する。指定しない場合、デフォルトの動作は TEMPORARY_HOLD_PRESERVE と同じです。

kmsKey

enum (KmsKey)

Google Cloud Storage バケット間の転送で各オブジェクトの Cloud KMS 顧客管理の暗号鍵(CMEK)を保持する方法を指定する。指定しない場合、デフォルトの動作は KMS_KEY_DESTINATION_BUCKET_DEFAULT と同じです。

timeCreated

enum (TimeCreated)

転送時に各オブジェクトの timeCreated メタデータを保持する方法を指定する。指定しない場合、デフォルトの動作は TIME_CREATED_SKIP と同じです。この動作は、Cloud Storage、Amazon S3、S3 互換ストレージ、Azure ソースから Cloud Storage バケットへの転送でサポートされています。

モード

ファイル モード属性を処理するためのオプション。

列挙型
MODE_UNSPECIFIED モードの動作は指定されていません。
MODE_SKIP 転送ジョブ中にモードを保持しない。
MODE_PRESERVE 転送ジョブ中の保持モード。

GID

ファイルの GID 属性を処理するオプション。

列挙型
GID_UNSPECIFIED GID の動作は指定されていません。
GID_SKIP 転送ジョブ中に GID を保持しない。
GID_NUMBER 転送ジョブ中に GID を保持する。

UID

ファイルの UID 属性を処理するためのオプション。

列挙型
UID_UNSPECIFIED UID の動作は指定されていません。
UID_SKIP 転送ジョブ中に UID を保持しない。
UID_NUMBER 転送ジョブ中に UID を保持します。

Acl

Cloud Storage オブジェクトの ACL を処理するためのオプション。

列挙型
ACL_UNSPECIFIED ACL の動作は指定されていません。
ACL_DESTINATION_BUCKET_DEFAULT 該当する場合は、宛先バケットのデフォルト オブジェクト ACL を使用します。
ACL_PRESERVE オブジェクトの元の ACL を保持します。これには、ソース オブジェクトに対する storage.objects.getIamPolicy 権限がサービス アカウントに必要です。転送元バケットまたは転送先バケットのいずれかで均一なバケットレベルのアクセスを有効にしないでください。

StorageClass

Google Cloud Storage オブジェクト ストレージ クラスを処理するためのオプション。

列挙型
STORAGE_CLASS_UNSPECIFIED ストレージ クラスの動作は指定されていません。
STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT 宛先バケットのデフォルトのストレージ クラスを使用します。
STORAGE_CLASS_PRESERVE オブジェクトの元のストレージ クラスを保持します。これは、Google Cloud Storage バケットからの転送でのみサポートされます。REGIONAL ストレージ クラスと MULTI_REGIONAL ストレージ クラスは、宛先バケットに書き込めるように STANDARD にマッピングされます。
STORAGE_CLASS_STANDARD ストレージ クラスを STANDARD に設定します。
STORAGE_CLASS_NEARLINE ストレージ クラスを NEARLINE に設定します。
STORAGE_CLASS_COLDLINE ストレージ クラスを COLDLINE に設定します。
STORAGE_CLASS_ARCHIVE ストレージ クラスを ARCHIVE に設定します。

TemporaryHold

Google Cloud Storage オブジェクトの一時保留を処理するためのオプション。

列挙型
TEMPORARY_HOLD_UNSPECIFIED 一時保留の動作は指定されていません。
TEMPORARY_HOLD_SKIP 宛先オブジェクトに一時保留を設定しないでください。
TEMPORARY_HOLD_PRESERVE オブジェクトの元の一時保留ステータスを保持します。

KmsKey

Google Cloud Storage オブジェクトの KmsKey 設定を処理するためのオプション。

列挙型
KMS_KEY_UNSPECIFIED KmsKey の動作は指定されていません。
KMS_KEY_DESTINATION_BUCKET_DEFAULT 宛先バケットのデフォルトの暗号化設定を使用する。
KMS_KEY_PRESERVE オブジェクトの元の Cloud KMS 顧客管理の暗号鍵(CMEK)が存在する場合は、その鍵を保持します。Cloud KMS 暗号鍵を使用しないオブジェクトは、宛先バケットの暗号化設定を使用して暗号化されます。

TimeCreated

Google Cloud Storage オブジェクトの timeCreated メタデータを処理するためのオプション。

列挙型
TIME_CREATED_UNSPECIFIED TimeCreated の動作が指定されていません。
TIME_CREATED_SKIP ソース オブジェクトの timeCreated メタデータを保持しない。
TIME_CREATED_PRESERVE_AS_CUSTOM_TIME ソース オブジェクトの timeCreated または lastModified メタデータを、宛先オブジェクトの customTime フィールドに保持します。ソース オブジェクトの customTime フィールドに保存されている値は、宛先オブジェクトに伝播されません。