NotificationConfig

google.storagetransfer.v1. NotificationConfig

Represents a NotificationConfig.

Constructor

new NotificationConfig(propertiesopt)

Constructs a new NotificationConfig.

Parameters:
Name Type Attributes Description
properties google.storagetransfer.v1.INotificationConfig <optional>

Properties to set

Implements:
  • INotificationConfig

Members

EventType

EventType enum.

Properties:
Name Type Description
EVENT_TYPE_UNSPECIFIED number

EVENT_TYPE_UNSPECIFIED value

TRANSFER_OPERATION_SUCCESS number

TRANSFER_OPERATION_SUCCESS value

TRANSFER_OPERATION_FAILED number

TRANSFER_OPERATION_FAILED value

TRANSFER_OPERATION_ABORTED number

TRANSFER_OPERATION_ABORTED value

PayloadFormat

PayloadFormat enum.

Properties:
Name Type Description
PAYLOAD_FORMAT_UNSPECIFIED number

PAYLOAD_FORMAT_UNSPECIFIED value

NONE number

NONE value

JSON number

JSON value

eventTypes

NotificationConfig eventTypes.

payloadFormat

NotificationConfig payloadFormat.

pubsubTopic

NotificationConfig pubsubTopic.

Methods

(static) create(propertiesopt) → {google.storagetransfer.v1.NotificationConfig}

Creates a new NotificationConfig instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.storagetransfer.v1.INotificationConfig <optional>

Properties to set

Returns:
Type Description
google.storagetransfer.v1.NotificationConfig

NotificationConfig instance

(static) decode(reader, lengthopt) → {google.storagetransfer.v1.NotificationConfig}

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

NotificationConfig

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.storagetransfer.v1.NotificationConfig}

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

NotificationConfig

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

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.INotificationConfig

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

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.INotificationConfig

NotificationConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.storagetransfer.v1.NotificationConfig}

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

NotificationConfig

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

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

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.NotificationConfig

NotificationConfig

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

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

Converts this NotificationConfig to JSON.

Returns:
Type Description
Object.<string, *>

JSON object