com.amazonaws.services.opensearchserverless.model

Class CollectionErrorDetail

java.lang.Object

com.amazonaws.services.opensearchserverless.model.CollectionErrorDetail

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Error information for an OpenSearch Serverless request.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollectionErrorDetail()

Method Summary

Modifier and Type	Method and Description
CollectionErrorDetail	clone()
boolean	equals(Object obj)
String	getErrorCode() The error code for the request.
String	getErrorMessage() A description of the error.
String	getId() If the request contains collection IDs, the response includes the IDs provided in the request.
String	getName() If the request contains collection names, the response includes the names provided in the request.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setErrorCode(String errorCode) The error code for the request.
void	setErrorMessage(String errorMessage) A description of the error.
void	setId(String id) If the request contains collection IDs, the response includes the IDs provided in the request.
void	setName(String name) If the request contains collection names, the response includes the names provided in the request.
String	toString() Returns a string representation of this object.
CollectionErrorDetail	withErrorCode(String errorCode) The error code for the request.
CollectionErrorDetail	withErrorMessage(String errorMessage) A description of the error.
CollectionErrorDetail	withId(String id) If the request contains collection IDs, the response includes the IDs provided in the request.
CollectionErrorDetail	withName(String name) If the request contains collection names, the response includes the names provided in the request.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CollectionErrorDetail

public CollectionErrorDetail()

Method Detail

setErrorCode

public void setErrorCode(String errorCode)

The error code for the request. For example, NOT_FOUND.

Parameters:

errorCode - The error code for the request. For example, NOT_FOUND.

getErrorCode

public String getErrorCode()

The error code for the request. For example, NOT_FOUND.

Returns:

The error code for the request. For example, NOT_FOUND.

withErrorCode

public CollectionErrorDetail withErrorCode(String errorCode)

The error code for the request. For example, NOT_FOUND.

Parameters:

errorCode - The error code for the request. For example, NOT_FOUND.

Returns:

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

setErrorMessage

public void setErrorMessage(String errorMessage)

A description of the error. For example, The specified Collection is not found.

Parameters:

errorMessage - A description of the error. For example, The specified Collection is not found.

getErrorMessage

public String getErrorMessage()

A description of the error. For example, The specified Collection is not found.

Returns:

A description of the error. For example, The specified Collection is not found.

withErrorMessage

public CollectionErrorDetail withErrorMessage(String errorMessage)

A description of the error. For example, The specified Collection is not found.

Parameters:

errorMessage - A description of the error. For example, The specified Collection is not found.

Returns:

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

setId

public void setId(String id)

If the request contains collection IDs, the response includes the IDs provided in the request.

Parameters:

id - If the request contains collection IDs, the response includes the IDs provided in the request.

getId

public String getId()

If the request contains collection IDs, the response includes the IDs provided in the request.

Returns:

If the request contains collection IDs, the response includes the IDs provided in the request.

withId

public CollectionErrorDetail withId(String id)

If the request contains collection IDs, the response includes the IDs provided in the request.

Parameters:

id - If the request contains collection IDs, the response includes the IDs provided in the request.

Returns:

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

setName

public void setName(String name)

If the request contains collection names, the response includes the names provided in the request.

Parameters:

name - If the request contains collection names, the response includes the names provided in the request.

getName

public String getName()

If the request contains collection names, the response includes the names provided in the request.

Returns:

If the request contains collection names, the response includes the names provided in the request.

withName

public CollectionErrorDetail withName(String name)

If the request contains collection names, the response includes the names provided in the request.

Parameters:

name - If the request contains collection names, the response includes the names provided in the 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 CollectionErrorDetail clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.