CommonMetadata

google.datastore.admin.v1. CommonMetadata

Represents a CommonMetadata.

Constructor

new CommonMetadata(propertiesopt)

Constructs a new CommonMetadata.

Parameters:
Name Type Attributes Description
properties google.datastore.admin.v1.ICommonMetadata <optional>

Properties to set

Implements:
  • ICommonMetadata

Members

(static) State :number

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

INITIALIZING number

INITIALIZING value

PROCESSING number

PROCESSING value

CANCELLING number

CANCELLING value

FINALIZING number

FINALIZING value

SUCCESSFUL number

SUCCESSFUL value

FAILED number

FAILED value

CANCELLED number

CANCELLED value

endTime :google.protobuf.ITimestamp|null|undefined

CommonMetadata endTime.

labels :Object.<string, string>

CommonMetadata labels.

operationType :google.datastore.admin.v1.OperationType

CommonMetadata operationType.

startTime :google.protobuf.ITimestamp|null|undefined

CommonMetadata startTime.

state :google.datastore.admin.v1.CommonMetadata.State

CommonMetadata state.

Methods

(static) create(propertiesopt) → {google.datastore.admin.v1.CommonMetadata}

Creates a new CommonMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.datastore.admin.v1.ICommonMetadata <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.datastore.admin.v1.CommonMetadata}

Decodes a CommonMetadata 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

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.datastore.admin.v1.CommonMetadata}

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

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

Reader or buffer to decode from

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

Parameters:
Name Type Attributes Description
message google.datastore.admin.v1.ICommonMetadata

CommonMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

Parameters:
Name Type Attributes Description
message google.datastore.admin.v1.ICommonMetadata

CommonMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.datastore.admin.v1.CommonMetadata}

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

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

Plain object

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

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

Parameters:
Name Type Attributes Description
message google.datastore.admin.v1.CommonMetadata

CommonMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a CommonMetadata message.

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

Plain object to verify

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

Converts this CommonMetadata to JSON.