UploadPartRequest (iijgio-dag-client-all 1.2.4 API)

java.lang.Object
- com.iijgio.dag.IIJGIOWebServiceRequest
- - com.iijgio.dag.services.storage.model.UploadPartRequest

All Implemented Interfaces:

SSECustomerKeyProvider
```
public class UploadPartRequest
extends IIJGIOWebServiceRequest
implements SSECustomerKeyProvider
```
IIJ GIOストレージ＆アナリシスサービスのUploadPart操作で使われるパラメータを持ちます。
必須パラメータ：バケット名、キー、アップロードID、パート番号

Constructor Summary

Constructors
Constructor and Description

UploadPartRequest()

Constructors
Constructor and Description
`UploadPartRequest()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getBucketName()` この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名を返します。
`File`	`getFile()` アップロードするデータを含むファイルを返します。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。
`long`	`getFileOffset()` 指定したファイルの任意のオフセットを返します。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。
`ProgressListener`	`getGeneralProgressListener()` オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーを返します。
`InputStream`	`getInputStream()` 新しいパートにアップロードするデータを含むストリームを返します。
`String`	`getKey()` 事前設定されたマルチパートアップロードのキーを返します。
`String`	`getMd5Digest()` このパートの内容の任意だが推奨されるMD5ハッシュを返します。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。
`int`	`getPartNumber()` マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号を返します。パート番号は1から10,000までの範囲でなければなりません。
`long`	`getPartSize()` バイト単位でこのパートのサイズを返します。
`ProgressListener`	`getProgressListener()` Deprecated. use `getGeneralProgressListener()` instead.
`SSECustomerKey`	`getSSECustomerKey()` 暗号化に用いるサーバサイド暗号化(SSE-C)の鍵を取得します。
`String`	`getUploadId()` この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのIDを返します。
`boolean`	`isLastPart()` このリクエストの作成者がマルチパートアップロードにおいて、このパートがアップロードする最後のパートであることを示す場合、 trueを返します。
`void`	`setBucketName(String bucketName)` この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名をセットします。
`void`	`setFile(File file)` アップロードするデータを含むファイルをセットします。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。
`void`	`setFileOffset(long fileOffset)` 指定したファイルの任意のオフセットをセットします。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。
`void`	`setGeneralProgressListener(ProgressListener generalProgressListener)` オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーをセットします。
`void`	`setInputStream(InputStream inputStream)` 新しいパートにアップロードするデータを含むストリームをセットします。
`void`	`setKey(String key)` 事前設定されたマルチパートアップロードのキーをセットします。
`void`	`setLastPart(boolean isLastPart)` マルチパートアップロードにおいて、アップロードする最後のパートとしてこのパートにマークをつけます。
`void`	`setMd5Digest(String md5Digest)` このパートの内容の任意だが推奨されるMD5ハッシュをセットします。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。
`void`	`setPartNumber(int partNumber)` マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号をセットします。パート番号は1から10,000までの範囲でなければなりません。
`void`	`setPartSize(long partSize)` バイト単位でこのパートのサイズをセットします。
`void`	`setProgressListener(ProgressListener progressListener)` Deprecated. use `setGeneralProgressListener(ProgressListener)` instead.
`void`	`setSSECustomerKey(SSECustomerKey sseKey)` 暗号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
`void`	`setUploadId(String uploadId)` この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのIDをセットします。
`UploadPartRequest`	`withBucketName(String bucketName)` この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名をセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withFile(File file)` アップロードするデータを含むファイルをセットします。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withFileOffset(long fileOffset)` 指定したファイルの任意のオフセットをセットします。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withGeneralProgressListener(ProgressListener progressListener)` オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーをセットし追加の連鎖したメソッド呼び出しのため、この更新したオブジェクトを返します。
`UploadPartRequest`	`withInputStream(InputStream inputStream)` 新しいパートにアップロードするデータを含むストリームをセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withKey(String key)` 事前設定されたマルチパートアップロードのキーをセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withLastPart(boolean isLastPart)` マルチパートアップロードにおいて、アップロードする最後のパートとしてこのパートにマークをつけ、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withMD5Digest(String md5Digest)` このパートの内容の任意だが推奨されるMD5ハッシュをセットします。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withPartNumber(int partNumber)` マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号をセットします。パート番号は1から10,000までの範囲でなければなりません。追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withPartSize(long partSize)` バイト単位でこのパートのサイズをセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
`UploadPartRequest`	`withProgressListener(ProgressListener progressListener)` Deprecated. use `withGeneralProgressListener(ProgressListener)` instead.
`UploadPartRequest`	`withSSECustomerKey(SSECustomerKey sseKey)` 暗号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
`UploadPartRequest`	`withUploadId(String uploadId)` この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのIDをセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。

