Package com.hashicorp.cdktf.providers.google.storage_notification

Interface StorageNotificationConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    StorageNotificationConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.872Z")
@Stability(Stable)
public interface StorageNotificationConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getBucket

        @Stability(Stable)
@NotNull
String getBucket()
        The name of the bucket.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_notification#bucket StorageNotification#bucket}

      • getPayloadFormat

        @Stability(Stable)
@NotNull
String getPayloadFormat()
        The desired content of the Payload. One of "JSON_API_V1" or "NONE".

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

      • getTopic

        @Stability(Stable)
@NotNull
String getTopic()
        The Cloud Pub/Sub topic to which this subscription publishes.

        Expects either the topic name, assumed to belong to the default GCP provider project, or the project-level name, i.e. projects/my-gcp-project/topics/my-topic or my-topic. If the project is not set in the provider, you will need to use the project-level name. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_notification#topic StorageNotification#topic}

      • getCustomAttributes

        @Stability(Stable)
@Nullable
default Map<String,​String> getCustomAttributes()
        A set of key/value attribute pairs to attach to each Cloud Pub/Sub message published for this notification subscription.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_notification#custom_attributes StorageNotification#custom_attributes}

      • getEventTypes

        @Stability(Stable)
@Nullable
default List<String> getEventTypes()
        List of event type filters for this notification config.

        If not specified, Cloud Storage will send notifications for all event types. The valid types are: "OBJECT_FINALIZE", "OBJECT_METADATA_UPDATE", "OBJECT_DELETE", "OBJECT_ARCHIVE" Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_notification#event_types StorageNotification#event_types}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_notification#id StorageNotification#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getObjectNamePrefix

        @Stability(Stable)
@Nullable
default String getObjectNamePrefix()
        Specifies a prefix path filter for this notification config.

        Cloud Storage will only send notifications for objects in this bucket whose names begin with the specified prefix. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_notification#object_name_prefix StorageNotification#object_name_prefix}