Send feedback
  
   
 
  
    
      Class Error (1.63.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 1.63.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  Error   extends   GeneratedMessageV3   implements   ErrorOrBuilder  
   
   Represent a user-facing Error.
 Protobuf type google.cloud.datastream.v1.Error
 
  
  
  
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  DETAILS_FIELD_NUMBER 
  
    
public   static   final   int   DETAILS_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  ERROR_TIME_FIELD_NUMBER 
  
    
public   static   final   int   ERROR_TIME_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  ERROR_UUID_FIELD_NUMBER 
  
    
public   static   final   int   ERROR_UUID_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  MESSAGE_FIELD_NUMBER 
  
    
public   static   final   int   MESSAGE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  REASON_FIELD_NUMBER 
  
    
public   static   final   int   REASON_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   Error   getDefaultInstance ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  newBuilder() 
  
    
public   static   Error . Builder   newBuilder ()  
   
  
   
  newBuilder(Error prototype) 
  
    
public   static   Error . Builder   newBuilder ( Error   prototype )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        prototype 
        Error  
       
     
  
  
   
  
  
    
public   static   Error   parseDelimitedFrom ( InputStream   input )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  
  
    
public   static   Error   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  parseFrom(byte[] data) 
  
    
public   static   Error   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Error   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  parseFrom(ByteString data) 
  
    
public   static   Error   parseFrom ( ByteString   data )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Error   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  
  
    
public   static   Error   parseFrom ( CodedInputStream   input )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  
  
    
public   static   Error   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  
  
    
public   static   Error   parseFrom ( InputStream   input )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  
  
    
public   static   Error   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   Error   parseFrom ( ByteBuffer   data )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Error   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
  
   
  parser() 
  
    
public   static   Parser<Error>   parser ()  
   
  
  Methods
   
   
  containsDetails(String key) 
  
    
public   boolean   containsDetails ( String   key )  
   
   Additional information about the error.
 map<string, string> details = 5;
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        key 
        String  
       
     
  
  
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  getDefaultInstanceForType() 
  
    
public   Error   getDefaultInstanceForType ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Error  
         
       
     
  
   
  getDetails() (deprecated) 
  
    
public   Map<String , String >  getDetails ()  
   
  
  
   
  getDetailsCount() 
  
    
public   int   getDetailsCount ()  
   
   Additional information about the error.
 map<string, string> details = 5;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
   
  getDetailsMap() 
  
    
public   Map<String , String >  getDetailsMap ()  
   
   Additional information about the error.
 map<string, string> details = 5;
 
  
   
  getDetailsOrDefault(String key, String defaultValue) 
  
    
public   String   getDetailsOrDefault ( String   key ,   String   defaultValue )  
   
   Additional information about the error.
 map<string, string> details = 5;
 
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
         
       
     
  
   
  getDetailsOrThrow(String key) 
  
    
public   String   getDetailsOrThrow ( String   key )  
   
   Additional information about the error.
 map<string, string> details = 5;
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        key 
        String  
       
     
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
         
       
     
  
   
  getErrorTime() 
  
    
public   Timestamp   getErrorTime ()  
   
   The time when the error occurred.
 .google.protobuf.Timestamp error_time = 4;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Timestamp  
        The errorTime.
 
       
     
  
   
  getErrorTimeOrBuilder() 
  
    
public   TimestampOrBuilder   getErrorTimeOrBuilder ()  
   
   The time when the error occurred.
 .google.protobuf.Timestamp error_time = 4;
 
  
   
  getErrorUuid() 
  
    
public   String   getErrorUuid ()  
   
   A unique identifier for this specific error,
 allowing it to be traced throughout the system in logs and API responses.
 string error_uuid = 2;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The errorUuid.
 
       
     
  
   
  getErrorUuidBytes() 
  
    
public   ByteString   getErrorUuidBytes ()  
   
   A unique identifier for this specific error,
 allowing it to be traced throughout the system in logs and API responses.
 string error_uuid = 2;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for errorUuid.
 
       
     
  
   
  getMessage() 
  
    
public   String   getMessage ()  
   
   A message containing more information about the error that occurred.
 string message = 3;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The message.
 
       
     
  
   
  getMessageBytes() 
  
    
public   ByteString   getMessageBytes ()  
   
   A message containing more information about the error that occurred.
 string message = 3;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for message.
 
       
     
  
   
  getParserForType() 
  
    
public   Parser<Error>   getParserForType ()  
   
  
  Overrides 
  
   
  getReason() 
  
    
public   String   getReason ()  
   
   A title that explains the reason for the error.
 string reason = 1;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The reason.
 
       
     
  
   
  getReasonBytes() 
  
    
public   ByteString   getReasonBytes ()  
   
   A title that explains the reason for the error.
 string reason = 1;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for reason.
 
       
     
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  hasErrorTime() 
  
    
public   boolean   hasErrorTime ()  
   
   The time when the error occurred.
 .google.protobuf.Timestamp error_time = 4;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the errorTime field is set.
 
       
     
  
   
  hashCode() 
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  internalGetMapFieldReflection(int number) 
  
    
protected   MapFieldReflectionAccessor   internalGetMapFieldReflection ( int   number )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        number 
        int  
       
     
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        com.google.protobuf.MapFieldReflectionAccessor  
         
       
     
  
  Overrides 
  com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   Error . Builder   newBuilderForType ()  
   
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   Error . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  toBuilder() 
  
    
public   Error . Builder   toBuilder ()  
   
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-30 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]