com.google.cloud.firestore

Class BulkWriterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.google.cloud.BaseServiceException

com.google.cloud.grpc.BaseGrpcServiceException

com.google.cloud.firestore.FirestoreException

com.google.cloud.firestore.BulkWriterException

All Implemented Interfaces:

Serializable

@BetaApi
public final class BulkWriterException
extends FirestoreException

The error thrown when a BulkWriter operation fails.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.BaseServiceException

com.google.cloud.BaseServiceException.Error, com.google.cloud.BaseServiceException.ExceptionData

Field Summary

Fields inherited from class com.google.cloud.BaseServiceException

UNKNOWN_CODE

Constructor Summary

Constructors

Constructor and Description
BulkWriterException(io.grpc.Status status, String message, DocumentReference documentReference, com.google.cloud.firestore.BulkWriter.OperationType operationType, int failedAttempts)

Method Summary

Modifier and Type	Method and Description
DocumentReference	getDocumentReference()
int	getFailedAttempts()
String	getMessage()
com.google.cloud.firestore.BulkWriter.OperationType	getOperationType()
io.grpc.Status	getStatus()

Methods inherited from class com.google.cloud.firestore.FirestoreException

forApiException, forApiException, forInvalidArgument, forIOException, forServerRejection, forServerRejection

Methods inherited from class com.google.cloud.BaseServiceException

equals, getCode, getDebugInfo, getLocation, getReason, hashCode, isRetryable, isRetryable, isRetryable, translate, translate

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkWriterException

public BulkWriterException(io.grpc.Status status,
                           String message,
                           DocumentReference documentReference,
                           com.google.cloud.firestore.BulkWriter.OperationType operationType,
                           int failedAttempts)

Method Detail

getStatus

public io.grpc.Status getStatus()

Overrides:

getStatus in class FirestoreException

Returns:

The status code of the error.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

Returns:

The error message of the error.

getDocumentReference

public DocumentReference getDocumentReference()

Returns:

The DocumentReference the operation was performed on.

getOperationType

public com.google.cloud.firestore.BulkWriter.OperationType getOperationType()

Returns:

The type of operation performed.

getFailedAttempts

public int getFailedAttempts()

Returns:

How many times this operation has been attempted unsuccessfully.