software.amazon.awssdk.services.storagegateway.model.DescribeChapCredentialsResponse Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.storagegateway.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A JSON object containing a .
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeChapCredentialsResponse extends StorageGatewayResponse implements
ToCopyableBuilder {
private static final SdkField> CHAP_CREDENTIALS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeChapCredentialsResponse::chapCredentials))
.setter(setter(Builder::chapCredentials))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChapCredentials").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ChapInfo::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CHAP_CREDENTIALS_FIELD));
private final List chapCredentials;
private DescribeChapCredentialsResponse(BuilderImpl builder) {
super(builder);
this.chapCredentials = 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.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return 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.
*
*
*/
public List chapCredentials() {
return chapCredentials;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(chapCredentials());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeChapCredentialsResponse)) {
return false;
}
DescribeChapCredentialsResponse other = (DescribeChapCredentialsResponse) obj;
return Objects.equals(chapCredentials(), other.chapCredentials());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("DescribeChapCredentialsResponse").add("ChapCredentials", chapCredentials()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ChapCredentials":
return Optional.ofNullable(clazz.cast(chapCredentials()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeChapCredentialsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends StorageGatewayResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder chapCredentials(Collection 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
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.
*
*
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #chapCredentials(List)}.
*
* @param chapCredentials
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #chapCredentials(List)
*/
Builder chapCredentials(Consumer... chapCredentials);
}
static final class BuilderImpl extends StorageGatewayResponse.BuilderImpl implements Builder {
private List chapCredentials = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeChapCredentialsResponse model) {
super(model);
chapCredentials(model.chapCredentials);
}
public final Collection getChapCredentials() {
return chapCredentials != null ? chapCredentials.stream().map(ChapInfo::toBuilder).collect(Collectors.toList())
: null;
}
@Override
public final Builder chapCredentials(Collection chapCredentials) {
this.chapCredentials = ChapCredentialsCopier.copy(chapCredentials);
return this;
}
@Override
@SafeVarargs
public final Builder chapCredentials(ChapInfo... chapCredentials) {
chapCredentials(Arrays.asList(chapCredentials));
return this;
}
@Override
@SafeVarargs
public final Builder chapCredentials(Consumer... chapCredentials) {
chapCredentials(Stream.of(chapCredentials).map(c -> ChapInfo.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setChapCredentials(Collection chapCredentials) {
this.chapCredentials = ChapCredentialsCopier.copyFromBuilder(chapCredentials);
}
@Override
public DescribeChapCredentialsResponse build() {
return new DescribeChapCredentialsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}