Package com.hashicorp.cdktf.providers.google.storage_transfer_job

Interface StorageTransferJobNotificationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StorageTransferJobNotificationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.880Z")
@Stability(Stable)
public interface StorageTransferJobNotificationConfig
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StorageTransferJobNotificationConfig.Builder	A builder for StorageTransferJobNotificationConfig
static class	StorageTransferJobNotificationConfig.Jsii$Proxy	An implementation for StorageTransferJobNotificationConfig

Method Summary

Modifier and Type	Method	Description
static StorageTransferJobNotificationConfig.Builder	builder()
default List<String>	getEventTypes()	Event types for which a notification is desired.
String	getPayloadFormat()	The desired format of the notification message payloads.
String	getPubsubTopic()	The Topic.name of the Pub/Sub topic to which to publish notifications.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPayloadFormat

@Stability(Stable)
@NotNull
String getPayloadFormat()

The desired format of the notification message payloads. One of "NONE" or "JSON".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#payload_format StorageTransferJob#payload_format}

getPubsubTopic

@Stability(Stable)
@NotNull
String getPubsubTopic()

The Topic.name of the Pub/Sub topic to which to publish notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#pubsub_topic StorageTransferJob#pubsub_topic}

getEventTypes

@Stability(Stable)
@Nullable
default List<String> getEventTypes()

Event types for which a notification is desired.

If empty, send notifications for all event types. The valid types are "TRANSFER_OPERATION_SUCCESS", "TRANSFER_OPERATION_FAILED", "TRANSFER_OPERATION_ABORTED". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_transfer_job#event_types StorageTransferJob#event_types}

builder

@Stability(Stable)
static StorageTransferJobNotificationConfig.Builder builder()

Returns:

a StorageTransferJobNotificationConfig.Builder of StorageTransferJobNotificationConfig