com.amazonaws.services.rds.model

クラス DescribeDBSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest

すべての実装されたインタフェース:

java.io.Serializable

public class DescribeDBSnapshotsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

DescribeDBSnapshots operation のためのパラメータ用コンテナ。

DBSnapshots に関する情報を返します。このAPIは、ページネーションをサポートします。

関連項目:

AmazonRDS.describeDBSnapshots(DescribeDBSnapshotsRequest), 直列化された形式

コンストラクタの概要

コンストラクタ

コンストラクタと説明
DescribeDBSnapshotsRequest() 新しい DescribeDBSnapshotsRequest オブジェクトの既定のコンストラクタ。

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
boolean	equals(java.lang.Object obj)
java.lang.String	getDBInstanceIdentifier() DBスナップショットのリストを取得するためのDBインスタンス識別子。
java.lang.String	getDBSnapshotIdentifier() 特定のDBスナップショット識別子。
java.lang.String	getMarker() 前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。
java.lang.Integer	getMaxRecords() レスポンスに含む最大レコード数。
java.lang.String	getSnapshotType() オプションのスナップショットの型が返されます。
int	hashCode()
void	setDBInstanceIdentifier(java.lang.String dBInstanceIdentifier) DBスナップショットのリストを取得するためのDBインスタンス識別子。
void	setDBSnapshotIdentifier(java.lang.String dBSnapshotIdentifier) 特定のDBスナップショット識別子。
void	setMarker(java.lang.String marker) 前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。
void	setMaxRecords(java.lang.Integer maxRecords) レスポンスに含む最大レコード数。
void	setSnapshotType(java.lang.String snapshotType) オプションのスナップショットの型が返されます。
java.lang.String	toString() このオブジェクトの文字列表現を返します。
DescribeDBSnapshotsRequest	withDBInstanceIdentifier(java.lang.String dBInstanceIdentifier) DBスナップショットのリストを取得するためのDBインスタンス識別子。
DescribeDBSnapshotsRequest	withDBSnapshotIdentifier(java.lang.String dBSnapshotIdentifier) 特定のDBスナップショット識別子。
DescribeDBSnapshotsRequest	withMarker(java.lang.String marker) 前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。
DescribeDBSnapshotsRequest	withMaxRecords(java.lang.Integer maxRecords) レスポンスに含む最大レコード数。
DescribeDBSnapshotsRequest	withSnapshotType(java.lang.String snapshotType) オプションのスナップショットの型が返されます。

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

クラスから継承されたメソッド java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

DescribeDBSnapshotsRequest

public DescribeDBSnapshotsRequest()

新しい DescribeDBSnapshotsRequest オブジェクトの既定のコンストラクタ。 呼び出し元は、構築後にこのオブジェクトを初期化するため SetterまたはFluent Setterメソッドを使用する必要があります。

メソッドの詳細

getDBInstanceIdentifier

public java.lang.String getDBInstanceIdentifier()

DBスナップショットのリストを取得するためのDBインスタンス識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 このパラメータは、大文字と小文字を区別しません。

前提条件：

• 1～63文字の英数字またはハイフンであること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。

戻り値:

DBスナップショットのリストを取得するためのDBインスタンス識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 このパラメータは、大文字と小文字を区別しません。

前提条件：

• 1～63文字の英数字またはハイフンであること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。

setDBInstanceIdentifier

public void setDBInstanceIdentifier(java.lang.String dBInstanceIdentifier)

DBスナップショットのリストを取得するためのDBインスタンス識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 このパラメータは、大文字と小文字を区別しません。

前提条件：

• 1～63文字の英数字またはハイフンであること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。

パラメータ:

dBInstanceIdentifier - DBスナップショットのリストを取得するためのDBインスタンス識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 このパラメータは、大文字と小文字を区別しません。

前提条件：

• 1～63文字の英数字またはハイフンであること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。

withDBInstanceIdentifier

public DescribeDBSnapshotsRequest withDBInstanceIdentifier(java.lang.String dBInstanceIdentifier)

DBスナップショットのリストを取得するためのDBインスタンス識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 このパラメータは、大文字と小文字を区別しません。

前提条件：

• 1～63文字の英数字またはハイフンであること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。

このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

パラメータ:

dBInstanceIdentifier - DBスナップショットのリストを取得するためのDBインスタンス識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 このパラメータは、大文字と小文字を区別しません。

前提条件：

• 1～63文字の英数字またはハイフンであること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。

getDBSnapshotIdentifier

public java.lang.String getDBSnapshotIdentifier()

特定のDBスナップショット識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 この値は小文字の文字列として格納されます。

前提条件：

• 1～255文字の英数字であること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。
• 自動スナップショットの識別子である場合は、SnapshotTypeパラメータも指定してください。

戻り値:

特定のDBスナップショット識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 この値は小文字の文字列として格納されます。

前提条件：

• 1～255文字の英数字であること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。
• 自動スナップショットの識別子である場合は、SnapshotTypeパラメータも指定してください。

setDBSnapshotIdentifier

public void setDBSnapshotIdentifier(java.lang.String dBSnapshotIdentifier)

特定のDBスナップショット識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 この値は小文字の文字列として格納されます。

前提条件：

• 1～255文字の英数字であること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。
• 自動スナップショットの識別子である場合は、SnapshotTypeパラメータも指定してください。

パラメータ:

dBSnapshotIdentifier - 特定のDBスナップショット識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 この値は小文字の文字列として格納されます。

前提条件：

• 1～255文字の英数字であること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。
• 自動スナップショットの識別子である場合は、SnapshotTypeパラメータも指定してください。

withDBSnapshotIdentifier

public DescribeDBSnapshotsRequest withDBSnapshotIdentifier(java.lang.String dBSnapshotIdentifier)

特定のDBスナップショット識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 この値は小文字の文字列として格納されます。

前提条件：

• 1～255文字の英数字であること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。
• 自動スナップショットの識別子である場合は、SnapshotTypeパラメータも指定してください。

このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

パラメータ:

dBSnapshotIdentifier - 特定のDBスナップショット識別子。 DBSnapshotIdentifier と組み合わせて使用する事はできません。 この値は小文字の文字列として格納されます。

前提条件：

• 1～255文字の英数字であること。
• 最初の文字は英字でなければなりません。
• 最後がハイフン、または連続したハイフンを含むことはできません。
• 自動スナップショットの識別子である場合は、SnapshotTypeパラメータも指定してください。

getSnapshotType

public java.lang.String getSnapshotType()

オプションのスナップショットの型が返されます。 指定しない場合は、すべての型のスナップショットが結果として返されます。

戻り値:

オプションのスナップショットの型が返されます。 指定しない場合は、すべての型のスナップショットが結果として返されます。

setSnapshotType

public void setSnapshotType(java.lang.String snapshotType)

オプションのスナップショットの型が返されます。 指定しない場合は、すべての型のスナップショットが結果として返されます。

パラメータ:

snapshotType - オプションのスナップショットの型が返されます。 指定しない場合は、すべての型のスナップショットが結果として返されます。

withSnapshotType

public DescribeDBSnapshotsRequest withSnapshotType(java.lang.String snapshotType)

オプションのスナップショットの型が返されます。 指定しない場合は、すべての型のスナップショットが結果として返されます。

このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

パラメータ:

snapshotType - オプションのスナップショットの型が返されます。 指定しない場合は、すべての型のスナップショットが結果として返されます。

getMaxRecords

public java.lang.Integer getMaxRecords()

レスポンスに含む最大レコード数。 MaxRecords 値を超える値が利用可能な場合、ページネーショントークンは 以降の結果を取得できるように、レスポンスにマーカーを含めて返します。

初期値：100

前提条件：20～100。

戻り値:

レスポンスに含む最大レコード数。 MaxRecords 値を超える値が利用可能な場合、ページネーショントークンは 以降の結果を取得できるように、レスポンスにマーカーを含めて返します。

初期値：100

前提条件：20～100。

setMaxRecords

public void setMaxRecords(java.lang.Integer maxRecords)

レスポンスに含む最大レコード数。 MaxRecords 値を超える値が利用可能な場合、ページネーショントークンは 以降の結果を取得できるように、レスポンスにマーカーを含めて返します。

初期値：100

前提条件：20～100。

パラメータ:

maxRecords - レスポンスに含む最大レコード数。 MaxRecords 値を超える値が利用可能な場合、ページネーショントークンは 以降の結果を取得できるように、レスポンスにマーカーを含めて返します。

初期値：100

前提条件：20～100。

withMaxRecords

public DescribeDBSnapshotsRequest withMaxRecords(java.lang.Integer maxRecords)

レスポンスに含む最大レコード数。 MaxRecords 値を超える値が利用可能な場合、ページネーショントークンは 以降の結果を取得できるように、レスポンスにマーカーを含めて返します。

初期値：100

前提条件：20～100。

このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

パラメータ:

maxRecords - レスポンスに含む最大レコード数。 MaxRecords 値を超える値が利用可能な場合、ページネーショントークンは 以降の結果を取得できるように、レスポンスにマーカーを含めて返します。

初期値：100

前提条件：20～100。

getMarker

public java.lang.String getMarker()

前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。 このパラメータが指定されている場合、レスポンスには MaxRecords で指定された値を超え マーカーされたレコードが含まれます。

戻り値:

前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。 このパラメータが指定されている場合、レスポンスには MaxRecords で指定された値を超え マーカーされたレコードが含まれます。

setMarker

public void setMarker(java.lang.String marker)

前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。 このパラメータが指定されている場合、レスポンスには MaxRecords で指定された値を超え マーカーされたレコードが含まれます。

パラメータ:

marker - 前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。 このパラメータが指定されている場合、レスポンスには MaxRecords で指定された値を超え マーカーされたレコードが含まれます。

withMarker

public DescribeDBSnapshotsRequest withMarker(java.lang.String marker)

前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。 このパラメータが指定されている場合、レスポンスには MaxRecords で指定された値を超え マーカーされたレコードが含まれます。

このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

パラメータ:

marker - 前のDescribeDBSnapshotsRequestにより提供されたオプションのページネーショントークン。 このパラメータが指定されている場合、レスポンスには MaxRecords で指定された値を超え マーカーされたレコードが含まれます。

toString

public java.lang.String toString()

このオブジェクトの文字列表現を返します。テストやデバッグに利用します。

オーバーライド:

toString クラス内 java.lang.Object

戻り値:

このオブジェクトの文字列表現。

関連項目:

Object.toString()

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 java.lang.Object

equals

public boolean equals(java.lang.Object obj)

オーバーライド:

equals クラス内 java.lang.Object