OperationMetadata

google.cloud.functions.v2alpha. OperationMetadata

Represents an OperationMetadata.

Constructor

new OperationMetadata(propertiesopt)

Constructs a new OperationMetadata.

Parameters:
Name Type Attributes Description
properties google.cloud.functions.v2alpha.IOperationMetadata <optional>

Properties to set

Implements:
  • IOperationMetadata

Members

apiVersion

OperationMetadata apiVersion.

cancelRequested

OperationMetadata cancelRequested.

createTime

OperationMetadata createTime.

endTime

OperationMetadata endTime.

requestResource

OperationMetadata requestResource.

stages

OperationMetadata stages.

statusDetail

OperationMetadata statusDetail.

target

OperationMetadata target.

verb

OperationMetadata verb.

Methods

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

Converts this OperationMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.functions.v2alpha.OperationMetadata}

Creates a new OperationMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.functions.v2alpha.IOperationMetadata <optional>

Properties to set

Returns:
Type Description
google.cloud.functions.v2alpha.OperationMetadata

OperationMetadata instance

(static) decode(reader, lengthopt) → {google.cloud.functions.v2alpha.OperationMetadata}

Decodes an OperationMetadata 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.functions.v2alpha.OperationMetadata

OperationMetadata

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.functions.v2alpha.OperationMetadata}

Decodes an OperationMetadata 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.functions.v2alpha.OperationMetadata

OperationMetadata

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

Parameters:
Name Type Attributes Description
message google.cloud.functions.v2alpha.IOperationMetadata

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

Parameters:
Name Type Attributes Description
message google.cloud.functions.v2alpha.IOperationMetadata

OperationMetadata 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.functions.v2alpha.OperationMetadata}

Creates an OperationMetadata 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.functions.v2alpha.OperationMetadata

OperationMetadata

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for OperationMetadata

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

Parameters:
Name Type Attributes Description
message google.cloud.functions.v2alpha.OperationMetadata

OperationMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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