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

Interface DescribeChapCredentialsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>, SdkBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>, SdkPojo, SdkResponse.Builder, StorageGatewayResponse.Builder

Enclosing class:

DescribeChapCredentialsResponse

public static interface DescribeChapCredentialsResponse.Builder
extends StorageGatewayResponse.Builder, SdkPojo, 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(Consumer<ChapInfo.Builder>... 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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse.Builder

build, responseMetadata, responseMetadata

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.

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

This is a convenience method that creates an instance of the ChapInfo.Builder avoiding the need to create one manually via ChapInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #chapCredentials(List).

Parameters:

chapCredentials - a consumer that will call methods on ChapInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#chapCredentials(java.util.Collection)