GCSBucketUtil
public
class
GCSBucketUtil
extends Object
java.lang.Object | |
↳ | com.android.tradefed.util.GCSBucketUtil |
Google Cloud Storage(GCS)との間でファイルをダウンロードおよびアップロードするためのファイル マネージャー。
このクラスは、テストのスコープで使用しないでください(IRemoteTest)。これは非推奨です。代わりに GCSFileDownloader
を使用してください。
概要
ネストされたクラス | |
---|---|
class |
GCSBucketUtil.GCSFileMetadata
GCS のファイル情報のシンプルなラッパー。 |
パブリック コンストラクタ | |
---|---|
GCSBucketUtil(String bucketName)
|
パブリック メソッド | |
---|---|
CommandResult
|
copy(String source, String dest)
バケットとの間でファイルまたはディレクトリをコピーします。 |
int
|
getAttempts()
|
String
|
getBotoConfig()
|
String
|
getBotoPath()
|
String
|
getBucketName()
|
boolean
|
getNoClobber()
|
boolean
|
getParallel()
|
boolean
|
getRecursive()
|
long
|
getRetryInterval()
|
long
|
getTimeout()
|
boolean
|
isFile(String path)
GCS ファイルがファイルまたはファイル(フォルダ)ではないことを確認します。 |
|
ls(Path bucketPath)
GCS パス内のファイルを一覧表示します。 |
CommandResult
|
makeBucket(String projectId)
GCS バケットを作成する。 |
String
|
md5Hash(File localFile)
ローカル ファイルの md5 ハッシュを計算します。 |
CommandResult
|
pull(Path bucketPath, File localFile)
GCS バケットからファイルまたはディレクトリをダウンロードします。 |
CommandResult
|
pull(Path bucketPath)
GCS バケットから現在のディレクトリにファイルまたはディレクトリをダウンロードします。 |
String
|
pullContents(Path bucketPath)
GCS バケットからファイルをダウンロードして、その内容を抽出します。 |
CommandResult
|
push(File localFile)
ローカル ファイルまたはディレクトリを GCS バケットにアップロードします。 |
CommandResult
|
push(File localFile, Path bucketPath)
特定のパスでローカル ファイルまたはディレクトリを GCS バケットにアップロードします。 |
CommandResult
|
pushString(String contents, Path bucketPath)
GCS バケットに文字列をアップロードします。 |
CommandResult
|
remove(Path path)
バケットからファイルまたはディレクトリを削除します。 |
CommandResult
|
remove(Path path, boolean force)
バケットからファイルまたはディレクトリを削除します。 |
CommandResult
|
removeBucket()
GCS バケットを削除する |
void
|
setAttempts(int attempts)
|
void
|
setBotoConfig(String botoConfig)
|
void
|
setBotoPath(String botoPath)
|
void
|
setBucketName(String bucketName)
|
void
|
setNoClobber(boolean noClobber)
|
void
|
setParallel(boolean parallel)
|
void
|
setRecursive(boolean recursive)
|
void
|
setRetryInterval(long retryInterval)
|
void
|
setTimeout(long timeout, TimeUnit unit)
|
void
|
setTimeoutMs(long timeout)
|
GCSBucketUtil.GCSFileMetadata
|
stat(Path bucketPath)
GCS パスのファイルの状態を取得します。 |
保護されたメソッド | |
---|---|
IRunUtil
|
getRunUtil()
|
パブリック コンストラクタ
GCSBucketUtil
public GCSBucketUtil (String bucketName)
パラメータ | |
---|---|
bucketName |
String |
パブリック メソッド
コピー
public CommandResult copy (String source, String dest)
バケットとの間でファイルまたはディレクトリをコピーします。
パラメータ | |
---|---|
source |
String : ソースファイルまたはパターン |
dest |
String : 宛先ファイルまたはパターン |
戻り値 | |
---|---|
CommandResult |
CommandResult オペレーションの結果。 |
getAttempts
public int getAttempts ()
戻り値 | |
---|---|
int |
getBotoConfig
public String getBotoConfig ()
戻り値 | |
---|---|
String |
getBotoPath
public String getBotoPath ()
戻り値 | |
---|---|
String |
getBucketName
public String getBucketName ()
戻り値 | |
---|---|
String |
getNoClobber
public boolean getNoClobber ()
戻り値 | |
---|---|
boolean |
getParallel
public boolean getParallel ()
戻り値 | |
---|---|
boolean |
getRecursive
public boolean getRecursive ()
戻り値 | |
---|---|
boolean |
getRetryInterval
public long getRetryInterval ()
戻り値 | |
---|---|
long |
getTimeout
public long getTimeout ()
戻り値 | |
---|---|
long |
isFile
public boolean isFile (String path)
GCS ファイルがファイル(フォルダ)ではないことを確認します。
ファイル名が「/」で終わっている場合はフォルダです。gsutil ls gs://filename は、ファイルの場合は gs://filename を返します。gsutil ls gs://folder name は、フォルダにファイルがある場合はフォルダ内のファイルを返します。フォルダにファイルがない場合、gs://folder/ が返されます。
パラメータ | |
---|---|
path |
String : バケットに対する相対パス。 |
戻り値 | |
---|---|
boolean |
ファイルであるか、ファイルでないか。 |
例外 | |
---|---|
|
IOException |
ls
publicls (Path bucketPath)
GCS パスの下のファイルを一覧表示します。
パラメータ | |
---|---|
bucketPath |
Path : GCS パス |
戻り値 | |
---|---|
|
GCS パスの下のファイルである String のリスト |
例外 | |
---|---|
|
IOException |
makeBucket
public CommandResult makeBucket (String projectId)
GCS バケットを作成します。
パラメータ | |
---|---|
projectId |
String |
戻り値 | |
---|---|
CommandResult |
CommandResult オペレーションの結果。 |
例外 | |
---|---|
|
IOException |
md5Hash
public String md5Hash (File localFile)
ローカル ファイルの md5 ハッシュを計算します。
パラメータ | |
---|---|
localFile |
File : ローカル ファイル |
戻り値 | |
---|---|
String |
ローカル ファイルの MD5 ハッシュ。 |
例外 | |
---|---|
|
IOException |
pull
public CommandResult pull (Path bucketPath, File localFile)
GCS バケットからファイルまたはディレクトリをダウンロードします。
パラメータ | |
---|---|
bucketPath |
Path : GCS バケット内のファイルパス |
localFile |
File : ローカルの宛先パス |
戻り値 | |
---|---|
CommandResult |
CommandResult オペレーションの結果。 |
pull
public CommandResult pull (Path bucketPath)
GCS バケットから現在のディレクトリにファイルまたはディレクトリをダウンロードします。
パラメータ | |
---|---|
bucketPath |
Path : GCS バケット内のファイルパス |
戻り値 | |
---|---|
CommandResult |
CommandResult オペレーションの結果。 |
pullContents
public String pullContents (Path bucketPath)
GCS バケットからファイルをダウンロードして、そのコンテンツを抽出します。
パラメータ | |
---|---|
bucketPath |
Path : GCS バケット内のファイルパス |
戻り値 | |
---|---|
String |
ファイルの文字列の内容 |
プッシュ
public CommandResult push (File localFile)
ローカル ファイルまたはディレクトリを GCS バケットにアップロードします。
パラメータ | |
---|---|
localFile |
File : ローカル ファイルまたはディレクトリ |
戻り値 | |
---|---|
CommandResult |
オペレーションの CommandResult の結果。 |
プッシュ
public CommandResult push (File localFile, Path bucketPath)
特定のパスでローカル ファイルまたはディレクトリを GCS バケットにアップロードします。
パラメータ | |
---|---|
localFile |
File : ローカル ファイルまたはディレクトリ |
bucketPath |
Path : GCS バケット内のファイルパス |
戻り値 | |
---|---|
CommandResult |
CommandResult オペレーションの結果。 |
pushString
public CommandResult pushString (String contents, Path bucketPath)
GCS バケットに文字列をアップロードします。
パラメータ | |
---|---|
contents |
String : ファイルの内容(文字列) |
bucketPath |
Path : GCS バケット内のファイルパス |
戻り値 | |
---|---|
CommandResult |
CommandResult オペレーションの結果。 |
削除
public CommandResult remove (Path path)
バケットからファイルまたはディレクトリを削除します。
パラメータ | |
---|---|
path |
Path : 削除するパス |
戻り値 | |
---|---|
CommandResult |
削除
public CommandResult remove (Path path, boolean force)
バケットからファイルまたはディレクトリを削除します。
パラメータ | |
---|---|
path |
Path : 削除するパス |
force |
boolean : ファイルが存在しない場合、失敗するかどうか |
戻り値 | |
---|---|
CommandResult |
setAttempts
public void setAttempts (int attempts)
パラメータ | |
---|---|
attempts |
int |
setBotoConfig
public void setBotoConfig (String botoConfig)
パラメータ | |
---|---|
botoConfig |
String |
setBotoPath
public void setBotoPath (String botoPath)
パラメータ | |
---|---|
botoPath |
String |
setBucketName
public void setBucketName (String bucketName)
パラメータ | |
---|---|
bucketName |
String |
setNoClobber
public void setNoClobber (boolean noClobber)
パラメータ | |
---|---|
noClobber |
boolean |
setParallel
public void setParallel (boolean parallel)
パラメータ | |
---|---|
parallel |
boolean |
setRecursive
public void setRecursive (boolean recursive)
パラメータ | |
---|---|
recursive |
boolean |
setRetryInterval
public void setRetryInterval (long retryInterval)
パラメータ | |
---|---|
retryInterval |
long |
setTimeout
public void setTimeout (long timeout, TimeUnit unit)
パラメータ | |
---|---|
timeout |
long |
unit |
TimeUnit |
setTimeoutMs
public void setTimeoutMs (long timeout)
パラメータ | |
---|---|
timeout |
long |
統計
public GCSBucketUtil.GCSFileMetadata stat (Path bucketPath)
GCS パスのファイルの状態を取得します。
パラメータ | |
---|---|
bucketPath |
Path : GCS パス |
戻り値 | |
---|---|
GCSBucketUtil.GCSFileMetadata |
GCSFileMetadata : GCS パス |
例外 | |
---|---|
|
IOException |