Class UpdateChapCredentialsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest
software.amazon.awssdk.services.storagegateway.model.UpdateChapCredentialsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateChapCredentialsRequest.Builder,UpdateChapCredentialsRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateChapCredentialsRequest extends StorageGatewayRequest implements ToCopyableBuilder<UpdateChapCredentialsRequest.Builder,UpdateChapCredentialsRequest>

A JSON object containing one or more of the following fields:

  • Method Details

    • targetARN

      public final String targetARN()

      The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

      Returns:
      The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

    • secretToAuthenticateInitiator

      public final String secretToAuthenticateInitiator()

      The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

      The secret key must be between 12 and 16 bytes when encoded in UTF-8.

      Returns:
      The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

      The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    • initiatorName

      public final String initiatorName()

      The iSCSI initiator that connects to the target.

      Returns:
      The iSCSI initiator that connects to the target.

    • secretToAuthenticateTarget

      public final String secretToAuthenticateTarget()

      The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

      Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

      The secret key must be between 12 and 16 bytes when encoded in UTF-8.

      Returns:
      The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

      Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

      The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    • toBuilder

      public UpdateChapCredentialsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateChapCredentialsRequest.Builder,UpdateChapCredentialsRequest>
      Specified by:
      toBuilder in class StorageGatewayRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateChapCredentialsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.