StorageError

google.cloud.bigquery.storage.v1. StorageError

Represents a StorageError.

Constructor

new StorageError(propertiesopt)

Constructs a new StorageError.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.storage.v1.IStorageError <optional>

Properties to set

Implements:
  • IStorageError

Members

code

StorageError code.

entity

StorageError entity.

errorMessage

StorageError errorMessage.

StorageErrorCode

StorageErrorCode enum.

Properties:
Name Type Description
STORAGE_ERROR_CODE_UNSPECIFIED number

STORAGE_ERROR_CODE_UNSPECIFIED value

TABLE_NOT_FOUND number

TABLE_NOT_FOUND value

STREAM_ALREADY_COMMITTED number

STREAM_ALREADY_COMMITTED value

STREAM_NOT_FOUND number

STREAM_NOT_FOUND value

INVALID_STREAM_TYPE number

INVALID_STREAM_TYPE value

INVALID_STREAM_STATE number

INVALID_STREAM_STATE value

STREAM_FINALIZED number

STREAM_FINALIZED value

SCHEMA_MISMATCH_EXTRA_FIELDS number

SCHEMA_MISMATCH_EXTRA_FIELDS value

OFFSET_ALREADY_EXISTS number

OFFSET_ALREADY_EXISTS value

OFFSET_OUT_OF_RANGE number

OFFSET_OUT_OF_RANGE value

CMEK_NOT_PROVIDED number

CMEK_NOT_PROVIDED value

INVALID_CMEK_PROVIDED number

INVALID_CMEK_PROVIDED value

CMEK_ENCRYPTION_ERROR number

CMEK_ENCRYPTION_ERROR value

KMS_SERVICE_ERROR number

KMS_SERVICE_ERROR value

KMS_PERMISSION_DENIED number

KMS_PERMISSION_DENIED value

Methods

toJSON() → {Object.<string, *>}

Converts this StorageError to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.bigquery.storage.v1.StorageError}

Creates a new StorageError instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.storage.v1.IStorageError <optional>

Properties to set

Returns:
Type Description
google.cloud.bigquery.storage.v1.StorageError

StorageError instance

(static) decode(reader, lengthopt) → {google.cloud.bigquery.storage.v1.StorageError}

Decodes a StorageError message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.bigquery.storage.v1.StorageError

StorageError

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.bigquery.storage.v1.StorageError}

Decodes a StorageError message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.bigquery.storage.v1.StorageError

StorageError

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified StorageError message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.storage.v1.IStorageError

StorageError message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified StorageError message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.storage.v1.IStorageError

StorageError message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.bigquery.storage.v1.StorageError}

Creates a StorageError message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.bigquery.storage.v1.StorageError

StorageError

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for StorageError

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a StorageError message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.storage.v1.StorageError

StorageError

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a StorageError message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not