SpannerAction

google.spanner.executor.v1. SpannerAction

Represents a SpannerAction.

Constructor

new SpannerAction(propertiesopt)

Constructs a new SpannerAction.

Parameters:
Name Type Attributes Description
properties google.spanner.executor.v1.ISpannerAction <optional>

Properties to set

Implements:
  • ISpannerAction

Members

action

SpannerAction action.

admin

SpannerAction admin.

batchDml

SpannerAction batchDml.

closeBatchTxn

SpannerAction closeBatchTxn.

databasePath

SpannerAction databasePath.

dml

SpannerAction dml.

executeChangeStreamQuery

SpannerAction executeChangeStreamQuery.

executePartition

SpannerAction executePartition.

finish

SpannerAction finish.

generateDbPartitionsQuery

SpannerAction generateDbPartitionsQuery.

generateDbPartitionsRead

SpannerAction generateDbPartitionsRead.

mutation

SpannerAction mutation.

partitionedUpdate

SpannerAction partitionedUpdate.

query

SpannerAction query.

read

SpannerAction read.

spannerOptions

SpannerAction spannerOptions.

start

SpannerAction start.

startBatchTxn

SpannerAction startBatchTxn.

write

SpannerAction write.

Methods

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

Converts this SpannerAction to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.spanner.executor.v1.SpannerAction}

Creates a new SpannerAction instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.spanner.executor.v1.ISpannerAction <optional>

Properties to set

Returns:
Type Description
google.spanner.executor.v1.SpannerAction

SpannerAction instance

(static) decode(reader, lengthopt) → {google.spanner.executor.v1.SpannerAction}

Decodes a SpannerAction 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.spanner.executor.v1.SpannerAction

SpannerAction

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.spanner.executor.v1.SpannerAction}

Decodes a SpannerAction 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.spanner.executor.v1.SpannerAction

SpannerAction

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 SpannerAction message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.executor.v1.ISpannerAction

SpannerAction 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 SpannerAction message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.executor.v1.ISpannerAction

SpannerAction message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.spanner.executor.v1.SpannerAction}

Creates a SpannerAction 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.spanner.executor.v1.SpannerAction

SpannerAction

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for SpannerAction

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 SpannerAction message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.spanner.executor.v1.SpannerAction

SpannerAction

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a SpannerAction 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