Methods inherited from class com.iijgio.dag.IIJGIOWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UploadPartRequest
```
public UploadPartRequest()
```
- Method Detail
  - getInputStream
```
public InputStream getInputStream()
```
    新しいパートにアップロードするデータを含むストリームを返します。
    
    Returns:
    
    新しいパートにアップロードするデータを含むストリーム
  - setInputStream
```
public void setInputStream(InputStream inputStream)
```
    新しいパートにアップロードするデータを含むストリームをセットします。
    
    Parameters:
    
    inputStream - 新しいパートにアップロードするデータを含むストリーム
  - withInputStream
```
public UploadPartRequest withInputStream(InputStream inputStream)
```
    新しいパートにアップロードするデータを含むストリームをセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    inputStream - 新しいパートにアップロードするデータを含むストリーム
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getBucketName
```
public String getBucketName()
```
    この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名を返します。
    
    Returns:
    
    この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名を返します。
  - setBucketName
```
public void setBucketName(String bucketName)
```
    この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名をセットします。
    
    Parameters:
    
    bucketName - この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名を返します。
  - withBucketName
```
public UploadPartRequest withBucketName(String bucketName)
```
    この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名をセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    bucketName - この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードを含むバケット名を返します。
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getKey
```
public String getKey()
```
    事前設定されたマルチパートアップロードのキーを返します。
    
    Returns:
    
    事前設定されたマルチパートアップロードのキー
  - setKey
```
public void setKey(String key)
```
    事前設定されたマルチパートアップロードのキーをセットします。
    
    Parameters:
    
    key - 事前設定されたマルチパートアップロードのキー
  - withKey
```
public UploadPartRequest withKey(String key)
```
    事前設定されたマルチパートアップロードのキーをセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    key - 事前設定されたマルチパートアップロードのキー
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getUploadId
```
public String getUploadId()
```
    この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのIDを返します。
    
    Returns:
    
    この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのID
  - setUploadId
```
public void setUploadId(String uploadId)
```
    この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのIDをセットします。
    
    Parameters:
    
    uploadId - この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのID
  - withUploadId
```
public UploadPartRequest withUploadId(String uploadId)
```
    この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのIDをセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    uploadId - この新しいパートが関連付けられており、事前設定され、存在するマルチパートアップロードのID
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getPartNumber
```
public int getPartNumber()
```
    マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号を返します。パート番号は1から10,000までの範囲でなければなりません。
    
    Returns:
    
    マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号。パート番号は1から10,000までの範囲でなければなりません。
  - setPartNumber
```
public void setPartNumber(int partNumber)
```
    マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号をセットします。パート番号は1から10,000までの範囲でなければなりません。
    
    Parameters:
    
    partNumber - マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号。パート番号は1から10,000までの範囲でなければなりません。
  - withPartNumber
```
public UploadPartRequest withPartNumber(int partNumber)
```
    マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号をセットします。パート番号は1から10,000までの範囲でなければなりません。追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    partNumber - マルチパートアップロードの他のパートに相対的なこのパートの位置を定めるパート番号。パート番号は1から10,000までの範囲でなければなりません。
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getPartSize
```
public long getPartSize()
```
    バイト単位でこのパートのサイズを返します。
    
    Returns:
    
    バイト単位でこのパートのサイズ
  - setPartSize
```
public void setPartSize(long partSize)
```
    バイト単位でこのパートのサイズをセットします。
    
    Parameters:
    
    partSize - バイト単位でこのパートのサイズ
  - withPartSize
```
public UploadPartRequest withPartSize(long partSize)
```
    バイト単位でこのパートのサイズをセットし、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    partSize - バイト単位でこのパートのサイズ
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getMd5Digest
```
public String getMd5Digest()
```
    このパートの内容の任意だが推奨されるMD5ハッシュを返します。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。
    
    Returns:
    
    このパートの内容の任意だが推奨されるMD5ハッシュ。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。
  - setMd5Digest
```
public void setMd5Digest(String md5Digest)
```
    このパートの内容の任意だが推奨されるMD5ハッシュをセットします。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。
    
    Parameters:
    
    md5Digest - このパートの内容の任意だが推奨されるMD5ハッシュ。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。
  - withMD5Digest
```
public UploadPartRequest withMD5Digest(String md5Digest)
```
    このパートの内容の任意だが推奨されるMD5ハッシュをセットします。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    md5Digest - このパートの内容の任意だが推奨されるMD5ハッシュ。指定された場合、この値はIIJ GIOストレージ＆アナリシスサービスに送信され、データがIIJ GIOストレージ＆アナリシスサービスに届いた際にデータが完全に検証されます。
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getFile
```
public File getFile()
```
    アップロードするデータを含むファイルを返します。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。
    
    Returns:
    
    アップロードするデータを含むファイル。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。
  - setFile
```
public void setFile(File file)
```
    アップロードするデータを含むファイルをセットします。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。
    
    Parameters:
    
    file - アップロードするデータを含むファイル。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。
  - withFile
```
public UploadPartRequest withFile(File file)
```
    アップロードするデータを含むファイルをセットします。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    file - アップロードするデータを含むファイル。正確に１つのファイルあるいはストリームが、この操作に対する入力として指定されなければなりません。
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getFileOffset
```
public long getFileOffset()
```
    指定したファイルの任意のオフセットを返します。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。
    
    Returns:
    
    指定したファイルの任意のオフセット。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。
  - setFileOffset
```
public void setFileOffset(long fileOffset)
```
    指定したファイルの任意のオフセットをセットします。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。
    
    Parameters:
    
    fileOffset - 指定したファイルの任意のオフセット。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。
  - withFileOffset
```
public UploadPartRequest withFileOffset(long fileOffset)
```
    指定したファイルの任意のオフセットをセットします。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    fileOffset - 指定したファイルの任意のオフセット。そのオフセット位置でこのパートにデータをアップロードし始めます。指定されていない場合、データはファイルの先頭から読み出されます。
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getProgressListener
```
@Deprecated
public ProgressListener getProgressListener()
```
    Deprecated. use getGeneralProgressListener() instead.
    
    オブジェクトのアップロード状況の更新を受け取るための任意の進捗リスナーを返します。
    
    Returns:
    
    オブジェクトのアップロード状況の更新を受け取るための任意の進捗リスナー
  - setProgressListener
```
@Deprecated
public void setProgressListener(ProgressListener progressListener)
```
    Deprecated. use setGeneralProgressListener(ProgressListener) instead.
    
    オブジェクトのアップロード状況の更新を受け取るための任意の進捗リスナーをセットします。
    
    Parameters:
    
    progressListener - IIJ GIOストレージ＆アナリシスサービスクライアントだけで使わているレガシーな進捗リスナー
  - withProgressListener
