Class: Google::Cloud::StorageTransfer::V1::NotificationConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer_types.rb

Overview

Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following PubsubMessage.attributes:

  • "eventType": one of the EventType values
  • "payloadFormat": one of the PayloadFormat values
  • "projectId": the project_id of the TransferOperation
  • "transferJobName": the transfer_job_name of the TransferOperation
  • "transferOperationName": the name of the TransferOperation

The PubsubMessage.data contains a TransferOperation resource formatted according to the specified PayloadFormat.

Defined Under Namespace

Modules: EventType, PayloadFormat

Instance Attribute Summary collapse

Instance Attribute Details

#event_types ⇒ ::Array<::Google::Cloud::StorageTransfer::V1::NotificationConfig::EventType>

Returns Event types for which a notification is desired. If empty, send notifications for all event types.

Returns:



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1261

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum for specifying event types for which notifications are to be
  # published.
  #
  # Additional event types may be added in the future. Clients should either
  # safely ignore unrecognized event types or explicitly specify which event
  # types they are prepared to accept.
  module EventType
    # Illegal value, to avoid allowing a default.
    EVENT_TYPE_UNSPECIFIED = 0

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::SUCCESS SUCCESS}.
    TRANSFER_OPERATION_SUCCESS = 1

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::FAILED FAILED}.
    TRANSFER_OPERATION_FAILED = 2

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::ABORTED ABORTED}.
    TRANSFER_OPERATION_ABORTED = 3
  end

  # Enum for specifying the format of a notification message's payload.
  module PayloadFormat
    # Illegal value, to avoid allowing a default.
    PAYLOAD_FORMAT_UNSPECIFIED = 0

    # No payload is included with the notification.
    NONE = 1

    # `TransferOperation` is [formatted as a JSON
    # response](https://developers.google.com/protocol-buffers/docs/proto3#json),
    # in application/json.
    JSON = 2
  end
end

#payload_format ⇒ ::Google::Cloud::StorageTransfer::V1::NotificationConfig::PayloadFormat

Returns Required. The desired format of the notification message payloads.

Returns:



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1261

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum for specifying event types for which notifications are to be
  # published.
  #
  # Additional event types may be added in the future. Clients should either
  # safely ignore unrecognized event types or explicitly specify which event
  # types they are prepared to accept.
  module EventType
    # Illegal value, to avoid allowing a default.
    EVENT_TYPE_UNSPECIFIED = 0

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::SUCCESS SUCCESS}.
    TRANSFER_OPERATION_SUCCESS = 1

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::FAILED FAILED}.
    TRANSFER_OPERATION_FAILED = 2

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::ABORTED ABORTED}.
    TRANSFER_OPERATION_ABORTED = 3
  end

  # Enum for specifying the format of a notification message's payload.
  module PayloadFormat
    # Illegal value, to avoid allowing a default.
    PAYLOAD_FORMAT_UNSPECIFIED = 0

    # No payload is included with the notification.
    NONE = 1

    # `TransferOperation` is [formatted as a JSON
    # response](https://developers.google.com/protocol-buffers/docs/proto3#json),
    # in application/json.
    JSON = 2
  end
end

#pubsub_topic ⇒ ::String

Returns Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an INVALID_ARGUMENT error.

Returns:

  • (::String) —

    Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an INVALID_ARGUMENT error.



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1261

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum for specifying event types for which notifications are to be
  # published.
  #
  # Additional event types may be added in the future. Clients should either
  # safely ignore unrecognized event types or explicitly specify which event
  # types they are prepared to accept.
  module EventType
    # Illegal value, to avoid allowing a default.
    EVENT_TYPE_UNSPECIFIED = 0

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::SUCCESS SUCCESS}.
    TRANSFER_OPERATION_SUCCESS = 1

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::FAILED FAILED}.
    TRANSFER_OPERATION_FAILED = 2

    # `TransferOperation` completed with status
    # {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::ABORTED ABORTED}.
    TRANSFER_OPERATION_ABORTED = 3
  end

  # Enum for specifying the format of a notification message's payload.
  module PayloadFormat
    # Illegal value, to avoid allowing a default.
    PAYLOAD_FORMAT_UNSPECIFIED = 0

    # No payload is included with the notification.
    NONE = 1

    # `TransferOperation` is [formatted as a JSON
    # response](https://developers.google.com/protocol-buffers/docs/proto3#json),
    # in application/json.
    JSON = 2
  end
end