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

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

```
public class ListObjectsRequest
extends IIJGIOWebServiceRequest
```
指定したバケットに含まれるオブジェクトのサマリ情報のリストを取得するためのオプションを含みます。
リクエストパラメタに依って、デリミタが指定されている場合の共通のプレフィックスなど、追加情報が返されます。結果のリストは必ず、アルファベット順でかえされます。

バケットは仮想的に無制限の数のキーを含むことができ、リスト取得の結果リストは非常に大きな数の結果を含む可能性があります。これに対応するため、IIJ GIOストレージ＆アナリシスサービス API ではそれらの結果を複数のレスポンスとして返します。呼び出しの際には、必ずObjectListing.isTruncated()メソッドをチェックして返された結果リストが完全なものか、さらに情報が残っているかを確認してください。代替手段として、StorageClient.listNextBatchOfObjects(ObjectListing) メソッドを使えば、オブジェクトリストの次のページを取得する事ができます

setDelimiter(String)を呼んでデリミタをセットすることで、デリミタで区切られた共通プレフィックスを含むファイルをグループにしてリスト化する事ができます。これを用いると、アプリケーションにキーの構造をファイルシステムでディレクトリへファイルを保管するのと同様に扱うことが出来ます。この共通プレフィックスはObjectListing.getCommonPrefixes()メソッドで得られます。 through the

例えば、バケットに以下のキーが含まれている場合
- "foo/bar/baz"
- "foo/bar/bash"
- "foo/bar/bang"
- "foo/boo"
もし listObjects をプレフィックス"foo/"とデリミタ"/"を指定してこのバケットで呼んだ場合、ObjectListingは1つのキー("foo/boo")と 1つの共通プレフィックスをのエントリを返します。
更に深い仮想的な階層のを見る場合は、再度listObjectsをプレフィックスを指定して呼び出し、キーを取得してください。
バケット内のキー総数はリストの性能には影響せず、追加パラメタの有無も影響しません。

Constructor Summary

Constructors
Constructor and Description
`ListObjectsRequest()` 新たにオブジェクトを構築します。呼び出し元は、リクエストの実行前にオブジェクトフィールドを指定しなければなりません
`ListObjectsRequest(String bucketName, String prefix, String marker, String delimiter, Integer maxKeys)` 新たにオブジェクトを全ての必須項目とオプション項目を指定して構築します。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBucketName()` オブジェクトのリストを取得するバケットの名前を返します
`String`	`getDelimiter()` オブジェクトリストを取得する際の、オプションのデリミタを返します。デリミタは、プレフィックスと最初のデリミタ文字までの文字列を一つの要素と扱う為に使われ、複合キーは`ObjectListing.getCommonPrefixes()` でリストとして返されます。これらの複合キーはこのリクエストへのレスポンスのとしては返されません。デリミタの最も一般的な使用法は、"/"をデリミタとして使用し、ファイルシステムのディレクトリ構造をシミュレートするために使います。
`String`	`getMarker()` オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタを返します。リストは指定さてキー以降のキーを返します。
`Integer`	`getMaxKeys()` オブジェクトリストを取得する際の、オプションの最大キー数を返します。最大キー数はレスポンスに含まれるキーの最大数で、一度のレスポンスでこれより少ない件数が返ることはあっても、これより大き件数が返ることはありません。もし指定されていなかった場合は、デフォルトの最大値が使われます。
`String`	`getPrefix()` 指定されたプレフィックスを持つキーのみを返すため、オプションのプレフィックスを返します。
`void`	`setBucketName(String bucketName)` オブジェクトのリストを取得するバケットの名前をセットします
`void`	`setDelimiter(String delimiter)` オブジェクトリストを取得する際の、オプションのデリミタをセットします。デリミタは、プレフィックスと最初のデリミタ文字までの文字列を一つの要素と扱う為に使われ、複合キーは`ObjectListing.getCommonPrefixes()` でリストとして返されます。これらの複合キーはこのリクエストへのレスポンスのとしては返されません。デリミタの最も一般的な使用法は、"/"をデリミタとして使用し、ファイルシステムのディレクトリ構造をシミュレートするために使います。
`void`	`setMarker(String marker)` オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタをセットします。リストは指定さてキー以降のキーを返します。
`void`	`setMaxKeys(Integer maxKeys)` オブジェクトリストを取得する際の、オプションの最大キー数をセットします。最大キー数はレスポンスに含まれるキーの最大数で、一度のレスポンスでこれより少ない件数が返ることはあっても、これより大き件数が返ることはありません。もし指定されていなかった場合は、デフォルトの最大値が使われます。
`void`	`setPrefix(String prefix)` 指定されたプレフィックスを持つキーのみを返すため、オプションのプレフィックスを指定します
`ListObjectsRequest`	`withBucketName(String bucketName)` オブジェクトのリストを取得するバケットの名前をセットし、追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
`ListObjectsRequest`	`withDelimiter(String delimiter)` オブジェクトリストを取得する際の、オプションのデリミタをセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。デリミタは、プレフィックスと最初のデリミタ文字までの文字列を一つの要素と扱う為に使われ、複合キーは`ObjectListing.getCommonPrefixes()` でリストとして返されます。これらの複合キーはこのリクエストへのレスポンスのとしては返されません。デリミタの最も一般的な使用法は、"/"をデリミタとして使用し、ファイルシステムのディレクトリ構造をシミュレートするために使います。
`ListObjectsRequest`	`withMarker(String marker)` オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタをセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。リストは指定さてキー以降のキーを返します。
`ListObjectsRequest`	`withMaxKeys(Integer maxKeys)` オブジェクトリストを取得する際の、オプションの最大キー数をセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。最大キー数はレスポンスに含まれるキーの最大数で、一度のレスポンスでこれより少ない件数が返ることはあっても、これより大き件数が返ることはありません。もし指定されていなかった場合は、デフォルトの最大値が使われます。
`ListObjectsRequest`	`withPrefix(String prefix)` 指定されたプレフィックスを持つキーのみを返すため、オプションのプレフィックスを指定し追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。

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
  - ListObjectsRequest
```
public ListObjectsRequest()
```
    新たにオブジェクトを構築します。呼び出し元は、リクエストの実行前にオブジェクトフィールドを指定しなければなりません
    
    See Also:
    
    ListObjectsRequest(String, String, String, String, Integer)
  - ListObjectsRequest
```
public ListObjectsRequest(String bucketName,
                          String prefix,
                          String marker,
                          String delimiter,
                          Integer maxKeys)
```
    新たにオブジェクトを全ての必須項目とオプション項目を指定して構築します。
    
    Parameters:
    
    bucketName - オブジェクトのリストを生成するバケット名
    
    prefix - リストするキーのプレフィックス
    
    marker - リスト化開始点を指定するマーカー
    
    delimiter - 結果リスト内で共通プレフィックスとみなすためのデリミタ
    
    maxKeys - 返却する最大キー数
    
    See Also:
    
    ListObjectsRequest()
- Method Detail
  - getBucketName
```
public String getBucketName()
```
    オブジェクトのリストを取得するバケットの名前を返します
    
    Returns:
    
    オブジェクトのリストを取得するバケットの名前
    
    See Also:
    
    setBucketName(String), withBucketName(String)
  - setBucketName
```
public void setBucketName(String bucketName)
```
    オブジェクトのリストを取得するバケットの名前をセットします
    
    Parameters:
    
    bucketName - オブジェクトのリストを取得するバケットの名前
    
    See Also:
    
    getBucketName(), withBucketName(String)
  - withBucketName
```
public ListObjectsRequest withBucketName(String bucketName)
```
    オブジェクトのリストを取得するバケットの名前をセットし、追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
    
    Parameters:
    
    bucketName - オブジェクトのリストを取得するバケットの名前
    
    Returns:
    
    更新した、この ListObjectsRequest オブジェクト
    
    See Also:
    
    getBucketName(), setBucketName(String)
  - getPrefix
```
public String getPrefix()
```
    指定されたプレフィックスを持つキーのみを返すため、オプションのプレフィックスを返します。
    
    Returns:
    
    指定されたプレフィックスを持つキーのみを返すため、　オプションのプレフィックス
    
    See Also:
    
    setPrefix(String)
  - setPrefix
```
public void setPrefix(String prefix)
```
    指定されたプレフィックスを持つキーのみを返すため、オプションのプレフィックスを指定します
    
    Parameters:
    
    prefix - 指定された共通プレフィックスを持つキーのみを返すためのオプションのプレフィックス
    
    See Also:
    
    getPrefix()
  - withPrefix
```
public ListObjectsRequest withPrefix(String prefix)
```
    指定されたプレフィックスを持つキーのみを返すため、オプションのプレフィックスを指定し追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
    
    Parameters:
    
    prefix - 指定された共通プレフィックスを持つキーのみを返すためのオプションのプレフィックス
    
    Returns:
    
    更新した、この ListObjectsRequest オブジェクト
    
    See Also:
    
    getPrefix(), setPrefix(String)
  - getMarker
```
public String getMarker()
```
    オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタを返します。リストは指定さてキー以降のキーを返します。
    
    Returns:
    
    オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタ
    
    See Also:
    
    setMarker(String), withMarker(String)
  - setMarker
```
public void setMarker(String marker)
```
    オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタをセットします。リストは指定さてキー以降のキーを返します。
    
    Parameters:
    
    marker - オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタ
    
    See Also:
    
    getMarker(), withMarker(String)
  - withMarker
```
public ListObjectsRequest withMarker(String marker)
```
    オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタをセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。リストは指定さてキー以降のキーを返します。
    
    Parameters:
    
    marker - オブジェクトリストを取得する際の開始位置を指定するための、オプションのマーカーパラメタ
    
    Returns:
    
    更新した、この ListObjectsRequest オブジェクト
    
    See Also:
    
    getMarker(), setMarker(String)
  - getDelimiter
```
public String getDelimiter()
```
    オブジェクトリストを取得する際の、オプションのデリミタを返します。デリミタは、プレフィックスと最初のデリミタ文字までの文字列を一つの要素と扱う為に使われ、複合キーはObjectListing.getCommonPrefixes() でリストとして返されます。これらの複合キーはこのリクエストへのレスポンスのとしては返されません。デリミタの最も一般的な使用法は、"/"をデリミタとして使用し、ファイルシステムのディレクトリ構造をシミュレートするために使います。
    
    Returns:
    
    オブジェクトリストを取得する際の、オプションのデリミタ
    
    See Also:
    
    setDelimiter(String), withDelimiter(String)
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
    オブジェクトリストを取得する際の、オプションのデリミタをセットします。デリミタは、プレフィックスと最初のデリミタ文字までの文字列を一つの要素と扱う為に使われ、複合キーはObjectListing.getCommonPrefixes() でリストとして返されます。これらの複合キーはこのリクエストへのレスポンスのとしては返されません。デリミタの最も一般的な使用法は、"/"をデリミタとして使用し、ファイルシステムのディレクトリ構造をシミュレートするために使います。
    
    Parameters:
    
    delimiter - オブジェクトリストを取得する際の、オプションのデリミタ
    
    See Also:
    
    getDelimiter(), withDelimiter(String)
  - withDelimiter
```
public ListObjectsRequest withDelimiter(String delimiter)
```
    オブジェクトリストを取得する際の、オプションのデリミタをセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。デリミタは、プレフィックスと最初のデリミタ文字までの文字列を一つの要素と扱う為に使われ、複合キーはObjectListing.getCommonPrefixes() でリストとして返されます。これらの複合キーはこのリクエストへのレスポンスのとしては返されません。デリミタの最も一般的な使用法は、"/"をデリミタとして使用し、ファイルシステムのディレクトリ構造をシミュレートするために使います。
    
    Parameters:
    
    delimiter - オブジェクトリストを取得する際の、オプションのデリミタ
    
    Returns:
    
    更新した、この ListObjectsRequest オブジェクト
    
    See Also:
    
    getDelimiter(), setDelimiter(String)
  - getMaxKeys
```
public Integer getMaxKeys()
```
    オブジェクトリストを取得する際の、オプションの最大キー数を返します。最大キー数はレスポンスに含まれるキーの最大数で、一度のレスポンスでこれより少ない件数が返ることはあっても、これより大き件数が返ることはありません。もし指定されていなかった場合は、デフォルトの最大値が使われます。
    
    Returns:
    
    オブジェクトリストを取得する際の、オプションの最大キー数
    
    See Also:
    
    setMaxKeys(Integer), withMaxKeys(Integer)
  - setMaxKeys
```
public void setMaxKeys(Integer maxKeys)
```
    オブジェクトリストを取得する際の、オプションの最大キー数をセットします。最大キー数はレスポンスに含まれるキーの最大数で、一度のレスポンスでこれより少ない件数が返ることはあっても、これより大き件数が返ることはありません。もし指定されていなかった場合は、デフォルトの最大値が使われます。
    
    Parameters:
    
    maxKeys - オブジェクトリストを取得する際の、オプションの最大キー数
    
    See Also:
    
    getMaxKeys(), withMaxKeys(Integer)
  - withMaxKeys
```
public ListObjectsRequest withMaxKeys(Integer maxKeys)
```
    オブジェクトリストを取得する際の、オプションの最大キー数をセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。最大キー数はレスポンスに含まれるキーの最大数で、一度のレスポンスでこれより少ない件数が返ることはあっても、これより大き件数が返ることはありません。もし指定されていなかった場合は、デフォルトの最大値が使われます。
    
    Parameters:
    
    maxKeys - オブジェクトリストを取得する際の、オプションの最大キー数
    
    Returns:
    
    更新した、この ListObjectsRequest オブジェクト
    
    See Also:
    
    getMaxKeys(), setMaxKeys(Integer)

Class ListObjectsRequest

Constructor Summary

Method Summary

Methods inherited from class com.iijgio.dag.IIJGIOWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListObjectsRequest

ListObjectsRequest

Method Detail

getBucketName

setBucketName

withBucketName

getPrefix

setPrefix

withPrefix

getMarker

setMarker

withMarker

getDelimiter

setDelimiter

withDelimiter

getMaxKeys

setMaxKeys

withMaxKeys