```
@Deprecated
public UploadPartRequest withProgressListener(ProgressListener progressListener)
```
    Deprecated. use withGeneralProgressListener(ProgressListener) instead.
    
    オブジェクトのアップロード状況の更新を受け取るための任意の進捗リスナーをセットし追加の連鎖したメソッド呼び出しのため、この更新したオブジェクトを返します。
    
    Parameters:
    
    progressListener - IIJ GIOストレージ＆アナリシスサービスクライアントだけで使わているレガシーな進捗リスナー
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - isLastPart
```
public boolean isLastPart()
```
    このリクエストの作成者がマルチパートアップロードにおいて、このパートがアップロードする最後のパートであることを示す場合、 trueを返します。
    
    Returns:
    
    このリクエストの作成者がマルチパートアップロードにおいて、このパートがアップロードする最後のパートであることを示す場合、true
  - setLastPart
```
public void setLastPart(boolean isLastPart)
```
    マルチパートアップロードにおいて、アップロードする最後のパートとしてこのパートにマークをつけます。
    
    Parameters:
    
    isLastPart - マルチパートアップロードにおいて、アップロードする最後のパートかどうか
  - withLastPart
```
public UploadPartRequest withLastPart(boolean isLastPart)
```
    マルチパートアップロードにおいて、アップロードする最後のパートとしてこのパートにマークをつけ、追加の連鎖したメソッド呼び出しのため、更新されたオブジェクトを返します。
    
    Parameters:
    
    isLastPart - マルチパートアップロードにおいて、アップロードする最後のパートかどうか
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getGeneralProgressListener
```
public ProgressListener getGeneralProgressListener()
```
    オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーを返します。
    
    Returns:
    
    オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナー
  - setGeneralProgressListener
```
public void setGeneralProgressListener(ProgressListener generalProgressListener)
```
    オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーをセットします。
    
    Parameters:
    
    generalProgressListener - 新しい進捗リスナー
  - withGeneralProgressListener
```
public UploadPartRequest withGeneralProgressListener(ProgressListener progressListener)
```
    オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーをセットし追加の連鎖したメソッド呼び出しのため、この更新したオブジェクトを返します。
    
    Parameters:
    
    progressListener - 新しい進捗リスナー
    
    Returns:
    
    更新されたUploadPartRequestオブジェクト
  - getSSECustomerKey
```
public SSECustomerKey getSSECustomerKey()
```
    Description copied from interface: SSECustomerKeyProvider
    
    暗号化に用いるサーバサイド暗号化(SSE-C)の鍵を取得します。
    
    Specified by:
    
    getSSECustomerKey in interface SSECustomerKeyProvider
    
    Returns:
    
    暗号化に用いるサーバサイド暗号化の鍵
  - setSSECustomerKey
```
public void setSSECustomerKey(SSECustomerKey sseKey)
```
    暗号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
    
    Parameters:
    
    sseKey - 暗号化に用いるサーバサイド暗号化(SSE-C)の鍵
  - withSSECustomerKey
```
public UploadPartRequest withSSECustomerKey(SSECustomerKey sseKey)
```
    暗号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
    追加の連鎖したメソッド呼び出しのため、更新した本クラスのオブジェクトを返します。
    
    Parameters:
    
    sseKey - 暗号化に用いるサーバサイド暗号化(SSE-C)の鍵
    
    Returns:
    
    更新した本クラスのオブジェクト

Class UploadPartRequest

Constructor Summary

Method Summary

Methods inherited from class com.iijgio.dag.IIJGIOWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UploadPartRequest

Method Detail

getInputStream

setInputStream

withInputStream

getBucketName

setBucketName

withBucketName

getKey

setKey

withKey

getUploadId

setUploadId

withUploadId

getPartNumber

setPartNumber

withPartNumber

getPartSize

setPartSize

withPartSize

getMd5Digest

setMd5Digest

withMD5Digest

getFile

setFile

withFile

getFileOffset

setFileOffset

withFileOffset

getProgressListener

setProgressListener

withProgressListener

isLastPart

setLastPart

withLastPart

getGeneralProgressListener

setGeneralProgressListener

withGeneralProgressListener

getSSECustomerKey

setSSECustomerKey

withSSECustomerKey