software.amazon.awssdk.services.connect.model.CreateUseCaseRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connect Show documentation
Show all versions of connect Show documentation
The AWS Java SDK for Connect module holds the client classes that are used for
communicating with Connect.
/*
* 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.Map;
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.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
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 CreateUseCaseRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(CreateUseCaseRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField INTEGRATION_ASSOCIATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IntegrationAssociationId").getter(getter(CreateUseCaseRequest::integrationAssociationId))
.setter(setter(Builder::integrationAssociationId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("IntegrationAssociationId").build())
.build();
private static final SdkField USE_CASE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UseCaseType").getter(getter(CreateUseCaseRequest::useCaseTypeAsString))
.setter(setter(Builder::useCaseType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UseCaseType").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateUseCaseRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
INTEGRATION_ASSOCIATION_ID_FIELD, USE_CASE_TYPE_FIELD, TAGS_FIELD));
private final String instanceId;
private final String integrationAssociationId;
private final String useCaseType;
private final Map tags;
private CreateUseCaseRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.integrationAssociationId = builder.integrationAssociationId;
this.useCaseType = builder.useCaseType;
this.tags = builder.tags;
}
/**
*
* 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 for the integration association.
*
*
* @return The identifier for the integration association.
*/
public final String integrationAssociationId() {
return integrationAssociationId;
}
/**
*
* The type of use case to associate to the integration association. Each integration association can have only one
* of each use case type.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #useCaseType} will
* return {@link UseCaseType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #useCaseTypeAsString}.
*
*
* @return The type of use case to associate to the integration association. Each integration association can have
* only one of each use case type.
* @see UseCaseType
*/
public final UseCaseType useCaseType() {
return UseCaseType.fromValue(useCaseType);
}
/**
*
* The type of use case to associate to the integration association. Each integration association can have only one
* of each use case type.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #useCaseType} will
* return {@link UseCaseType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #useCaseTypeAsString}.
*
*
* @return The type of use case to associate to the integration association. Each integration association can have
* only one of each use case type.
* @see UseCaseType
*/
public final String useCaseTypeAsString() {
return useCaseType;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
* "key2":"value2"} }.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
*/
public final Map tags() {
return tags;
}
@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(integrationAssociationId());
hashCode = 31 * hashCode + Objects.hashCode(useCaseTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreateUseCaseRequest)) {
return false;
}
CreateUseCaseRequest other = (CreateUseCaseRequest) obj;
return Objects.equals(instanceId(), other.instanceId())
&& Objects.equals(integrationAssociationId(), other.integrationAssociationId())
&& Objects.equals(useCaseTypeAsString(), other.useCaseTypeAsString()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateUseCaseRequest").add("InstanceId", instanceId())
.add("IntegrationAssociationId", integrationAssociationId()).add("UseCaseType", useCaseTypeAsString())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "IntegrationAssociationId":
return Optional.ofNullable(clazz.cast(integrationAssociationId()));
case "UseCaseType":
return Optional.ofNullable(clazz.cast(useCaseTypeAsString()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateUseCaseRequest) 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 for the integration association.
*
*
* @param integrationAssociationId
* The identifier for the integration association.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder integrationAssociationId(String integrationAssociationId);
/**
*
* The type of use case to associate to the integration association. Each integration association can have only
* one of each use case type.
*
*
* @param useCaseType
* The type of use case to associate to the integration association. Each integration association can
* have only one of each use case type.
* @see UseCaseType
* @return Returns a reference to this object so that method calls can be chained together.
* @see UseCaseType
*/
Builder useCaseType(String useCaseType);
/**
*
* The type of use case to associate to the integration association. Each integration association can have only
* one of each use case type.
*
*
* @param useCaseType
* The type of use case to associate to the integration association. Each integration association can
* have only one of each use case type.
* @see UseCaseType
* @return Returns a reference to this object so that method calls can be chained together.
* @see UseCaseType
*/
Builder useCaseType(UseCaseType useCaseType);
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private String integrationAssociationId;
private String useCaseType;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateUseCaseRequest model) {
super(model);
instanceId(model.instanceId);
integrationAssociationId(model.integrationAssociationId);
useCaseType(model.useCaseType);
tags(model.tags);
}
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 getIntegrationAssociationId() {
return integrationAssociationId;
}
public final void setIntegrationAssociationId(String integrationAssociationId) {
this.integrationAssociationId = integrationAssociationId;
}
@Override
public final Builder integrationAssociationId(String integrationAssociationId) {
this.integrationAssociationId = integrationAssociationId;
return this;
}
public final String getUseCaseType() {
return useCaseType;
}
public final void setUseCaseType(String useCaseType) {
this.useCaseType = useCaseType;
}
@Override
public final Builder useCaseType(String useCaseType) {
this.useCaseType = useCaseType;
return this;
}
@Override
public final Builder useCaseType(UseCaseType useCaseType) {
this.useCaseType(useCaseType == null ? null : useCaseType.toString());
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
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 CreateUseCaseRequest build() {
return new CreateUseCaseRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}