software.amazon.awssdk.services.opensearchserverless.model.BatchGetCollectionRequest Maven / Gradle / Ivy
/*
* 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.opensearchserverless.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 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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 BatchGetCollectionRequest extends OpenSearchServerlessRequest implements
ToCopyableBuilder {
private static final SdkField> IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ids")
.getter(getter(BatchGetCollectionRequest::ids))
.setter(setter(Builder::ids))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ids").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("names")
.getter(getter(BatchGetCollectionRequest::names))
.setter(setter(Builder::names))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("names").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(IDS_FIELD, NAMES_FIELD));
private final List ids;
private final List names;
private BatchGetCollectionRequest(BuilderImpl builder) {
super(builder);
this.ids = builder.ids;
this.names = builder.names;
}
/**
* For responses, this returns true if the service returned a value for the Ids 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 hasIds() {
return ids != null && !(ids instanceof SdkAutoConstructList);
}
/**
*
* A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection
* endpoint. You can also retrieve it using the ListCollections API.
*
*
* 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 #hasIds} method.
*
*
* @return A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the
* collection endpoint. You can also retrieve it using the ListCollections API.
*/
public final List ids() {
return ids;
}
/**
* For responses, this returns true if the service returned a value for the Names 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 hasNames() {
return names != null && !(names instanceof SdkAutoConstructList);
}
/**
*
* A list of collection names. You can't provide names and IDs in the same request.
*
*
* 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 #hasNames} method.
*
*
* @return A list of collection names. You can't provide names and IDs in the same request.
*/
public final List names() {
return names;
}
@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(hasIds() ? ids() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasNames() ? names() : 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 BatchGetCollectionRequest)) {
return false;
}
BatchGetCollectionRequest other = (BatchGetCollectionRequest) obj;
return hasIds() == other.hasIds() && Objects.equals(ids(), other.ids()) && hasNames() == other.hasNames()
&& Objects.equals(names(), other.names());
}
/**
* 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("BatchGetCollectionRequest").add("Ids", hasIds() ? ids() : null)
.add("Names", hasNames() ? names() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ids":
return Optional.ofNullable(clazz.cast(ids()));
case "names":
return Optional.ofNullable(clazz.cast(names()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BatchGetCollectionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends OpenSearchServerlessRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the
* collection endpoint. You can also retrieve it using the ListCollections API.
*
*
* @param ids
* A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the
* collection endpoint. You can also retrieve it using the ListCollections API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ids(Collection ids);
/**
*
* A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the
* collection endpoint. You can also retrieve it using the ListCollections API.
*
*
* @param ids
* A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the
* collection endpoint. You can also retrieve it using the ListCollections API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ids(String... ids);
/**
*
* A list of collection names. You can't provide names and IDs in the same request.
*
*
* @param names
* A list of collection names. You can't provide names and IDs in the same request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder names(Collection names);
/**
*
* A list of collection names. You can't provide names and IDs in the same request.
*
*
* @param names
* A list of collection names. You can't provide names and IDs in the same request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder names(String... names);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends OpenSearchServerlessRequest.BuilderImpl implements Builder {
private List ids = DefaultSdkAutoConstructList.getInstance();
private List names = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BatchGetCollectionRequest model) {
super(model);
ids(model.ids);
names(model.names);
}
public final Collection getIds() {
if (ids instanceof SdkAutoConstructList) {
return null;
}
return ids;
}
public final void setIds(Collection ids) {
this.ids = CollectionIdsCopier.copy(ids);
}
@Override
public final Builder ids(Collection ids) {
this.ids = CollectionIdsCopier.copy(ids);
return this;
}
@Override
@SafeVarargs
public final Builder ids(String... ids) {
ids(Arrays.asList(ids));
return this;
}
public final Collection getNames() {
if (names instanceof SdkAutoConstructList) {
return null;
}
return names;
}
public final void setNames(Collection names) {
this.names = CollectionNamesCopier.copy(names);
}
@Override
public final Builder names(Collection names) {
this.names = CollectionNamesCopier.copy(names);
return this;
}
@Override
@SafeVarargs
public final Builder names(String... names) {
names(Arrays.asList(names));
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 BatchGetCollectionRequest build() {
return new BatchGetCollectionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy