com.amazonaws.services.opensearchserverless.model

Class BatchGetCollectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opensearchserverless.model.BatchGetCollectionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchGetCollectionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchGetCollectionRequest()

Method Summary

Modifier and Type	Method and Description
BatchGetCollectionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getIds() A list of collection IDs.
List<String>	getNames() A list of collection names.
int	hashCode()
void	setIds(Collection<String> ids) A list of collection IDs.
void	setNames(Collection<String> names) A list of collection names.
String	toString() Returns a string representation of this object.
BatchGetCollectionRequest	withIds(Collection<String> ids) A list of collection IDs.
BatchGetCollectionRequest	withIds(String... ids) A list of collection IDs.
BatchGetCollectionRequest	withNames(Collection<String> names) A list of collection names.
BatchGetCollectionRequest	withNames(String... names) A list of collection names.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchGetCollectionRequest

public BatchGetCollectionRequest()

Method Detail

getIds

public List<String> getIds()

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.

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.

setIds

public void setIds(Collection<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.

Parameters:

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.

withIds

public BatchGetCollectionRequest withIds(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.

NOTE: This method appends the values to the existing list (if any). Use setIds(java.util.Collection) or withIds(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withIds

public BatchGetCollectionRequest withIds(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getNames

public List<String> getNames()

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

Returns:

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

setNames

public void setNames(Collection<String> names)

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

Parameters:

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

withNames

public BatchGetCollectionRequest withNames(String... names)

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

NOTE: This method appends the values to the existing list (if any). Use setNames(java.util.Collection) or withNames(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withNames

public BatchGetCollectionRequest withNames(Collection<String> names)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchGetCollectionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()