software.amazon.awssdk.services.storagegateway.model

Class DescribeChapCredentialsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

software.amazon.awssdk.services.storagegateway.model.DescribeChapCredentialsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeChapCredentialsResponse
extends StorageGatewayResponse
implements ToCopyableBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>

A JSON object containing a .

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeChapCredentialsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeChapCredentialsResponse.Builder	builder()
List<ChapInfo>	chapCredentials() An array of ChapInfo objects that represent CHAP credentials.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeChapCredentialsResponse.Builder>	serializableBuilderClass()
DescribeChapCredentialsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

chapCredentials

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

toBuilder

public DescribeChapCredentialsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeChapCredentialsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeChapCredentialsResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo