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

java.lang.Object
- com.iijgio.dag.services.storage.model.ObjectListing

```
public class ObjectListing
extends Object
```
バケットに含まれるオブジェクトのリスト化の結果を含みます。このオブジェクトには、バケットに含まれているオブジェクトを表す StorageObjectSummaryオブジェクトのリスト、リクエストにデリミタが指定されている場合の共通プレフィックス、リストが完全なものか部分的なものかに関する情報、および、オリジナルのリクエストパラメタを含みます

See Also:

Storage.listObjects(String, String), Storage.listObjects(ListObjectsRequest), Storage.listNextBatchOfObjects(ObjectListing)

Constructor Summary

Constructors
Constructor and Description

ObjectListing()

Constructors
Constructor and Description
`ObjectListing()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBucketName()` このによってリスト化されたオブジェクトを含むバケット名を返します
`List<String>`	`getCommonPrefixes()` このオブジェクトリストに含まれる共通のプレフィックスを返します。共通プレフィックスは、デリミタがリクエストに指定されている場合にのみ提供されます
`String`	`getDelimiter()` このオブジェクトのリスト化リクエストで使用したオリジナルのデリミタパラメタを返します。パラメタが指定されていなかった場合は`null`が返ります。
`String`	`getMarker()` このオブジェクトのリスト化リクエストで使用したオリジナルのマーカーパラメタを返します。マーカーパラメタが指定されていなかった場合は`null` を返します。指定された場合は、このリストに含まれる全てのオブジェクトと共通プレフィックスは指定されたマーカーのアルファベット順の次のものから返されます。
`int`	`getMaxKeys()` このオブジェクトのリスト化リクエストで使用したオリジナルの最大キー数パラメタを返します。パラメタが指定されていなかった場合はデフォルト値が返ります。最大キー数は、リストに含まれるオブジェクトや共通プレフィックスの数を制限します。
`String`	`getNextMarker()` 結果の次ページを表示するために、次の`listObjects`を呼び出す際に指定するマーカーを返します。オブジェクトリストが分割されていない場合、このメソッドは`null`を返し、分割されている場合はこのオブジェクトキーおよび共通プレフィックスのアルファベット順の次の値を返します。
`List<StorageObjectSummary>`	`getObjectSummaries()` バケットに保存されているオブジェクトに関するサマリのリストを返します。リスト取得の結果リストは非常に大きな数の結果を含む可能性があるため、 IIJ GIOストレージ＆アナリシスサービス API ではそれらの結果を複数のレスポンスとして返すことがあります。呼び出しの際には、必ずObjectListing.isTruncated() メソッドをチェックして返された結果リストが完全なものか、さらに情報が残っているかを確認してください。代替手段として、 StorageClient.listNextBatchOfObjects(ObjectListing) メソッドを使えばオブジェクトリストの次のページを取得する事ができます
`String`	`getPrefix()` このオブジェクトリスト化で使用したプレフィックスパラメタを返します。プレフィックスが指定されていなかった場合は `null` を返します。このオブジェクトリスト化の全てのオブジェクトは指定されたプレフィックスを共通のプレフィックスとして持っています
`boolean`	`isTruncated()` このオブジェクトリストが完全なものか部分的なものかを返します。
`void`	`setBucketName(String bucketName)` SDK内部利用のみこのによってリスト化されたオブジェクトを含むバケット名をセットします
`void`	`setCommonPrefixes(List<String> commonPrefixes)` SDK内部利用のみこのオブジェクトリストに含まれる共通のプレフィックスをセットします。リクエストのデリミタパラメタによってキープレフィックスが抽出されます
`void`	`setDelimiter(String delimiter)` SDK内部利用のみこのオブジェクトのリスト化リクエストで使用したオリジナルのデリミタパラメタをセットします。
`void`	`setMarker(String marker)` SDK内部利用のみリスト化リクエストで使用したオリジナルのマーカーパラメタをセットします
`void`	`setMaxKeys(int maxKeys)` SDK内部利用のみこのオブジェクトのリスト化リクエストで使用したオリジナルの最大キー数パラメタをセットします。
`void`	`setNextMarker(String nextMarker)` SDK内部利用のみ分割された結果の次ページを表示するために、次の`listObjects`を呼び出す際に指定するマーカーをセットします。
`void`	`setPrefix(String prefix)` SDK内部利用のみこのオブジェクトリスト化で使用したプレフィックスパラメタをセットします。
`void`	`setTruncated(boolean isTruncated)` SDK内部のみこのオブジェクトリストが完全なものか部分的なものかをセットします。

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

