@Generated(value="software.amazon.awssdk:codegen") public final class DescribeChapCredentialsResponse extends StorageGatewayResponse implements ToCopyableBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>
A JSON object containing the following fields:
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeChapCredentialsResponse.Builder |
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
boolean |
hasChapCredentials()
Returns true if the ChapCredentials property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeChapCredentialsResponse.Builder> |
serializableBuilderClass() |
DescribeChapCredentialsResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
copy
public final boolean hasChapCredentials()
public final 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.
You can use hasChapCredentials()
to see if a value was sent in this field.
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.
public DescribeChapCredentialsResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeChapCredentialsResponse.Builder,DescribeChapCredentialsResponse>
toBuilder
in class AwsResponse
public static DescribeChapCredentialsResponse.Builder builder()
public static Class<? extends DescribeChapCredentialsResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.