AdminAction

google.spanner.executor.v1. AdminAction

Represents an AdminAction.

Constructor

new AdminAction(propertiesopt)

Constructs a new AdminAction.

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

Properties to set

Implements:
  • IAdminAction

Members

action

AdminAction action.

cancelOperation

AdminAction cancelOperation.

changeQuorumCloudDatabase

AdminAction changeQuorumCloudDatabase.

copyCloudBackup

AdminAction copyCloudBackup.

createCloudBackup

AdminAction createCloudBackup.

createCloudDatabase

AdminAction createCloudDatabase.

createCloudInstance

AdminAction createCloudInstance.

createUserInstanceConfig

AdminAction createUserInstanceConfig.

deleteCloudBackup

AdminAction deleteCloudBackup.

deleteCloudInstance

AdminAction deleteCloudInstance.

deleteUserInstanceConfig

AdminAction deleteUserInstanceConfig.

dropCloudDatabase

AdminAction dropCloudDatabase.

getCloudBackup

AdminAction getCloudBackup.

getCloudDatabase

AdminAction getCloudDatabase.

getCloudInstance

AdminAction getCloudInstance.

getCloudInstanceConfig

AdminAction getCloudInstanceConfig.

getOperation

AdminAction getOperation.

listCloudBackupOperations

AdminAction listCloudBackupOperations.

listCloudBackups

AdminAction listCloudBackups.

listCloudDatabaseOperations

AdminAction listCloudDatabaseOperations.

listCloudDatabases

AdminAction listCloudDatabases.

listCloudInstances

AdminAction listCloudInstances.

listInstanceConfigs

AdminAction listInstanceConfigs.

restoreCloudDatabase

AdminAction restoreCloudDatabase.

updateCloudBackup

AdminAction updateCloudBackup.

updateCloudDatabase

AdminAction updateCloudDatabase.

updateCloudDatabaseDdl

AdminAction updateCloudDatabaseDdl.

updateCloudInstance

AdminAction updateCloudInstance.

updateUserInstanceConfig

AdminAction updateUserInstanceConfig.

Methods

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

Converts this AdminAction to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new AdminAction instance using the specified properties.

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

Properties to set

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

AdminAction instance

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

Decodes an AdminAction 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.AdminAction

AdminAction

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.AdminAction}

Decodes an AdminAction 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.AdminAction

AdminAction

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

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

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

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

AdminAction 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.AdminAction}

Creates an AdminAction 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.AdminAction

AdminAction

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for AdminAction

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

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

AdminAction

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an AdminAction 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