Class: Google::Cloud::Bigquery::Storage::V1::StorageError

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/storage/v1/storage.rb

Overview

Structured custom BigQuery Storage error message. The error can be attached as error details in the returned rpc Status. In particular, the use of error codes allows more structured error handling, and reduces the need to evaluate unstructured error text strings.

Defined Under Namespace

Modules: StorageErrorCode

Instance Attribute Summary collapse

Instance Attribute Details

#code ⇒ ::Google::Cloud::Bigquery::Storage::V1::StorageError::StorageErrorCode

Returns BigQuery Storage specific error code.

Returns:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/storage.rb', line 519

class StorageError
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Error code for `StorageError`.
  module StorageErrorCode
    # Default error.
    STORAGE_ERROR_CODE_UNSPECIFIED = 0

    # Table is not found in the system.
    TABLE_NOT_FOUND = 1

    # Stream is already committed.
    STREAM_ALREADY_COMMITTED = 2

    # Stream is not found.
    STREAM_NOT_FOUND = 3

    # Invalid Stream type.
    # For example, you try to commit a stream that is not pending.
    INVALID_STREAM_TYPE = 4

    # Invalid Stream state.
    # For example, you try to commit a stream that is not finalized or is
    # garbaged.
    INVALID_STREAM_STATE = 5

    # Stream is finalized.
    STREAM_FINALIZED = 6

    # There is a schema mismatch and it is caused by user schema has extra
    # field than bigquery schema.
    SCHEMA_MISMATCH_EXTRA_FIELDS = 7

    # Offset already exists.
    OFFSET_ALREADY_EXISTS = 8

    # Offset out of range.
    OFFSET_OUT_OF_RANGE = 9

    # Customer-managed encryption key (CMEK) not provided for CMEK-enabled
    # data.
    CMEK_NOT_PROVIDED = 10

    # Customer-managed encryption key (CMEK) was incorrectly provided.
    INVALID_CMEK_PROVIDED = 11

    # There is an encryption error while using customer-managed encryption key.
    CMEK_ENCRYPTION_ERROR = 12

    # Key Management Service (KMS) service returned an error, which can be
    # retried.
    KMS_SERVICE_ERROR = 13

    # Permission denied while using customer-managed encryption key.
    KMS_PERMISSION_DENIED = 14
  end
end

#entity ⇒ ::String

Returns Name of the failed entity.

Returns:

  • (::String) —

    Name of the failed entity.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/storage.rb', line 519

class StorageError
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Error code for `StorageError`.
  module StorageErrorCode
    # Default error.
    STORAGE_ERROR_CODE_UNSPECIFIED = 0

    # Table is not found in the system.
    TABLE_NOT_FOUND = 1

    # Stream is already committed.
    STREAM_ALREADY_COMMITTED = 2

    # Stream is not found.
    STREAM_NOT_FOUND = 3

    # Invalid Stream type.
    # For example, you try to commit a stream that is not pending.
    INVALID_STREAM_TYPE = 4

    # Invalid Stream state.
    # For example, you try to commit a stream that is not finalized or is
    # garbaged.
    INVALID_STREAM_STATE = 5

    # Stream is finalized.
    STREAM_FINALIZED = 6

    # There is a schema mismatch and it is caused by user schema has extra
    # field than bigquery schema.
    SCHEMA_MISMATCH_EXTRA_FIELDS = 7

    # Offset already exists.
    OFFSET_ALREADY_EXISTS = 8

    # Offset out of range.
    OFFSET_OUT_OF_RANGE = 9

    # Customer-managed encryption key (CMEK) not provided for CMEK-enabled
    # data.
    CMEK_NOT_PROVIDED = 10

    # Customer-managed encryption key (CMEK) was incorrectly provided.
    INVALID_CMEK_PROVIDED = 11

    # There is an encryption error while using customer-managed encryption key.
    CMEK_ENCRYPTION_ERROR = 12

    # Key Management Service (KMS) service returned an error, which can be
    # retried.
    KMS_SERVICE_ERROR = 13

    # Permission denied while using customer-managed encryption key.
    KMS_PERMISSION_DENIED = 14
  end
end

#error_message ⇒ ::String

Returns Message that describes the error.

Returns:

  • (::String) —

    Message that describes the error.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/storage.rb', line 519

class StorageError
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Error code for `StorageError`.
  module StorageErrorCode
    # Default error.
    STORAGE_ERROR_CODE_UNSPECIFIED = 0

    # Table is not found in the system.
    TABLE_NOT_FOUND = 1

    # Stream is already committed.
    STREAM_ALREADY_COMMITTED = 2

    # Stream is not found.
    STREAM_NOT_FOUND = 3

    # Invalid Stream type.
    # For example, you try to commit a stream that is not pending.
    INVALID_STREAM_TYPE = 4

    # Invalid Stream state.
    # For example, you try to commit a stream that is not finalized or is
    # garbaged.
    INVALID_STREAM_STATE = 5

    # Stream is finalized.
    STREAM_FINALIZED = 6

    # There is a schema mismatch and it is caused by user schema has extra
    # field than bigquery schema.
    SCHEMA_MISMATCH_EXTRA_FIELDS = 7

    # Offset already exists.
    OFFSET_ALREADY_EXISTS = 8

    # Offset out of range.
    OFFSET_OUT_OF_RANGE = 9

    # Customer-managed encryption key (CMEK) not provided for CMEK-enabled
    # data.
    CMEK_NOT_PROVIDED = 10

    # Customer-managed encryption key (CMEK) was incorrectly provided.
    INVALID_CMEK_PROVIDED = 11

    # There is an encryption error while using customer-managed encryption key.
    CMEK_ENCRYPTION_ERROR = 12

    # Key Management Service (KMS) service returned an error, which can be
    # retried.
    KMS_SERVICE_ERROR = 13

    # Permission denied while using customer-managed encryption key.
    KMS_PERMISSION_DENIED = 14
  end
end