Package software.amazon.awssdk.services.storagegateway.model

Interface DescribeChapCredentialsResponse.Builder

All Superinterfaces:

CopyableBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>, SdkBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>

Enclosing class:

DescribeChapCredentialsResponse

public static interface DescribeChapCredentialsResponse.Builder
extends CopyableBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>

Method Summary

Modifier and Type	Method	Description
DescribeChapCredentialsResponse.Builder	chapCredentials(Collection<ChapInfo> chapCredentials)	An array of ChapInfo objects that represent CHAP credentials.
DescribeChapCredentialsResponse.Builder	chapCredentials(ChapInfo... chapCredentials)	An array of ChapInfo objects that represent CHAP credentials.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

chapCredentials

DescribeChapCredentialsResponse.Builder chapCredentials(Collection<ChapInfo> 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.

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.

chapCredentials

DescribeChapCredentialsResponse.Builder chapCredentials(ChapInfo... 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.

NOTE: This method appends the values to the existing list (if any). Use #setChapCredentials(java.util.Collection) or #withChapCredentials(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.