Package software.amazon.awssdk.services.opensearchserverless.model

Class BatchGetCollectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest

software.amazon.awssdk.services.opensearchserverless.model.BatchGetCollectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetCollectionRequest.Builder,BatchGetCollectionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class BatchGetCollectionRequest
extends OpenSearchServerlessRequest
implements ToCopyableBuilder<BatchGetCollectionRequest.Builder,BatchGetCollectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchGetCollectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BatchGetCollectionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIds()	For responses, this returns true if the service returned a value for the Ids property.
boolean	hasNames()	For responses, this returns true if the service returned a value for the Names property.
List<String>	ids()	A list of collection IDs.
List<String>	names()	A list of collection names.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends BatchGetCollectionRequest.Builder>	serializableBuilderClass()
BatchGetCollectionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasIds

public final boolean hasIds()

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 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.

ids

public final List<String> 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.

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 hasIds() method.

Returns:

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.

hasNames

public final boolean hasNames()

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 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.

names

public final List<String> names()

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 hasNames() method.

Returns:

A list of collection names. You can't provide names and IDs in the same request.

toBuilder

public BatchGetCollectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetCollectionRequest.Builder,BatchGetCollectionRequest>

Specified by:

toBuilder in class OpenSearchServerlessRequest

builder

public static BatchGetCollectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchGetCollectionRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo