software.amazon.awssdk.services.connect.model.CreateParticipantRequest Maven / Gradle / Ivy
Show all versions of connect Show documentation
/*
* Copyright 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.connect.model;
import java.util.Arrays;
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 software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.DefaultValueTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateParticipantRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(CreateParticipantRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceId").build()).build();
private static final SdkField CONTACT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ContactId").getter(getter(CreateParticipantRequest::contactId)).setter(setter(Builder::contactId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContactId").build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientToken")
.getter(getter(CreateParticipantRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField PARTICIPANT_DETAILS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ParticipantDetails")
.getter(getter(CreateParticipantRequest::participantDetails)).setter(setter(Builder::participantDetails))
.constructor(ParticipantDetailsToAdd::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParticipantDetails").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
CONTACT_ID_FIELD, CLIENT_TOKEN_FIELD, PARTICIPANT_DETAILS_FIELD));
private final String instanceId;
private final String contactId;
private final String clientToken;
private final ParticipantDetailsToAdd participantDetails;
private CreateParticipantRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.contactId = builder.contactId;
this.clientToken = builder.clientToken;
this.participantDetails = builder.participantDetails;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are
* supported.
*
*
* @return The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are
* supported.
*/
public final String contactId() {
return contactId;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see
* Making
* retries safe with idempotent APIs.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* Information identifying the participant.
*
*
*
* The only Valid value for ParticipantRole is CUSTOM_BOT.
*
*
* DisplayName is Required.
*
*
*
* @return Information identifying the participant.
*
* The only Valid value for ParticipantRole is CUSTOM_BOT.
*
*
* DisplayName is Required.
*
*/
public final ParticipantDetailsToAdd participantDetails() {
return participantDetails;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(contactId());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(participantDetails());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateParticipantRequest)) {
return false;
}
CreateParticipantRequest other = (CreateParticipantRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(contactId(), other.contactId())
&& Objects.equals(clientToken(), other.clientToken())
&& Objects.equals(participantDetails(), other.participantDetails());
}
/**
* 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 final String toString() {
return ToString.builder("CreateParticipantRequest").add("InstanceId", instanceId()).add("ContactId", contactId())
.add("ClientToken", clientToken()).add("ParticipantDetails", participantDetails()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "ContactId":
return Optional.ofNullable(clazz.cast(contactId()));
case "ClientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "ParticipantDetails":
return Optional.ofNullable(clazz.cast(participantDetails()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateParticipantRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are
* supported.
*
*
* @param contactId
* The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel
* are supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contactId(String contactId);
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe
* with idempotent APIs.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency,
* see Making
* retries safe with idempotent APIs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* Information identifying the participant.
*
*
*
* The only Valid value for ParticipantRole is CUSTOM_BOT.
*
*
* DisplayName is Required.
*
*
*
* @param participantDetails
* Information identifying the participant.
*
* The only Valid value for ParticipantRole is CUSTOM_BOT.
*
*
* DisplayName is Required.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder participantDetails(ParticipantDetailsToAdd participantDetails);
/**
*
* Information identifying the participant.
*
*
*
* The only Valid value for ParticipantRole is CUSTOM_BOT.
*
*
* DisplayName is Required.
*
* This is a convenience method that creates an instance of the
* {@link ParticipantDetailsToAdd.Builder} avoiding the need to create one manually via
* {@link ParticipantDetailsToAdd#builder()}.
*
*
* When the {@link Consumer} completes, {@link ParticipantDetailsToAdd.Builder#build()} is called immediately
* and its result is passed to {@link #participantDetails(ParticipantDetailsToAdd)}.
*
* @param participantDetails
* a consumer that will call methods on {@link ParticipantDetailsToAdd.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #participantDetails(ParticipantDetailsToAdd)
*/
default Builder participantDetails(Consumer participantDetails) {
return participantDetails(ParticipantDetailsToAdd.builder().applyMutation(participantDetails).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private String contactId;
private String clientToken;
private ParticipantDetailsToAdd participantDetails;
private BuilderImpl() {
}
private BuilderImpl(CreateParticipantRequest model) {
super(model);
instanceId(model.instanceId);
contactId(model.contactId);
clientToken(model.clientToken);
participantDetails(model.participantDetails);
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
public final String getContactId() {
return contactId;
}
public final void setContactId(String contactId) {
this.contactId = contactId;
}
@Override
public final Builder contactId(String contactId) {
this.contactId = contactId;
return this;
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final ParticipantDetailsToAdd.Builder getParticipantDetails() {
return participantDetails != null ? participantDetails.toBuilder() : null;
}
public final void setParticipantDetails(ParticipantDetailsToAdd.BuilderImpl participantDetails) {
this.participantDetails = participantDetails != null ? participantDetails.build() : null;
}
@Override
public final Builder participantDetails(ParticipantDetailsToAdd participantDetails) {
this.participantDetails = participantDetails;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateParticipantRequest build() {
return new CreateParticipantRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}