Class DescribeChapCredentialsResult
- All Implemented Interfaces:
Serializable
,Cloneable
A JSON object containing a .
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
An array of ChapInfo objects that represent CHAP credentials.int
hashCode()
void
setChapCredentials
(Collection<ChapInfo> chapCredentials) An array of ChapInfo objects that represent CHAP credentials.toString()
Returns a string representation of this object; useful for testing and debugging.withChapCredentials
(ChapInfo... chapCredentials) An array of ChapInfo objects that represent CHAP credentials.withChapCredentials
(Collection<ChapInfo> chapCredentials) An array of ChapInfo objects that represent CHAP credentials.
-
Constructor Details
-
DescribeChapCredentialsResult
public DescribeChapCredentialsResult()
-
-
Method Details
-
getChapCredentials
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
-
InitiatorName: The iSCSI initiator that connects to the target.
-
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
-
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
-
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
- Returns:
- An array of ChapInfo objects that represent CHAP
credentials. Each object in the array contains CHAP credential
information for one target-initiator pair. If no CHAP credentials
are set, an empty array is returned. CHAP credential information
is provided in a JSON object with the following fields:
-
InitiatorName: The iSCSI initiator that connects to the target.
-
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
-
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
-
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
-
-
-
setChapCredentials
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
-
InitiatorName: The iSCSI initiator that connects to the target.
-
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
-
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
-
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
- Parameters:
chapCredentials
- An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:-
InitiatorName: The iSCSI initiator that connects to the target.
-
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
-
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
-
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
-
-
-
withChapCredentials
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
-
InitiatorName: The iSCSI initiator that connects to the target.
-
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
-
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
-
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
NOTE: This method appends the values to the existing list (if any). Use
setChapCredentials(java.util.Collection)
orwithChapCredentials(java.util.Collection)
if you want to override the existing values.- Parameters:
chapCredentials
- An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:-
InitiatorName: The iSCSI initiator that connects to the target.
-
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
-
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
-
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
withChapCredentials
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
-
InitiatorName: The iSCSI initiator that connects to the target.
-
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
-
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
-
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
- Parameters:
chapCredentials
- An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:-
InitiatorName: The iSCSI initiator that connects to the target.
-
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
-
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
-
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-