Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::NotificationConfig (v0.4.0)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::NotificationConfig.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#event_types

def event_types() -> ::Array<::Google::Cloud::StorageTransfer::V1::NotificationConfig::EventType>

Returns

(::Array<::Google::Cloud::StorageTransfer::V1::NotificationConfig::EventType>) — Event types for which a notification is desired. If empty, send notifications for all event types.

#event_types=

def event_types=(value) -> ::Array<::Google::Cloud::StorageTransfer::V1::NotificationConfig::EventType>

Parameter

value (::Array<::Google::Cloud::StorageTransfer::V1::NotificationConfig::EventType>) — Event types for which a notification is desired. If empty, send notifications for all event types.

Returns

(::Array<::Google::Cloud::StorageTransfer::V1::NotificationConfig::EventType>) — Event types for which a notification is desired. If empty, send notifications for all event types.

#payload_format

def payload_format() -> ::Google::Cloud::StorageTransfer::V1::NotificationConfig::PayloadFormat

Returns

(::Google::Cloud::StorageTransfer::V1::NotificationConfig::PayloadFormat) — Required. The desired format of the notification message payloads.

#payload_format=

def payload_format=(value) -> ::Google::Cloud::StorageTransfer::V1::NotificationConfig::PayloadFormat

Parameter

value (::Google::Cloud::StorageTransfer::V1::NotificationConfig::PayloadFormat) — Required. The desired format of the notification message payloads.

Returns

(::Google::Cloud::StorageTransfer::V1::NotificationConfig::PayloadFormat) — Required. The desired format of the notification message payloads.

#pubsub_topic

def pubsub_topic() -> ::String

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.

#pubsub_topic=

def pubsub_topic=(value) -> ::String

Parameter

value (::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.

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.