- Constructor Detail
  - ObjectListing
```
public ObjectListing()
```
- Method Detail
  - getObjectSummaries
```
public List<StorageObjectSummary> getObjectSummaries()
```
    バケットに保存されているオブジェクトに関するサマリのリストを返します。リスト取得の結果リストは非常に大きな数の結果を含む可能性があるため、 IIJ GIOストレージ＆アナリシスサービス API ではそれらの結果を複数のレスポンスとして返すことがあります。呼び出しの際には、必ずObjectListing.isTruncated() メソッドをチェックして返された結果リストが完全なものか、さらに情報が残っているかを確認してください。代替手段として、 StorageClient.listNextBatchOfObjects(ObjectListing) メソッドを使えばオブジェクトリストの次のページを取得する事ができます
    
    Returns:
    
    バケットに保存されているオブジェクトのサマリのリスト
  - getCommonPrefixes
```
public List<String> getCommonPrefixes()
```
    このオブジェクトリストに含まれる共通のプレフィックスを返します。共通プレフィックスは、デリミタがリクエストに指定されている場合にのみ提供されます
    
    各共通プレフィックスは、バケット内のキーのセットであり、これらのオブジェクトサマリは抽出され省略されます。これによって、ファイルシステムのディレクトリ構造のような階層構造に対する操作を仮想的に提供します。
    
    例えば、バケットに以下のキーが含まれている場合
    - "foo/bar/baz"
    - "foo/bar/bash"
    - "foo/bar/bang"
    - "foo/boo"
    もし listObjects をプレフィックス"foo/"とデリミタ"/"を指定してこのバケットをで呼んだ場合、ObjectListingオブジェクトを返しオブジェクトには共通プレフィックスリスト("foo/var")を含み、共通プレフィックスから始まるキーはオブジェクトサマリリストには含まれません。
    Returns:
    
    このオブジェクトリストに含まれる共通のプレフィックス
  - setCommonPrefixes
```
public void setCommonPrefixes(List<String> commonPrefixes)
```
    SDK内部利用のみこのオブジェクトリストに含まれる共通のプレフィックスをセットします。リクエストのデリミタパラメタによってキープレフィックスが抽出されます
    
    Parameters:
    
    commonPrefixes - このオブジェクトリストに含まれる共通のプレフィックス
  - getNextMarker
```
public String getNextMarker()
```
    結果の次ページを表示するために、次のlistObjectsを呼び出す際に指定するマーカーを返します。オブジェクトリストが分割されていない場合、このメソッドはnullを返し、分割されている場合はこのオブジェクトキーおよび共通プレフィックスのアルファベット順の次の値を返します。
    
    Returns:
    
    結果の次ページを表示するために、次のlistObjectsを呼び出す際に指定するマーカー
  - setNextMarker
```
public void setNextMarker(String nextMarker)
```
    SDK内部利用のみ分割された結果の次ページを表示するために、次のlistObjectsを呼び出す際に指定するマーカーをセットします。
    
    Parameters:
    
    nextMarker - 結果の次ページを表示するために、次のlistObjectsを呼び出す際に指定するマーカー
  - getBucketName
```
public String getBucketName()
```
    このによってリスト化されたオブジェクトを含むバケット名を返します
    
    Returns:
    
    このObjectListingによってリスト化されたオブジェクトを含むバケット名
  - setBucketName
```
public void setBucketName(String bucketName)
```
    SDK内部利用のみこのによってリスト化されたオブジェクトを含むバケット名をセットします
    
    Parameters:
    
    bucketName - このによってリスト化されたオブジェクトを含むバケット名
  - getPrefix
