PartitionOptions

google.spanner.v1. PartitionOptions

Represents a PartitionOptions.

Constructor

new PartitionOptions(propertiesopt)

Constructs a new PartitionOptions.

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

Properties to set

Implements:
  • IPartitionOptions

Members

maxPartitions

PartitionOptions maxPartitions.

partitionSizeBytes

PartitionOptions partitionSizeBytes.

Methods

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

Converts this PartitionOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new PartitionOptions instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.spanner.v1.PartitionOptions

PartitionOptions instance

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

Decodes a PartitionOptions 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.v1.PartitionOptions

PartitionOptions

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.v1.PartitionOptions}

Decodes a PartitionOptions 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.v1.PartitionOptions

PartitionOptions

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

Parameters:
Name Type Attributes Description
message google.spanner.v1.IPartitionOptions

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

Parameters:
Name Type Attributes Description
message google.spanner.v1.IPartitionOptions

PartitionOptions 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.v1.PartitionOptions}

Creates a PartitionOptions 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.v1.PartitionOptions

PartitionOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for PartitionOptions

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

Parameters:
Name Type Attributes Description
message google.spanner.v1.PartitionOptions

PartitionOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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