```
public String getPrefix()
```
    このオブジェクトリスト化で使用したプレフィックスパラメタを返します。プレフィックスが指定されていなかった場合は null を返します。このオブジェクトリスト化の全てのオブジェクトは指定されたプレフィックスを共通のプレフィックスとして持っています
    
    Returns:
    
    このオブジェクトリスト化で使用したプレフィックスパラメタプレフィックスが指定されていなかった場合は null
  - setPrefix
```
public void setPrefix(String prefix)
```
    SDK内部利用のみこのオブジェクトリスト化で使用したプレフィックスパラメタをセットします。
    
    Parameters:
    
    prefix - このオブジェクトリスト化で使用したプレフィックスパラメタ
  - getMarker
```
public String getMarker()
```
    このオブジェクトのリスト化リクエストで使用したオリジナルのマーカーパラメタを返します。マーカーパラメタが指定されていなかった場合はnull を返します。指定された場合は、このリストに含まれる全てのオブジェクトと共通プレフィックスは指定されたマーカーのアルファベット順の次のものから返されます。
    
    Returns:
    
    このオブジェクトのリスト化リクエストでしようしたオリジナルのマーカーパラメタマーカーパラメタが指定されていなかった場合はnull
  - setMarker
```
public void setMarker(String marker)
```
    SDK内部利用のみリスト化リクエストで使用したオリジナルのマーカーパラメタをセットします
    
    Parameters:
    
    marker - リスト化リクエストで使用したオリジナルのマーカーパラメタ
  - getMaxKeys
```
public int getMaxKeys()
```
    このオブジェクトのリスト化リクエストで使用したオリジナルの最大キー数パラメタを返します。パラメタが指定されていなかった場合はデフォルト値が返ります。最大キー数は、リストに含まれるオブジェクトや共通プレフィックスの数を制限します。
    
    Returns:
    
    このオブジェクトのリスト化リクエストで使用したオリジナルの最大キー数パラメタ
  - setMaxKeys
```
public void setMaxKeys(int maxKeys)
```
    SDK内部利用のみこのオブジェクトのリスト化リクエストで使用したオリジナルの最大キー数パラメタをセットします。
    
    Parameters:
    
    maxKeys - このオブジェクトのリスト化リクエストで使用したオリジナルの最大キー数パラメタ
  - getDelimiter
```
public String getDelimiter()
```
    このオブジェクトのリスト化リクエストで使用したオリジナルのデリミタパラメタを返します。パラメタが指定されていなかった場合はnullが返ります。
    デリミタはキーから共通パラメタを抽出するために使われます。例えば、デリミタ"/"を指定した場合、キー文字列の先頭からデリミタ文字"/"が最初に現れる部分までをプレフィックスとして判断し、オブジェクトサマリから抽出し、共通プレフィックスを持つキーは1つのエントリとしてまとめられます
    
    Returns:
    
    このオブジェクトのリスト化リクエストで使用したオリジナルのデリミタパラメタ
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
    SDK内部利用のみこのオブジェクトのリスト化リクエストで使用したオリジナルのデリミタパラメタをセットします。
    
    Parameters:
    
    delimiter - このオブジェクトのリスト化リクエストで使用したオリジナルのデリミタパラメタ
  - isTruncated
```
public boolean isTruncated()
```
    このオブジェクトリストが完全なものか部分的なものかを返します。
    
    Returns:
    
    リストが部分的なものであった場合はtrue
  - setTruncated
```
public void setTruncated(boolean isTruncated)
```
    SDK内部のみこのオブジェクトリストが完全なものか部分的なものかをセットします。
    
    Parameters:
    
    isTruncated - リストが部分的なものであった場合はtrue 完全な場合は false

Class ObjectListing

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObjectListing

Method Detail

getObjectSummaries

getCommonPrefixes

setCommonPrefixes

getNextMarker

setNextMarker

getBucketName

setBucketName

getPrefix

setPrefix

getMarker

setMarker

getMaxKeys

setMaxKeys

getDelimiter

setDelimiter

isTruncated

setTruncated