published on Wednesday, Nov 18, 2026 by Pulumi
published on Wednesday, Nov 18, 2026 by Pulumi
A Bigquery Analytics Hub listing subscription
To get more information about ListingSubscription, see:
- API documentation
- How-to Guides
Note: When importing the resource with
pulumi import, provide the destination project and location in the format projects/{{destination_project}}/locations/{{destination_location}}/subscriptions/{{subscription_id}}
Example Usage
Bigquery Analyticshub Listing Subscription Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const subscription = new gcp.bigqueryanalyticshub.DataExchange("subscription", {
location: "US",
dataExchangeId: "my_data_exchange",
displayName: "my_data_exchange",
description: "Test Description",
});
const subscriptionDataset = new gcp.bigquery.Dataset("subscription", {
datasetId: "my_listing",
friendlyName: "my_listing",
description: "Test Description",
location: "US",
});
const subscriptionListing = new gcp.bigqueryanalyticshub.Listing("subscription", {
location: "US",
dataExchangeId: subscription.dataExchangeId,
listingId: "my_listing",
displayName: "my_listing",
description: "Test Description",
bigqueryDataset: {
dataset: subscriptionDataset.id,
},
});
const subscriptionListingSubscription = new gcp.bigqueryanalyticshub.ListingSubscription("subscription", {
location: "US",
dataExchangeId: subscription.dataExchangeId,
listingId: subscriptionListing.listingId,
destinationDataset: {
description: "A test subscription",
friendlyName: "👋",
labels: {
testing: "123",
},
location: "US",
datasetReference: {
datasetId: "destination_dataset",
projectId: subscriptionDataset.project,
},
},
});
import pulumi
import pulumi_gcp as gcp
subscription = gcp.bigqueryanalyticshub.DataExchange("subscription",
location="US",
data_exchange_id="my_data_exchange",
display_name="my_data_exchange",
description="Test Description")
subscription_dataset = gcp.bigquery.Dataset("subscription",
dataset_id="my_listing",
friendly_name="my_listing",
description="Test Description",
location="US")
subscription_listing = gcp.bigqueryanalyticshub.Listing("subscription",
location="US",
data_exchange_id=subscription.data_exchange_id,
listing_id="my_listing",
display_name="my_listing",
description="Test Description",
bigquery_dataset={
"dataset": subscription_dataset.id,
})
subscription_listing_subscription = gcp.bigqueryanalyticshub.ListingSubscription("subscription",
location="US",
data_exchange_id=subscription.data_exchange_id,
listing_id=subscription_listing.listing_id,
destination_dataset={
"description": "A test subscription",
"friendly_name": "👋",
"labels": {
"testing": "123",
},
"location": "US",
"dataset_reference": {
"dataset_id": "destination_dataset",
"project_id": subscription_dataset.project,
},
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/bigquery"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/bigqueryanalyticshub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
subscription, err := bigqueryanalyticshub.NewDataExchange(ctx, "subscription", &bigqueryanalyticshub.DataExchangeArgs{
Location: pulumi.String("US"),
DataExchangeId: pulumi.String("my_data_exchange"),
DisplayName: pulumi.String("my_data_exchange"),
Description: pulumi.String("Test Description"),
})
if err != nil {
return err
}
subscriptionDataset, err := bigquery.NewDataset(ctx, "subscription", &bigquery.DatasetArgs{
DatasetId: pulumi.String("my_listing"),
FriendlyName: pulumi.String("my_listing"),
Description: pulumi.String("Test Description"),
Location: pulumi.String("US"),
})
if err != nil {
return err
}
subscriptionListing, err := bigqueryanalyticshub.NewListing(ctx, "subscription", &bigqueryanalyticshub.ListingArgs{
Location: pulumi.String("US"),
DataExchangeId: subscription.DataExchangeId,
ListingId: pulumi.String("my_listing"),
DisplayName: pulumi.String("my_listing"),
Description: pulumi.String("Test Description"),
BigqueryDataset: &bigqueryanalyticshub.ListingBigqueryDatasetArgs{
Dataset: subscriptionDataset.ID(),
},
})
if err != nil {
return err
}
_, err = bigqueryanalyticshub.NewListingSubscription(ctx, "subscription", &bigqueryanalyticshub.ListingSubscriptionArgs{
Location: pulumi.String("US"),
DataExchangeId: subscription.DataExchangeId,
ListingId: subscriptionListing.ListingId,
DestinationDataset: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetArgs{
Description: pulumi.String("A test subscription"),
FriendlyName: pulumi.String("👋"),
Labels: pulumi.StringMap{
"testing": pulumi.String("123"),
},
Location: pulumi.String("US"),
DatasetReference: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetDatasetReferenceArgs{
DatasetId: pulumi.String("destination_dataset"),
ProjectId: subscriptionDataset.Project,
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var subscription = new Gcp.BigQueryAnalyticsHub.DataExchange("subscription", new()
{
Location = "US",
DataExchangeId = "my_data_exchange",
DisplayName = "my_data_exchange",
Description = "Test Description",
});
var subscriptionDataset = new Gcp.BigQuery.Dataset("subscription", new()
{
DatasetId = "my_listing",
FriendlyName = "my_listing",
Description = "Test Description",
Location = "US",
});
var subscriptionListing = new Gcp.BigQueryAnalyticsHub.Listing("subscription", new()
{
Location = "US",
DataExchangeId = subscription.DataExchangeId,
ListingId = "my_listing",
DisplayName = "my_listing",
Description = "Test Description",
BigqueryDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingBigqueryDatasetArgs
{
Dataset = subscriptionDataset.Id,
},
});
var subscriptionListingSubscription = new Gcp.BigQueryAnalyticsHub.ListingSubscription("subscription", new()
{
Location = "US",
DataExchangeId = subscription.DataExchangeId,
ListingId = subscriptionListing.ListingId,
DestinationDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetArgs
{
Description = "A test subscription",
FriendlyName = "👋",
Labels =
{
{ "testing", "123" },
},
Location = "US",
DatasetReference = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetDatasetReferenceArgs
{
DatasetId = "destination_dataset",
ProjectId = subscriptionDataset.Project,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchange;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs;
import com.pulumi.gcp.bigquery.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.Listing;
import com.pulumi.gcp.bigqueryanalyticshub.ListingArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingBigqueryDatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.ListingSubscription;
import com.pulumi.gcp.bigqueryanalyticshub.ListingSubscriptionArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingSubscriptionDestinationDatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingSubscriptionDestinationDatasetDatasetReferenceArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var subscription = new DataExchange("subscription", DataExchangeArgs.builder()
.location("US")
.dataExchangeId("my_data_exchange")
.displayName("my_data_exchange")
.description("Test Description")
.build());
var subscriptionDataset = new Dataset("subscriptionDataset", DatasetArgs.builder()
.datasetId("my_listing")
.friendlyName("my_listing")
.description("Test Description")
.location("US")
.build());
var subscriptionListing = new Listing("subscriptionListing", ListingArgs.builder()
.location("US")
.dataExchangeId(subscription.dataExchangeId())
.listingId("my_listing")
.displayName("my_listing")
.description("Test Description")
.bigqueryDataset(ListingBigqueryDatasetArgs.builder()
.dataset(subscriptionDataset.id())
.build())
.build());
var subscriptionListingSubscription = new ListingSubscription("subscriptionListingSubscription", ListingSubscriptionArgs.builder()
.location("US")
.dataExchangeId(subscription.dataExchangeId())
.listingId(subscriptionListing.listingId())
.destinationDataset(ListingSubscriptionDestinationDatasetArgs.builder()
.description("A test subscription")
.friendlyName("👋")
.labels(Map.of("testing", "123"))
.location("US")
.datasetReference(ListingSubscriptionDestinationDatasetDatasetReferenceArgs.builder()
.datasetId("destination_dataset")
.projectId(subscriptionDataset.project())
.build())
.build())
.build());
}
}
resources:
subscription:
type: gcp:bigqueryanalyticshub:DataExchange
properties:
location: US
dataExchangeId: my_data_exchange
displayName: my_data_exchange
description: Test Description
subscriptionListing:
type: gcp:bigqueryanalyticshub:Listing
name: subscription
properties:
location: US
dataExchangeId: ${subscription.dataExchangeId}
listingId: my_listing
displayName: my_listing
description: Test Description
bigqueryDataset:
dataset: ${subscriptionDataset.id}
subscriptionDataset:
type: gcp:bigquery:Dataset
name: subscription
properties:
datasetId: my_listing
friendlyName: my_listing
description: Test Description
location: US
subscriptionListingSubscription:
type: gcp:bigqueryanalyticshub:ListingSubscription
name: subscription
properties:
location: US
dataExchangeId: ${subscription.dataExchangeId}
listingId: ${subscriptionListing.listingId}
destinationDataset:
description: A test subscription
friendlyName: "\U0001F44B"
labels:
testing: '123'
location: US
datasetReference:
datasetId: destination_dataset
projectId: ${subscriptionDataset.project}
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_bigqueryanalyticshub_data_exchange" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "US"
data_exchange_id = "my_data_exchange"
display_name = "my_data_exchange"
description = "Test Description"
}
resource "gcp_bigqueryanalyticshub_listing" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "US"
data_exchange_id = gcp_bigqueryanalyticshub_data_exchange.subscription.data_exchange_id
listing_id = "my_listing"
display_name = "my_listing"
description = "Test Description"
bigquery_dataset = {
dataset = gcp_bigquery_dataset.subscription.id
}
}
resource "gcp_bigquery_dataset" "subscription" {
lifecycle {
create_before_destroy = true
}
dataset_id = "my_listing"
friendly_name = "my_listing"
description = "Test Description"
location = "US"
}
resource "gcp_bigqueryanalyticshub_listing_subscription" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "US"
data_exchange_id = gcp_bigqueryanalyticshub_data_exchange.subscription.data_exchange_id
listing_id = gcp_bigqueryanalyticshub_listing.subscription.listing_id
destination_dataset = {
description = "A test subscription"
friendly_name = "👋"
labels = {
"testing" = "123"
}
location = "US"
dataset_reference = {
dataset_id = "destination_dataset"
project_id = gcp_bigquery_dataset.subscription.project
}
}
}
Bigquery Analyticshub Listing Subscription Multiregion
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const subscription = new gcp.bigqueryanalyticshub.DataExchange("subscription", {
location: "us",
dataExchangeId: "my_data_exchange",
displayName: "my_data_exchange",
});
const subscriptionListing = new gcp.bigqueryanalyticshub.Listing("subscription", {
location: "us",
dataExchangeId: subscription.dataExchangeId,
listingId: "my_listing",
displayName: "my_listing",
bigqueryDataset: {
dataset: "projects/project_id/datasets/my_listing_example2",
replicaLocations: ["eu"],
},
});
const subscriptionListingSubscription = new gcp.bigqueryanalyticshub.ListingSubscription("subscription", {
location: "us",
dataExchangeId: subscription.dataExchangeId,
listingId: subscriptionListing.listingId,
destinationDataset: {
location: "us",
datasetReference: {
projectId: subscription.project,
datasetId: "destination_dataset",
},
replicaLocations: ["eu"],
},
});
import pulumi
import pulumi_gcp as gcp
subscription = gcp.bigqueryanalyticshub.DataExchange("subscription",
location="us",
data_exchange_id="my_data_exchange",
display_name="my_data_exchange")
subscription_listing = gcp.bigqueryanalyticshub.Listing("subscription",
location="us",
data_exchange_id=subscription.data_exchange_id,
listing_id="my_listing",
display_name="my_listing",
bigquery_dataset={
"dataset": "projects/project_id/datasets/my_listing_example2",
"replica_locations": ["eu"],
})
subscription_listing_subscription = gcp.bigqueryanalyticshub.ListingSubscription("subscription",
location="us",
data_exchange_id=subscription.data_exchange_id,
listing_id=subscription_listing.listing_id,
destination_dataset={
"location": "us",
"dataset_reference": {
"project_id": subscription.project,
"dataset_id": "destination_dataset",
},
"replica_locations": ["eu"],
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/bigqueryanalyticshub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
subscription, err := bigqueryanalyticshub.NewDataExchange(ctx, "subscription", &bigqueryanalyticshub.DataExchangeArgs{
Location: pulumi.String("us"),
DataExchangeId: pulumi.String("my_data_exchange"),
DisplayName: pulumi.String("my_data_exchange"),
})
if err != nil {
return err
}
subscriptionListing, err := bigqueryanalyticshub.NewListing(ctx, "subscription", &bigqueryanalyticshub.ListingArgs{
Location: pulumi.String("us"),
DataExchangeId: subscription.DataExchangeId,
ListingId: pulumi.String("my_listing"),
DisplayName: pulumi.String("my_listing"),
BigqueryDataset: &bigqueryanalyticshub.ListingBigqueryDatasetArgs{
Dataset: pulumi.String("projects/project_id/datasets/my_listing_example2"),
ReplicaLocations: pulumi.StringArray{
pulumi.String("eu"),
},
},
})
if err != nil {
return err
}
_, err = bigqueryanalyticshub.NewListingSubscription(ctx, "subscription", &bigqueryanalyticshub.ListingSubscriptionArgs{
Location: pulumi.String("us"),
DataExchangeId: subscription.DataExchangeId,
ListingId: subscriptionListing.ListingId,
DestinationDataset: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetArgs{
Location: pulumi.String("us"),
DatasetReference: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetDatasetReferenceArgs{
ProjectId: subscription.Project,
DatasetId: pulumi.String("destination_dataset"),
},
ReplicaLocations: pulumi.StringArray{
pulumi.String("eu"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var subscription = new Gcp.BigQueryAnalyticsHub.DataExchange("subscription", new()
{
Location = "us",
DataExchangeId = "my_data_exchange",
DisplayName = "my_data_exchange",
});
var subscriptionListing = new Gcp.BigQueryAnalyticsHub.Listing("subscription", new()
{
Location = "us",
DataExchangeId = subscription.DataExchangeId,
ListingId = "my_listing",
DisplayName = "my_listing",
BigqueryDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingBigqueryDatasetArgs
{
Dataset = "projects/project_id/datasets/my_listing_example2",
ReplicaLocations = new[]
{
"eu",
},
},
});
var subscriptionListingSubscription = new Gcp.BigQueryAnalyticsHub.ListingSubscription("subscription", new()
{
Location = "us",
DataExchangeId = subscription.DataExchangeId,
ListingId = subscriptionListing.ListingId,
DestinationDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetArgs
{
Location = "us",
DatasetReference = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetDatasetReferenceArgs
{
ProjectId = subscription.Project,
DatasetId = "destination_dataset",
},
ReplicaLocations = new[]
{
"eu",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchange;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs;
import com.pulumi.gcp.bigqueryanalyticshub.Listing;
import com.pulumi.gcp.bigqueryanalyticshub.ListingArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingBigqueryDatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.ListingSubscription;
import com.pulumi.gcp.bigqueryanalyticshub.ListingSubscriptionArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingSubscriptionDestinationDatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingSubscriptionDestinationDatasetDatasetReferenceArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var subscription = new DataExchange("subscription", DataExchangeArgs.builder()
.location("us")
.dataExchangeId("my_data_exchange")
.displayName("my_data_exchange")
.build());
var subscriptionListing = new Listing("subscriptionListing", ListingArgs.builder()
.location("us")
.dataExchangeId(subscription.dataExchangeId())
.listingId("my_listing")
.displayName("my_listing")
.bigqueryDataset(ListingBigqueryDatasetArgs.builder()
.dataset("projects/project_id/datasets/my_listing_example2")
.replicaLocations("eu")
.build())
.build());
var subscriptionListingSubscription = new ListingSubscription("subscriptionListingSubscription", ListingSubscriptionArgs.builder()
.location("us")
.dataExchangeId(subscription.dataExchangeId())
.listingId(subscriptionListing.listingId())
.destinationDataset(ListingSubscriptionDestinationDatasetArgs.builder()
.location("us")
.datasetReference(ListingSubscriptionDestinationDatasetDatasetReferenceArgs.builder()
.projectId(subscription.project())
.datasetId("destination_dataset")
.build())
.replicaLocations("eu")
.build())
.build());
}
}
resources:
subscription:
type: gcp:bigqueryanalyticshub:DataExchange
properties:
location: us
dataExchangeId: my_data_exchange
displayName: my_data_exchange
subscriptionListing:
type: gcp:bigqueryanalyticshub:Listing
name: subscription
properties:
location: us
dataExchangeId: ${subscription.dataExchangeId}
listingId: my_listing
displayName: my_listing
bigqueryDataset:
dataset: projects/project_id/datasets/my_listing_example2
replicaLocations:
- eu
subscriptionListingSubscription:
type: gcp:bigqueryanalyticshub:ListingSubscription
name: subscription
properties:
location: us
dataExchangeId: ${subscription.dataExchangeId}
listingId: ${subscriptionListing.listingId}
destinationDataset:
location: us
datasetReference:
projectId: ${subscription.project}
datasetId: destination_dataset
replicaLocations:
- eu
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_bigqueryanalyticshub_data_exchange" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "us"
data_exchange_id = "my_data_exchange"
display_name = "my_data_exchange"
}
resource "gcp_bigqueryanalyticshub_listing" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "us"
data_exchange_id = gcp_bigqueryanalyticshub_data_exchange.subscription.data_exchange_id
listing_id = "my_listing"
display_name = "my_listing"
bigquery_dataset = {
dataset = "projects/project_id/datasets/my_listing_example2"
replica_locations = ["eu"]
}
}
resource "gcp_bigqueryanalyticshub_listing_subscription" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "us"
data_exchange_id = gcp_bigqueryanalyticshub_data_exchange.subscription.data_exchange_id
listing_id = gcp_bigqueryanalyticshub_listing.subscription.listing_id
destination_dataset = {
location = "us"
dataset_reference = {
project_id = gcp_bigqueryanalyticshub_data_exchange.subscription.project
dataset_id = "destination_dataset"
}
replica_locations = ["eu"]
}
}
Bigquery Analyticshub Listing Subscription Pubsub
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const subscription = new gcp.bigqueryanalyticshub.DataExchange("subscription", {
location: "US",
dataExchangeId: "my_data_exchange",
displayName: "my_data_exchange",
description: "example pubsub listing subscription",
});
const subscriptionTopic = new gcp.pubsub.Topic("subscription", {name: "my_pubsub_topic"});
const subscriptionListing = new gcp.bigqueryanalyticshub.Listing("subscription", {
location: "US",
dataExchangeId: subscription.dataExchangeId,
listingId: "my_listing",
displayName: "my_listing",
description: "example pubsub listing subscription",
pubsubTopic: {
topic: subscriptionTopic.id,
},
});
const subscriptionListingSubscription = new gcp.bigqueryanalyticshub.ListingSubscription("subscription", {
location: "US",
dataExchangeId: subscription.dataExchangeId,
listingId: subscriptionListing.listingId,
destinationPubsubSubscription: {
pubsubSubscription: {
name: pulumi.interpolate`projects/${subscriptionTopic.project}/subscriptions/my_pubsub_subscription`,
},
},
});
import pulumi
import pulumi_gcp as gcp
subscription = gcp.bigqueryanalyticshub.DataExchange("subscription",
location="US",
data_exchange_id="my_data_exchange",
display_name="my_data_exchange",
description="example pubsub listing subscription")
subscription_topic = gcp.pubsub.Topic("subscription", name="my_pubsub_topic")
subscription_listing = gcp.bigqueryanalyticshub.Listing("subscription",
location="US",
data_exchange_id=subscription.data_exchange_id,
listing_id="my_listing",
display_name="my_listing",
description="example pubsub listing subscription",
pubsub_topic={
"topic": subscription_topic.id,
})
subscription_listing_subscription = gcp.bigqueryanalyticshub.ListingSubscription("subscription",
location="US",
data_exchange_id=subscription.data_exchange_id,
listing_id=subscription_listing.listing_id,
destination_pubsub_subscription={
"pubsub_subscription": {
"name": subscription_topic.project.apply(lambda project: f"projects/{project}/subscriptions/my_pubsub_subscription"),
},
})
package main
import (
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/bigqueryanalyticshub"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/pubsub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
subscription, err := bigqueryanalyticshub.NewDataExchange(ctx, "subscription", &bigqueryanalyticshub.DataExchangeArgs{
Location: pulumi.String("US"),
DataExchangeId: pulumi.String("my_data_exchange"),
DisplayName: pulumi.String("my_data_exchange"),
Description: pulumi.String("example pubsub listing subscription"),
})
if err != nil {
return err
}
subscriptionTopic, err := pubsub.NewTopic(ctx, "subscription", &pubsub.TopicArgs{
Name: pulumi.String("my_pubsub_topic"),
})
if err != nil {
return err
}
subscriptionListing, err := bigqueryanalyticshub.NewListing(ctx, "subscription", &bigqueryanalyticshub.ListingArgs{
Location: pulumi.String("US"),
DataExchangeId: subscription.DataExchangeId,
ListingId: pulumi.String("my_listing"),
DisplayName: pulumi.String("my_listing"),
Description: pulumi.String("example pubsub listing subscription"),
PubsubTopic: &bigqueryanalyticshub.ListingPubsubTopicArgs{
Topic: subscriptionTopic.ID(),
},
})
if err != nil {
return err
}
_, err = bigqueryanalyticshub.NewListingSubscription(ctx, "subscription", &bigqueryanalyticshub.ListingSubscriptionArgs{
Location: pulumi.String("US"),
DataExchangeId: subscription.DataExchangeId,
ListingId: subscriptionListing.ListingId,
DestinationPubsubSubscription: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionArgs{
PubsubSubscription: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionArgs{
Name: subscriptionTopic.Project.ApplyT(func(project string) (string, error) {
return fmt.Sprintf("projects/%v/subscriptions/my_pubsub_subscription", project), nil
}).(pulumi.StringOutput),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var subscription = new Gcp.BigQueryAnalyticsHub.DataExchange("subscription", new()
{
Location = "US",
DataExchangeId = "my_data_exchange",
DisplayName = "my_data_exchange",
Description = "example pubsub listing subscription",
});
var subscriptionTopic = new Gcp.PubSub.Topic("subscription", new()
{
Name = "my_pubsub_topic",
});
var subscriptionListing = new Gcp.BigQueryAnalyticsHub.Listing("subscription", new()
{
Location = "US",
DataExchangeId = subscription.DataExchangeId,
ListingId = "my_listing",
DisplayName = "my_listing",
Description = "example pubsub listing subscription",
PubsubTopic = new Gcp.BigQueryAnalyticsHub.Inputs.ListingPubsubTopicArgs
{
Topic = subscriptionTopic.Id,
},
});
var subscriptionListingSubscription = new Gcp.BigQueryAnalyticsHub.ListingSubscription("subscription", new()
{
Location = "US",
DataExchangeId = subscription.DataExchangeId,
ListingId = subscriptionListing.ListingId,
DestinationPubsubSubscription = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionArgs
{
PubsubSubscription = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionArgs
{
Name = subscriptionTopic.Project.Apply(project => $"projects/{project}/subscriptions/my_pubsub_subscription"),
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchange;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs;
import com.pulumi.gcp.pubsub.Topic;
import com.pulumi.gcp.pubsub.TopicArgs;
import com.pulumi.gcp.bigqueryanalyticshub.Listing;
import com.pulumi.gcp.bigqueryanalyticshub.ListingArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingPubsubTopicArgs;
import com.pulumi.gcp.bigqueryanalyticshub.ListingSubscription;
import com.pulumi.gcp.bigqueryanalyticshub.ListingSubscriptionArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingSubscriptionDestinationPubsubSubscriptionArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var subscription = new DataExchange("subscription", DataExchangeArgs.builder()
.location("US")
.dataExchangeId("my_data_exchange")
.displayName("my_data_exchange")
.description("example pubsub listing subscription")
.build());
var subscriptionTopic = new Topic("subscriptionTopic", TopicArgs.builder()
.name("my_pubsub_topic")
.build());
var subscriptionListing = new Listing("subscriptionListing", ListingArgs.builder()
.location("US")
.dataExchangeId(subscription.dataExchangeId())
.listingId("my_listing")
.displayName("my_listing")
.description("example pubsub listing subscription")
.pubsubTopic(ListingPubsubTopicArgs.builder()
.topic(subscriptionTopic.id())
.build())
.build());
var subscriptionListingSubscription = new ListingSubscription("subscriptionListingSubscription", ListingSubscriptionArgs.builder()
.location("US")
.dataExchangeId(subscription.dataExchangeId())
.listingId(subscriptionListing.listingId())
.destinationPubsubSubscription(ListingSubscriptionDestinationPubsubSubscriptionArgs.builder()
.pubsubSubscription(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionArgs.builder()
.name(subscriptionTopic.project().applyValue(_project -> String.format("projects/%s/subscriptions/my_pubsub_subscription", _project)))
.build())
.build())
.build());
}
}
resources:
subscription:
type: gcp:bigqueryanalyticshub:DataExchange
properties:
location: US
dataExchangeId: my_data_exchange
displayName: my_data_exchange
description: example pubsub listing subscription
subscriptionTopic:
type: gcp:pubsub:Topic
name: subscription
properties:
name: my_pubsub_topic
subscriptionListing:
type: gcp:bigqueryanalyticshub:Listing
name: subscription
properties:
location: US
dataExchangeId: ${subscription.dataExchangeId}
listingId: my_listing
displayName: my_listing
description: example pubsub listing subscription
pubsubTopic:
topic: ${subscriptionTopic.id}
subscriptionListingSubscription:
type: gcp:bigqueryanalyticshub:ListingSubscription
name: subscription
properties:
location: US
dataExchangeId: ${subscription.dataExchangeId}
listingId: ${subscriptionListing.listingId}
destinationPubsubSubscription:
pubsubSubscription:
name: projects/${subscriptionTopic.project}/subscriptions/my_pubsub_subscription
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_bigqueryanalyticshub_data_exchange" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "US"
data_exchange_id = "my_data_exchange"
display_name = "my_data_exchange"
description = "example pubsub listing subscription"
}
resource "gcp_pubsub_topic" "subscription" {
lifecycle {
create_before_destroy = true
}
name = "my_pubsub_topic"
}
resource "gcp_bigqueryanalyticshub_listing" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "US"
data_exchange_id = gcp_bigqueryanalyticshub_data_exchange.subscription.data_exchange_id
listing_id = "my_listing"
display_name = "my_listing"
description = "example pubsub listing subscription"
pubsub_topic = {
topic = gcp_pubsub_topic.subscription.id
}
}
resource "gcp_bigqueryanalyticshub_listing_subscription" "subscription" {
lifecycle {
create_before_destroy = true
}
location = "US"
data_exchange_id = gcp_bigqueryanalyticshub_data_exchange.subscription.data_exchange_id
listing_id = gcp_bigqueryanalyticshub_listing.subscription.listing_id
destination_pubsub_subscription = {
pubsub_subscription = {
name ="projects/${gcp_pubsub_topic.subscription.project}/subscriptions/my_pubsub_subscription"
}
}
}
Create ListingSubscription Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ListingSubscription(name: string, args: ListingSubscriptionArgs, opts?: CustomResourceOptions);@overload
def ListingSubscription(resource_name: str,
args: ListingSubscriptionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ListingSubscription(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_exchange_id: Optional[str] = None,
listing_id: Optional[str] = None,
location: Optional[str] = None,
deletion_policy: Optional[str] = None,
destination_dataset: Optional[ListingSubscriptionDestinationDatasetArgs] = None,
destination_pubsub_subscription: Optional[ListingSubscriptionDestinationPubsubSubscriptionArgs] = None,
project: Optional[str] = None)func NewListingSubscription(ctx *Context, name string, args ListingSubscriptionArgs, opts ...ResourceOption) (*ListingSubscription, error)public ListingSubscription(string name, ListingSubscriptionArgs args, CustomResourceOptions? opts = null)
public ListingSubscription(String name, ListingSubscriptionArgs args)
public ListingSubscription(String name, ListingSubscriptionArgs args, CustomResourceOptions options)
type: gcp:bigqueryanalyticshub:ListingSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "gcp_bigqueryanalyticshub_listing_subscription" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ListingSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ListingSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ListingSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ListingSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ListingSubscriptionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var listingSubscriptionResource = new Gcp.BigQueryAnalyticsHub.ListingSubscription("listingSubscriptionResource", new()
{
DataExchangeId = "string",
ListingId = "string",
Location = "string",
DeletionPolicy = "string",
DestinationDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetArgs
{
DatasetReference = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetDatasetReferenceArgs
{
DatasetId = "string",
ProjectId = "string",
},
Location = "string",
Description = "string",
FriendlyName = "string",
Labels =
{
{ "string", "string" },
},
ReplicaLocations = new[]
{
"string",
},
},
DestinationPubsubSubscription = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionArgs
{
PubsubSubscription = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionArgs
{
Name = "string",
EnableMessageOrdering = false,
Filter = "string",
DeadLetterPolicy = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionDeadLetterPolicyArgs
{
DeadLetterTopic = "string",
MaxDeliveryAttempts = 0,
},
Detached = false,
EnableExactlyOnceDelivery = false,
AckDeadlineSeconds = 0,
ExpirationPolicy = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionExpirationPolicyArgs
{
Ttl = "string",
},
CloudStorageConfig = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigArgs
{
AvroConfig = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigAvroConfigArgs
{
UseTopicSchema = false,
WriteMetadata = false,
},
Bucket = "string",
FilenameDatetimeFormat = "string",
FilenamePrefix = "string",
FilenameSuffix = "string",
MaxBytes = "string",
MaxDuration = "string",
MaxMessages = "string",
ServiceAccountEmail = "string",
},
Labels =
{
{ "string", "string" },
},
MessageRetentionDuration = "string",
BigqueryConfig = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionBigqueryConfigArgs
{
DropUnknownFields = false,
ServiceAccountEmail = "string",
Table = "string",
UseTableSchema = false,
UseTopicSchema = false,
WriteMetadata = false,
},
PushConfig = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigArgs
{
Attributes =
{
{ "string", "string" },
},
NoWrapper = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigNoWrapperArgs
{
WriteMetadata = false,
},
OidcToken = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigOidcTokenArgs
{
Audience = "string",
ServiceAccountEmail = "string",
},
PushEndpoint = "string",
},
RetainAckedMessages = false,
RetryPolicy = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionRetryPolicyArgs
{
MaximumBackoff = "string",
MinimumBackoff = "string",
},
},
},
Project = "string",
});
example, err := bigqueryanalyticshub.NewListingSubscription(ctx, "listingSubscriptionResource", &bigqueryanalyticshub.ListingSubscriptionArgs{
DataExchangeId: pulumi.String("string"),
ListingId: pulumi.String("string"),
Location: pulumi.String("string"),
DeletionPolicy: pulumi.String("string"),
DestinationDataset: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetArgs{
DatasetReference: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetDatasetReferenceArgs{
DatasetId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
},
Location: pulumi.String("string"),
Description: pulumi.String("string"),
FriendlyName: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
ReplicaLocations: pulumi.StringArray{
pulumi.String("string"),
},
},
DestinationPubsubSubscription: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionArgs{
PubsubSubscription: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionArgs{
Name: pulumi.String("string"),
EnableMessageOrdering: pulumi.Bool(false),
Filter: pulumi.String("string"),
DeadLetterPolicy: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionDeadLetterPolicyArgs{
DeadLetterTopic: pulumi.String("string"),
MaxDeliveryAttempts: pulumi.Int(0),
},
Detached: pulumi.Bool(false),
EnableExactlyOnceDelivery: pulumi.Bool(false),
AckDeadlineSeconds: pulumi.Int(0),
ExpirationPolicy: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionExpirationPolicyArgs{
Ttl: pulumi.String("string"),
},
CloudStorageConfig: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigArgs{
AvroConfig: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigAvroConfigArgs{
UseTopicSchema: pulumi.Bool(false),
WriteMetadata: pulumi.Bool(false),
},
Bucket: pulumi.String("string"),
FilenameDatetimeFormat: pulumi.String("string"),
FilenamePrefix: pulumi.String("string"),
FilenameSuffix: pulumi.String("string"),
MaxBytes: pulumi.String("string"),
MaxDuration: pulumi.String("string"),
MaxMessages: pulumi.String("string"),
ServiceAccountEmail: pulumi.String("string"),
},
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
MessageRetentionDuration: pulumi.String("string"),
BigqueryConfig: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionBigqueryConfigArgs{
DropUnknownFields: pulumi.Bool(false),
ServiceAccountEmail: pulumi.String("string"),
Table: pulumi.String("string"),
UseTableSchema: pulumi.Bool(false),
UseTopicSchema: pulumi.Bool(false),
WriteMetadata: pulumi.Bool(false),
},
PushConfig: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigArgs{
Attributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
NoWrapper: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigNoWrapperArgs{
WriteMetadata: pulumi.Bool(false),
},
OidcToken: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigOidcTokenArgs{
Audience: pulumi.String("string"),
ServiceAccountEmail: pulumi.String("string"),
},
PushEndpoint: pulumi.String("string"),
},
RetainAckedMessages: pulumi.Bool(false),
RetryPolicy: &bigqueryanalyticshub.ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionRetryPolicyArgs{
MaximumBackoff: pulumi.String("string"),
MinimumBackoff: pulumi.String("string"),
},
},
},
Project: pulumi.String("string"),
})
resource "gcp_bigqueryanalyticshub_listing_subscription" "listingSubscriptionResource" {
lifecycle {
create_before_destroy = true
}
data_exchange_id = "string"
listing_id = "string"
location = "string"
deletion_policy = "string"
destination_dataset = {
dataset_reference = {
dataset_id = "string"
project_id = "string"
}
location = "string"
description = "string"
friendly_name = "string"
labels = {
"string" = "string"
}
replica_locations = ["string"]
}
destination_pubsub_subscription = {
pubsub_subscription = {
name = "string"
enable_message_ordering = false
filter = "string"
dead_letter_policy = {
dead_letter_topic = "string"
max_delivery_attempts = 0
}
detached = false
enable_exactly_once_delivery = false
ack_deadline_seconds = 0
expiration_policy = {
ttl = "string"
}
cloud_storage_config = {
avro_config = {
use_topic_schema = false
write_metadata = false
}
bucket = "string"
filename_datetime_format = "string"
filename_prefix = "string"
filename_suffix = "string"
max_bytes = "string"
max_duration = "string"
max_messages = "string"
service_account_email = "string"
}
labels = {
"string" = "string"
}
message_retention_duration = "string"
bigquery_config = {
drop_unknown_fields = false
service_account_email = "string"
table = "string"
use_table_schema = false
use_topic_schema = false
write_metadata = false
}
push_config = {
attributes = {
"string" = "string"
}
no_wrapper = {
write_metadata = false
}
oidc_token = {
audience = "string"
service_account_email = "string"
}
push_endpoint = "string"
}
retain_acked_messages = false
retry_policy = {
maximum_backoff = "string"
minimum_backoff = "string"
}
}
}
project = "string"
}
var listingSubscriptionResource = new ListingSubscription("listingSubscriptionResource", ListingSubscriptionArgs.builder()
.dataExchangeId("string")
.listingId("string")
.location("string")
.deletionPolicy("string")
.destinationDataset(ListingSubscriptionDestinationDatasetArgs.builder()
.datasetReference(ListingSubscriptionDestinationDatasetDatasetReferenceArgs.builder()
.datasetId("string")
.projectId("string")
.build())
.location("string")
.description("string")
.friendlyName("string")
.labels(Map.of("string", "string"))
.replicaLocations("string")
.build())
.destinationPubsubSubscription(ListingSubscriptionDestinationPubsubSubscriptionArgs.builder()
.pubsubSubscription(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionArgs.builder()
.name("string")
.enableMessageOrdering(false)
.filter("string")
.deadLetterPolicy(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionDeadLetterPolicyArgs.builder()
.deadLetterTopic("string")
.maxDeliveryAttempts(0)
.build())
.detached(false)
.enableExactlyOnceDelivery(false)
.ackDeadlineSeconds(0)
.expirationPolicy(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionExpirationPolicyArgs.builder()
.ttl("string")
.build())
.cloudStorageConfig(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigArgs.builder()
.avroConfig(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigAvroConfigArgs.builder()
.useTopicSchema(false)
.writeMetadata(false)
.build())
.bucket("string")
.filenameDatetimeFormat("string")
.filenamePrefix("string")
.filenameSuffix("string")
.maxBytes("string")
.maxDuration("string")
.maxMessages("string")
.serviceAccountEmail("string")
.build())
.labels(Map.of("string", "string"))
.messageRetentionDuration("string")
.bigqueryConfig(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionBigqueryConfigArgs.builder()
.dropUnknownFields(false)
.serviceAccountEmail("string")
.table("string")
.useTableSchema(false)
.useTopicSchema(false)
.writeMetadata(false)
.build())
.pushConfig(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigArgs.builder()
.attributes(Map.of("string", "string"))
.noWrapper(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigNoWrapperArgs.builder()
.writeMetadata(false)
.build())
.oidcToken(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigOidcTokenArgs.builder()
.audience("string")
.serviceAccountEmail("string")
.build())
.pushEndpoint("string")
.build())
.retainAckedMessages(false)
.retryPolicy(ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionRetryPolicyArgs.builder()
.maximumBackoff("string")
.minimumBackoff("string")
.build())
.build())
.build())
.project("string")
.build());
listing_subscription_resource = gcp.bigqueryanalyticshub.ListingSubscription("listingSubscriptionResource",
data_exchange_id="string",
listing_id="string",
location="string",
deletion_policy="string",
destination_dataset={
"dataset_reference": {
"dataset_id": "string",
"project_id": "string",
},
"location": "string",
"description": "string",
"friendly_name": "string",
"labels": {
"string": "string",
},
"replica_locations": ["string"],
},
destination_pubsub_subscription={
"pubsub_subscription": {
"name": "string",
"enable_message_ordering": False,
"filter": "string",
"dead_letter_policy": {
"dead_letter_topic": "string",
"max_delivery_attempts": 0,
},
"detached": False,
"enable_exactly_once_delivery": False,
"ack_deadline_seconds": 0,
"expiration_policy": {
"ttl": "string",
},
"cloud_storage_config": {
"avro_config": {
"use_topic_schema": False,
"write_metadata": False,
},
"bucket": "string",
"filename_datetime_format": "string",
"filename_prefix": "string",
"filename_suffix": "string",
"max_bytes": "string",
"max_duration": "string",
"max_messages": "string",
"service_account_email": "string",
},
"labels": {
"string": "string",
},
"message_retention_duration": "string",
"bigquery_config": {
"drop_unknown_fields": False,
"service_account_email": "string",
"table": "string",
"use_table_schema": False,
"use_topic_schema": False,
"write_metadata": False,
},
"push_config": {
"attributes": {
"string": "string",
},
"no_wrapper": {
"write_metadata": False,
},
"oidc_token": {
"audience": "string",
"service_account_email": "string",
},
"push_endpoint": "string",
},
"retain_acked_messages": False,
"retry_policy": {
"maximum_backoff": "string",
"minimum_backoff": "string",
},
},
},
project="string")
const listingSubscriptionResource = new gcp.bigqueryanalyticshub.ListingSubscription("listingSubscriptionResource", {
dataExchangeId: "string",
listingId: "string",
location: "string",
deletionPolicy: "string",
destinationDataset: {
datasetReference: {
datasetId: "string",
projectId: "string",
},
location: "string",
description: "string",
friendlyName: "string",
labels: {
string: "string",
},
replicaLocations: ["string"],
},
destinationPubsubSubscription: {
pubsubSubscription: {
name: "string",
enableMessageOrdering: false,
filter: "string",
deadLetterPolicy: {
deadLetterTopic: "string",
maxDeliveryAttempts: 0,
},
detached: false,
enableExactlyOnceDelivery: false,
ackDeadlineSeconds: 0,
expirationPolicy: {
ttl: "string",
},
cloudStorageConfig: {
avroConfig: {
useTopicSchema: false,
writeMetadata: false,
},
bucket: "string",
filenameDatetimeFormat: "string",
filenamePrefix: "string",
filenameSuffix: "string",
maxBytes: "string",
maxDuration: "string",
maxMessages: "string",
serviceAccountEmail: "string",
},
labels: {
string: "string",
},
messageRetentionDuration: "string",
bigqueryConfig: {
dropUnknownFields: false,
serviceAccountEmail: "string",
table: "string",
useTableSchema: false,
useTopicSchema: false,
writeMetadata: false,
},
pushConfig: {
attributes: {
string: "string",
},
noWrapper: {
writeMetadata: false,
},
oidcToken: {
audience: "string",
serviceAccountEmail: "string",
},
pushEndpoint: "string",
},
retainAckedMessages: false,
retryPolicy: {
maximumBackoff: "string",
minimumBackoff: "string",
},
},
},
project: "string",
});
type: gcp:bigqueryanalyticshub:ListingSubscription
properties:
dataExchangeId: string
deletionPolicy: string
destinationDataset:
datasetReference:
datasetId: string
projectId: string
description: string
friendlyName: string
labels:
string: string
location: string
replicaLocations:
- string
destinationPubsubSubscription:
pubsubSubscription:
ackDeadlineSeconds: 0
bigqueryConfig:
dropUnknownFields: false
serviceAccountEmail: string
table: string
useTableSchema: false
useTopicSchema: false
writeMetadata: false
cloudStorageConfig:
avroConfig:
useTopicSchema: false
writeMetadata: false
bucket: string
filenameDatetimeFormat: string
filenamePrefix: string
filenameSuffix: string
maxBytes: string
maxDuration: string
maxMessages: string
serviceAccountEmail: string
deadLetterPolicy:
deadLetterTopic: string
maxDeliveryAttempts: 0
detached: false
enableExactlyOnceDelivery: false
enableMessageOrdering: false
expirationPolicy:
ttl: string
filter: string
labels:
string: string
messageRetentionDuration: string
name: string
pushConfig:
attributes:
string: string
noWrapper:
writeMetadata: false
oidcToken:
audience: string
serviceAccountEmail: string
pushEndpoint: string
retainAckedMessages: false
retryPolicy:
maximumBackoff: string
minimumBackoff: string
listingId: string
location: string
project: string
ListingSubscription Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ListingSubscription resource accepts the following input properties:
- Data
Exchange stringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- Listing
Id string - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- Location string
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- Destination
Dataset ListingSubscription Destination Dataset - The destination dataset for this subscription. Structure is documented below.
- Destination
Pubsub ListingSubscription Subscription Destination Pubsub Subscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Data
Exchange stringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- Listing
Id string - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- Location string
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- Destination
Dataset ListingSubscription Destination Dataset Args - The destination dataset for this subscription. Structure is documented below.
- Destination
Pubsub ListingSubscription Subscription Destination Pubsub Subscription Args - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- data_
exchange_ stringid - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- listing_
id string - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location string
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- deletion_
policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination_
dataset object - The destination dataset for this subscription. Structure is documented below.
- destination_
pubsub_ objectsubscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- data
Exchange StringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- listing
Id String - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location String
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset ListingSubscription Destination Dataset - The destination dataset for this subscription. Structure is documented below.
- destination
Pubsub ListingSubscription Subscription Destination Pubsub Subscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- data
Exchange stringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- listing
Id string - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location string
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset ListingSubscription Destination Dataset - The destination dataset for this subscription. Structure is documented below.
- destination
Pubsub ListingSubscription Subscription Destination Pubsub Subscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- data_
exchange_ strid - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- listing_
id str - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location str
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- deletion_
policy str - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination_
dataset ListingSubscription Destination Dataset Args - The destination dataset for this subscription. Structure is documented below.
- destination_
pubsub_ Listingsubscription Subscription Destination Pubsub Subscription Args - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- data
Exchange StringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- listing
Id String - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location String
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset Property Map - The destination dataset for this subscription. Structure is documented below.
- destination
Pubsub Property MapSubscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the ListingSubscription resource produces the following output properties:
- Commercial
Infos List<ListingSubscription Commercial Info> - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- Creation
Time string - Timestamp when the subscription was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modify stringTime - Timestamp when the subscription was last modified.
- Linked
Dataset List<ListingMaps Subscription Linked Dataset Map> - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- Linked
Resources List<ListingSubscription Linked Resource> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- Log
Linked boolDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- Name string
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- Organization
Display stringName - Display name of the project of this subscription.
- Organization
Id string - Organization of the project this subscription belongs to.
- Resource
Type string - Listing shared asset type.
- State string
- Current state of the subscription.
- Subscriber
Contact string - Email of the subscriber.
- Subscription
Id string - The subscription id used to reference the subscription.
- Commercial
Infos []ListingSubscription Commercial Info - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- Creation
Time string - Timestamp when the subscription was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modify stringTime - Timestamp when the subscription was last modified.
- Linked
Dataset []ListingMaps Subscription Linked Dataset Map - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- Linked
Resources []ListingSubscription Linked Resource - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- Log
Linked boolDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- Name string
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- Organization
Display stringName - Display name of the project of this subscription.
- Organization
Id string - Organization of the project this subscription belongs to.
- Resource
Type string - Listing shared asset type.
- State string
- Current state of the subscription.
- Subscriber
Contact string - Email of the subscriber.
- Subscription
Id string - The subscription id used to reference the subscription.
- commercial_
infos list(object) - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation_
time string - Timestamp when the subscription was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last_
modify_ stringtime - Timestamp when the subscription was last modified.
- linked_
dataset_ list(object)maps - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked_
resources list(object) - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log_
linked_ booldataset_ query_ user_ email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name string
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization_
display_ stringname - Display name of the project of this subscription.
- organization_
id string - Organization of the project this subscription belongs to.
- resource_
type string - Listing shared asset type.
- state string
- Current state of the subscription.
- subscriber_
contact string - Email of the subscriber.
- subscription_
id string - The subscription id used to reference the subscription.
- commercial
Infos List<ListingSubscription Commercial Info> - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation
Time String - Timestamp when the subscription was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modify StringTime - Timestamp when the subscription was last modified.
- linked
Dataset List<ListingMaps Subscription Linked Dataset Map> - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked
Resources List<ListingSubscription Linked Resource> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log
Linked BooleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name String
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization
Display StringName - Display name of the project of this subscription.
- organization
Id String - Organization of the project this subscription belongs to.
- resource
Type String - Listing shared asset type.
- state String
- Current state of the subscription.
- subscriber
Contact String - Email of the subscriber.
- subscription
Id String - The subscription id used to reference the subscription.
- commercial
Infos ListingSubscription Commercial Info[] - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation
Time string - Timestamp when the subscription was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modify stringTime - Timestamp when the subscription was last modified.
- linked
Dataset ListingMaps Subscription Linked Dataset Map[] - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked
Resources ListingSubscription Linked Resource[] - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log
Linked booleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name string
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization
Display stringName - Display name of the project of this subscription.
- organization
Id string - Organization of the project this subscription belongs to.
- resource
Type string - Listing shared asset type.
- state string
- Current state of the subscription.
- subscriber
Contact string - Email of the subscriber.
- subscription
Id string - The subscription id used to reference the subscription.
- commercial_
infos Sequence[ListingSubscription Commercial Info] - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation_
time str - Timestamp when the subscription was created.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modify_ strtime - Timestamp when the subscription was last modified.
- linked_
dataset_ Sequence[Listingmaps Subscription Linked Dataset Map] - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked_
resources Sequence[ListingSubscription Linked Resource] - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log_
linked_ booldataset_ query_ user_ email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name str
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization_
display_ strname - Display name of the project of this subscription.
- organization_
id str - Organization of the project this subscription belongs to.
- resource_
type str - Listing shared asset type.
- state str
- Current state of the subscription.
- subscriber_
contact str - Email of the subscriber.
- subscription_
id str - The subscription id used to reference the subscription.
- commercial
Infos List<Property Map> - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation
Time String - Timestamp when the subscription was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modify StringTime - Timestamp when the subscription was last modified.
- linked
Dataset List<Property Map>Maps - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked
Resources List<Property Map> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log
Linked BooleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name String
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization
Display StringName - Display name of the project of this subscription.
- organization
Id String - Organization of the project this subscription belongs to.
- resource
Type String - Listing shared asset type.
- state String
- Current state of the subscription.
- subscriber
Contact String - Email of the subscriber.
- subscription
Id String - The subscription id used to reference the subscription.
Look up Existing ListingSubscription Resource
Get an existing ListingSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ListingSubscriptionState, opts?: CustomResourceOptions): ListingSubscription@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
commercial_infos: Optional[Sequence[ListingSubscriptionCommercialInfoArgs]] = None,
creation_time: Optional[str] = None,
data_exchange_id: Optional[str] = None,
deletion_policy: Optional[str] = None,
destination_dataset: Optional[ListingSubscriptionDestinationDatasetArgs] = None,
destination_pubsub_subscription: Optional[ListingSubscriptionDestinationPubsubSubscriptionArgs] = None,
last_modify_time: Optional[str] = None,
linked_dataset_maps: Optional[Sequence[ListingSubscriptionLinkedDatasetMapArgs]] = None,
linked_resources: Optional[Sequence[ListingSubscriptionLinkedResourceArgs]] = None,
listing_id: Optional[str] = None,
location: Optional[str] = None,
log_linked_dataset_query_user_email: Optional[bool] = None,
name: Optional[str] = None,
organization_display_name: Optional[str] = None,
organization_id: Optional[str] = None,
project: Optional[str] = None,
resource_type: Optional[str] = None,
state: Optional[str] = None,
subscriber_contact: Optional[str] = None,
subscription_id: Optional[str] = None) -> ListingSubscriptionfunc GetListingSubscription(ctx *Context, name string, id IDInput, state *ListingSubscriptionState, opts ...ResourceOption) (*ListingSubscription, error)public static ListingSubscription Get(string name, Input<string> id, ListingSubscriptionState? state, CustomResourceOptions? opts = null)public static ListingSubscription get(String name, Output<String> id, ListingSubscriptionState state, CustomResourceOptions options)resources: existingListingSubscription: type: gcp:bigqueryanalyticshub:ListingSubscription get: id: ${id}import {
to = gcp_bigqueryanalyticshub_listing_subscription.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state ListingSubscriptionState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ListingSubscriptionState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state ListingSubscriptionState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state ListingSubscriptionState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Commercial
Infos List<ListingSubscription Commercial Info> - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- Creation
Time string - Timestamp when the subscription was created.
- Data
Exchange stringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- Destination
Dataset ListingSubscription Destination Dataset - The destination dataset for this subscription. Structure is documented below.
- Destination
Pubsub ListingSubscription Subscription Destination Pubsub Subscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- Last
Modify stringTime - Timestamp when the subscription was last modified.
- Linked
Dataset List<ListingMaps Subscription Linked Dataset Map> - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- Linked
Resources List<ListingSubscription Linked Resource> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- Listing
Id string - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- Location string
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- Log
Linked boolDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- Name string
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- Organization
Display stringName - Display name of the project of this subscription.
- Organization
Id string - Organization of the project this subscription belongs to.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Resource
Type string - Listing shared asset type.
- State string
- Current state of the subscription.
- Subscriber
Contact string - Email of the subscriber.
- Subscription
Id string - The subscription id used to reference the subscription.
- Commercial
Infos []ListingSubscription Commercial Info Args - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- Creation
Time string - Timestamp when the subscription was created.
- Data
Exchange stringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- Destination
Dataset ListingSubscription Destination Dataset Args - The destination dataset for this subscription. Structure is documented below.
- Destination
Pubsub ListingSubscription Subscription Destination Pubsub Subscription Args - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- Last
Modify stringTime - Timestamp when the subscription was last modified.
- Linked
Dataset []ListingMaps Subscription Linked Dataset Map Args - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- Linked
Resources []ListingSubscription Linked Resource Args - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- Listing
Id string - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- Location string
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- Log
Linked boolDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- Name string
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- Organization
Display stringName - Display name of the project of this subscription.
- Organization
Id string - Organization of the project this subscription belongs to.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Resource
Type string - Listing shared asset type.
- State string
- Current state of the subscription.
- Subscriber
Contact string - Email of the subscriber.
- Subscription
Id string - The subscription id used to reference the subscription.
- commercial_
infos list(object) - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation_
time string - Timestamp when the subscription was created.
- data_
exchange_ stringid - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- deletion_
policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination_
dataset object - The destination dataset for this subscription. Structure is documented below.
- destination_
pubsub_ objectsubscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- last_
modify_ stringtime - Timestamp when the subscription was last modified.
- linked_
dataset_ list(object)maps - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked_
resources list(object) - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- listing_
id string - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location string
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- log_
linked_ booldataset_ query_ user_ email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name string
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization_
display_ stringname - Display name of the project of this subscription.
- organization_
id string - Organization of the project this subscription belongs to.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource_
type string - Listing shared asset type.
- state string
- Current state of the subscription.
- subscriber_
contact string - Email of the subscriber.
- subscription_
id string - The subscription id used to reference the subscription.
- commercial
Infos List<ListingSubscription Commercial Info> - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation
Time String - Timestamp when the subscription was created.
- data
Exchange StringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset ListingSubscription Destination Dataset - The destination dataset for this subscription. Structure is documented below.
- destination
Pubsub ListingSubscription Subscription Destination Pubsub Subscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- last
Modify StringTime - Timestamp when the subscription was last modified.
- linked
Dataset List<ListingMaps Subscription Linked Dataset Map> - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked
Resources List<ListingSubscription Linked Resource> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- listing
Id String - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location String
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- log
Linked BooleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name String
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization
Display StringName - Display name of the project of this subscription.
- organization
Id String - Organization of the project this subscription belongs to.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Type String - Listing shared asset type.
- state String
- Current state of the subscription.
- subscriber
Contact String - Email of the subscriber.
- subscription
Id String - The subscription id used to reference the subscription.
- commercial
Infos ListingSubscription Commercial Info[] - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation
Time string - Timestamp when the subscription was created.
- data
Exchange stringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset ListingSubscription Destination Dataset - The destination dataset for this subscription. Structure is documented below.
- destination
Pubsub ListingSubscription Subscription Destination Pubsub Subscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- last
Modify stringTime - Timestamp when the subscription was last modified.
- linked
Dataset ListingMaps Subscription Linked Dataset Map[] - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked
Resources ListingSubscription Linked Resource[] - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- listing
Id string - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location string
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- log
Linked booleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name string
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization
Display stringName - Display name of the project of this subscription.
- organization
Id string - Organization of the project this subscription belongs to.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Type string - Listing shared asset type.
- state string
- Current state of the subscription.
- subscriber
Contact string - Email of the subscriber.
- subscription
Id string - The subscription id used to reference the subscription.
- commercial_
infos Sequence[ListingSubscription Commercial Info Args] - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation_
time str - Timestamp when the subscription was created.
- data_
exchange_ strid - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- deletion_
policy str - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination_
dataset ListingSubscription Destination Dataset Args - The destination dataset for this subscription. Structure is documented below.
- destination_
pubsub_ Listingsubscription Subscription Destination Pubsub Subscription Args - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- last_
modify_ strtime - Timestamp when the subscription was last modified.
- linked_
dataset_ Sequence[Listingmaps Subscription Linked Dataset Map Args] - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked_
resources Sequence[ListingSubscription Linked Resource Args] - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- listing_
id str - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location str
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- log_
linked_ booldataset_ query_ user_ email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name str
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization_
display_ strname - Display name of the project of this subscription.
- organization_
id str - Organization of the project this subscription belongs to.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource_
type str - Listing shared asset type.
- state str
- Current state of the subscription.
- subscriber_
contact str - Email of the subscriber.
- subscription_
id str - The subscription id used to reference the subscription.
- commercial
Infos List<Property Map> - Commercial info metadata for this subscription. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. Structure is documented below.
- creation
Time String - Timestamp when the subscription was created.
- data
Exchange StringId - The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset Property Map - The destination dataset for this subscription. Structure is documented below.
- destination
Pubsub Property MapSubscription - Destination Pub/Sub subscription to create for the subscriber. Structure is documented below.
- last
Modify StringTime - Timestamp when the subscription was last modified.
- linked
Dataset List<Property Map>Maps - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
- linked
Resources List<Property Map> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- listing
Id String - The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
- location String
- The name of the location of the data exchange. Distinct from the location of the destination data set.
- log
Linked BooleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for Listing.
- name String
- The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
- organization
Display StringName - Display name of the project of this subscription.
- organization
Id String - Organization of the project this subscription belongs to.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Type String - Listing shared asset type.
- state String
- Current state of the subscription.
- subscriber
Contact String - Email of the subscriber.
- subscription
Id String - The subscription id used to reference the subscription.
Supporting Types
ListingSubscriptionCommercialInfo, ListingSubscriptionCommercialInfoArgs
- Cloud
Marketplaces List<ListingSubscription Commercial Info Cloud Marketplace> - (Output) Cloud Marketplace commercial metadata for this subscription. Structure is documented below.
- Cloud
Marketplaces []ListingSubscription Commercial Info Cloud Marketplace - (Output) Cloud Marketplace commercial metadata for this subscription. Structure is documented below.
- cloud_
marketplaces list(object) - (Output) Cloud Marketplace commercial metadata for this subscription. Structure is documented below.
- cloud
Marketplaces List<ListingSubscription Commercial Info Cloud Marketplace> - (Output) Cloud Marketplace commercial metadata for this subscription. Structure is documented below.
- cloud
Marketplaces ListingSubscription Commercial Info Cloud Marketplace[] - (Output) Cloud Marketplace commercial metadata for this subscription. Structure is documented below.
- cloud_
marketplaces Sequence[ListingSubscription Commercial Info Cloud Marketplace] - (Output) Cloud Marketplace commercial metadata for this subscription. Structure is documented below.
- cloud
Marketplaces List<Property Map> - (Output) Cloud Marketplace commercial metadata for this subscription. Structure is documented below.
ListingSubscriptionCommercialInfoCloudMarketplace, ListingSubscriptionCommercialInfoCloudMarketplaceArgs
- Order string
- (Output) Resource name of the Marketplace Order.
- Order string
- (Output) Resource name of the Marketplace Order.
- order string
- (Output) Resource name of the Marketplace Order.
- order String
- (Output) Resource name of the Marketplace Order.
- order string
- (Output) Resource name of the Marketplace Order.
- order str
- (Output) Resource name of the Marketplace Order.
- order String
- (Output) Resource name of the Marketplace Order.
ListingSubscriptionDestinationDataset, ListingSubscriptionDestinationDatasetArgs
- Dataset
Reference ListingSubscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- Location string
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Description string
- A user-friendly description of the dataset.
- Friendly
Name string - A descriptive name for the dataset.
- Labels Dictionary<string, string>
- The labels associated with this dataset. You can use these to organize and group your datasets.
- Replica
Locations List<string> - List of regions where the subscriber wants dataset replicas.
- Dataset
Reference ListingSubscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- Location string
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Description string
- A user-friendly description of the dataset.
- Friendly
Name string - A descriptive name for the dataset.
- Labels map[string]string
- The labels associated with this dataset. You can use these to organize and group your datasets.
- Replica
Locations []string - List of regions where the subscriber wants dataset replicas.
- dataset_
reference object - A reference that identifies the destination dataset. Structure is documented below.
- location string
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description string
- A user-friendly description of the dataset.
- friendly_
name string - A descriptive name for the dataset.
- labels map(string)
- The labels associated with this dataset. You can use these to organize and group your datasets.
- replica_
locations list(string) - List of regions where the subscriber wants dataset replicas.
- dataset
Reference ListingSubscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- location String
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description String
- A user-friendly description of the dataset.
- friendly
Name String - A descriptive name for the dataset.
- labels Map<String,String>
- The labels associated with this dataset. You can use these to organize and group your datasets.
- replica
Locations List<String> - List of regions where the subscriber wants dataset replicas.
- dataset
Reference ListingSubscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- location string
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description string
- A user-friendly description of the dataset.
- friendly
Name string - A descriptive name for the dataset.
- labels {[key: string]: string}
- The labels associated with this dataset. You can use these to organize and group your datasets.
- replica
Locations string[] - List of regions where the subscriber wants dataset replicas.
- dataset_
reference ListingSubscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- location str
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description str
- A user-friendly description of the dataset.
- friendly_
name str - A descriptive name for the dataset.
- labels Mapping[str, str]
- The labels associated with this dataset. You can use these to organize and group your datasets.
- replica_
locations Sequence[str] - List of regions where the subscriber wants dataset replicas.
- dataset
Reference Property Map - A reference that identifies the destination dataset. Structure is documented below.
- location String
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description String
- A user-friendly description of the dataset.
- friendly
Name String - A descriptive name for the dataset.
- labels Map<String>
- The labels associated with this dataset. You can use these to organize and group your datasets.
- replica
Locations List<String> - List of regions where the subscriber wants dataset replicas.
ListingSubscriptionDestinationDatasetDatasetReference, ListingSubscriptionDestinationDatasetDatasetReferenceArgs
- dataset_
id string - A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project_
id string - The ID of the project containing this dataset.
- dataset_
id str - A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project_
id str - The ID of the project containing this dataset.
ListingSubscriptionDestinationPubsubSubscription, ListingSubscriptionDestinationPubsubSubscriptionArgs
- Pubsub
Subscription ListingSubscription Destination Pubsub Subscription Pubsub Subscription - Destination Pub/Sub subscription resource. Structure is documented below.
- Pubsub
Subscription ListingSubscription Destination Pubsub Subscription Pubsub Subscription - Destination Pub/Sub subscription resource. Structure is documented below.
- pubsub_
subscription object - Destination Pub/Sub subscription resource. Structure is documented below.
- pubsub
Subscription ListingSubscription Destination Pubsub Subscription Pubsub Subscription - Destination Pub/Sub subscription resource. Structure is documented below.
- pubsub
Subscription ListingSubscription Destination Pubsub Subscription Pubsub Subscription - Destination Pub/Sub subscription resource. Structure is documented below.
- pubsub_
subscription ListingSubscription Destination Pubsub Subscription Pubsub Subscription - Destination Pub/Sub subscription resource. Structure is documented below.
- pubsub
Subscription Property Map - Destination Pub/Sub subscription resource. Structure is documented below.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscription, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionArgs
- Name string
- Name of the subscription. Format is
projects/{project}/subscriptions/{sub}. - Ack
Deadline intSeconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to
acknowledge receipt before resending the message. In the interval after the message is delivered
and before it is acknowledged, it is considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is
used as the initial value for the ack deadline. To override this value for a given message, call
ModifyAckDeadlinewith the correspondingackIdif using non-streaming pull or send theackIdin aStreamingModifyAckDeadlineRequestif using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. - Bigquery
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Bigquery Config - If delivery to BigQuery is used with this subscription, this field is used to configure it. Structure is documented below.
- Cloud
Storage ListingConfig Subscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config - If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. Structure is documented below.
- Dead
Letter ListingPolicy Subscription Destination Pubsub Subscription Pubsub Subscription Dead Letter Policy - A policy that specifies the conditions for dead lettering messages in this subscription. If
deadLetterPolicyis not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. Structure is documented below. - Detached bool
- Indicates whether the subscription is detached from its topic. Detached subscriptions don't
receive messages from their topic and don't retain any backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. - Enable
Exactly boolOnce Delivery - If true, Pub/Sub provides the following guarantees for the delivery of a message with a given
value of
messageIdon this subscription: The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenableExactlyOnceDeliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessageIdvalues. - Enable
Message boolOrdering - If true, messages published with the same
orderingKeyinPubsubMessagewill be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. - Expiration
Policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Expiration Policy - A policy that specifies the conditions for this subscription's expiration. A subscription is
considered active as long as any connected subscriber is successfully consuming messages from
the subscription or is issuing operations on the subscription. If
expirationPolicyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpirationPolicy.ttlis 1 day. IfexpirationPolicyis set, butexpirationPolicy.ttlis not set, the subscription never expires. Structure is documented below. - Filter string
- An expression written in the Pub/Sub filter language. If non-empty, then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - Labels Dictionary<string, string>
- See Creating and managing labels.
- Message
Retention stringDuration - How long to retain unacknowledged messages in the subscription's backlog, from the moment a
message is published. If
retainAckedMessagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. - Push
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config - If push delivery is used with this subscription, this field is used to configure it. Structure is documented below.
- Retain
Acked boolMessages - Indicates whether to retain acknowledged messages. If true, then messages are not expunged from
the subscription's backlog, even if they are acknowledged, until they fall out of the
messageRetentionDurationwindow. This must be true if you would like to Seek to a timestamp in the past to replay previously-acknowledged messages. - Retry
Policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Retry Policy - A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Structure is documented below.
- Name string
- Name of the subscription. Format is
projects/{project}/subscriptions/{sub}. - Ack
Deadline intSeconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to
acknowledge receipt before resending the message. In the interval after the message is delivered
and before it is acknowledged, it is considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is
used as the initial value for the ack deadline. To override this value for a given message, call
ModifyAckDeadlinewith the correspondingackIdif using non-streaming pull or send theackIdin aStreamingModifyAckDeadlineRequestif using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. - Bigquery
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Bigquery Config - If delivery to BigQuery is used with this subscription, this field is used to configure it. Structure is documented below.
- Cloud
Storage ListingConfig Subscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config - If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. Structure is documented below.
- Dead
Letter ListingPolicy Subscription Destination Pubsub Subscription Pubsub Subscription Dead Letter Policy - A policy that specifies the conditions for dead lettering messages in this subscription. If
deadLetterPolicyis not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. Structure is documented below. - Detached bool
- Indicates whether the subscription is detached from its topic. Detached subscriptions don't
receive messages from their topic and don't retain any backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. - Enable
Exactly boolOnce Delivery - If true, Pub/Sub provides the following guarantees for the delivery of a message with a given
value of
messageIdon this subscription: The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenableExactlyOnceDeliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessageIdvalues. - Enable
Message boolOrdering - If true, messages published with the same
orderingKeyinPubsubMessagewill be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. - Expiration
Policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Expiration Policy - A policy that specifies the conditions for this subscription's expiration. A subscription is
considered active as long as any connected subscriber is successfully consuming messages from
the subscription or is issuing operations on the subscription. If
expirationPolicyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpirationPolicy.ttlis 1 day. IfexpirationPolicyis set, butexpirationPolicy.ttlis not set, the subscription never expires. Structure is documented below. - Filter string
- An expression written in the Pub/Sub filter language. If non-empty, then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - Labels map[string]string
- See Creating and managing labels.
- Message
Retention stringDuration - How long to retain unacknowledged messages in the subscription's backlog, from the moment a
message is published. If
retainAckedMessagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. - Push
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config - If push delivery is used with this subscription, this field is used to configure it. Structure is documented below.
- Retain
Acked boolMessages - Indicates whether to retain acknowledged messages. If true, then messages are not expunged from
the subscription's backlog, even if they are acknowledged, until they fall out of the
messageRetentionDurationwindow. This must be true if you would like to Seek to a timestamp in the past to replay previously-acknowledged messages. - Retry
Policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Retry Policy - A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Structure is documented below.
- name string
- Name of the subscription. Format is
projects/{project}/subscriptions/{sub}. - ack_
deadline_ numberseconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to
acknowledge receipt before resending the message. In the interval after the message is delivered
and before it is acknowledged, it is considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is
used as the initial value for the ack deadline. To override this value for a given message, call
ModifyAckDeadlinewith the correspondingackIdif using non-streaming pull or send theackIdin aStreamingModifyAckDeadlineRequestif using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. - bigquery_
config object - If delivery to BigQuery is used with this subscription, this field is used to configure it. Structure is documented below.
- cloud_
storage_ objectconfig - If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. Structure is documented below.
- dead_
letter_ objectpolicy - A policy that specifies the conditions for dead lettering messages in this subscription. If
deadLetterPolicyis not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. Structure is documented below. - detached bool
- Indicates whether the subscription is detached from its topic. Detached subscriptions don't
receive messages from their topic and don't retain any backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. - enable_
exactly_ boolonce_ delivery - If true, Pub/Sub provides the following guarantees for the delivery of a message with a given
value of
messageIdon this subscription: The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenableExactlyOnceDeliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessageIdvalues. - enable_
message_ boolordering - If true, messages published with the same
orderingKeyinPubsubMessagewill be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. - expiration_
policy object - A policy that specifies the conditions for this subscription's expiration. A subscription is
considered active as long as any connected subscriber is successfully consuming messages from
the subscription or is issuing operations on the subscription. If
expirationPolicyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpirationPolicy.ttlis 1 day. IfexpirationPolicyis set, butexpirationPolicy.ttlis not set, the subscription never expires. Structure is documented below. - filter string
- An expression written in the Pub/Sub filter language. If non-empty, then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - labels map(string)
- See Creating and managing labels.
- message_
retention_ stringduration - How long to retain unacknowledged messages in the subscription's backlog, from the moment a
message is published. If
retainAckedMessagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. - push_
config object - If push delivery is used with this subscription, this field is used to configure it. Structure is documented below.
- retain_
acked_ boolmessages - Indicates whether to retain acknowledged messages. If true, then messages are not expunged from
the subscription's backlog, even if they are acknowledged, until they fall out of the
messageRetentionDurationwindow. This must be true if you would like to Seek to a timestamp in the past to replay previously-acknowledged messages. - retry_
policy object - A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Structure is documented below.
- name String
- Name of the subscription. Format is
projects/{project}/subscriptions/{sub}. - ack
Deadline IntegerSeconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to
acknowledge receipt before resending the message. In the interval after the message is delivered
and before it is acknowledged, it is considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is
used as the initial value for the ack deadline. To override this value for a given message, call
ModifyAckDeadlinewith the correspondingackIdif using non-streaming pull or send theackIdin aStreamingModifyAckDeadlineRequestif using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. - bigquery
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Bigquery Config - If delivery to BigQuery is used with this subscription, this field is used to configure it. Structure is documented below.
- cloud
Storage ListingConfig Subscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config - If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. Structure is documented below.
- dead
Letter ListingPolicy Subscription Destination Pubsub Subscription Pubsub Subscription Dead Letter Policy - A policy that specifies the conditions for dead lettering messages in this subscription. If
deadLetterPolicyis not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. Structure is documented below. - detached Boolean
- Indicates whether the subscription is detached from its topic. Detached subscriptions don't
receive messages from their topic and don't retain any backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. - enable
Exactly BooleanOnce Delivery - If true, Pub/Sub provides the following guarantees for the delivery of a message with a given
value of
messageIdon this subscription: The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenableExactlyOnceDeliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessageIdvalues. - enable
Message BooleanOrdering - If true, messages published with the same
orderingKeyinPubsubMessagewill be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. - expiration
Policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Expiration Policy - A policy that specifies the conditions for this subscription's expiration. A subscription is
considered active as long as any connected subscriber is successfully consuming messages from
the subscription or is issuing operations on the subscription. If
expirationPolicyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpirationPolicy.ttlis 1 day. IfexpirationPolicyis set, butexpirationPolicy.ttlis not set, the subscription never expires. Structure is documented below. - filter String
- An expression written in the Pub/Sub filter language. If non-empty, then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - labels Map<String,String>
- See Creating and managing labels.
- message
Retention StringDuration - How long to retain unacknowledged messages in the subscription's backlog, from the moment a
message is published. If
retainAckedMessagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. - push
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config - If push delivery is used with this subscription, this field is used to configure it. Structure is documented below.
- retain
Acked BooleanMessages - Indicates whether to retain acknowledged messages. If true, then messages are not expunged from
the subscription's backlog, even if they are acknowledged, until they fall out of the
messageRetentionDurationwindow. This must be true if you would like to Seek to a timestamp in the past to replay previously-acknowledged messages. - retry
Policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Retry Policy - A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Structure is documented below.
- name string
- Name of the subscription. Format is
projects/{project}/subscriptions/{sub}. - ack
Deadline numberSeconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to
acknowledge receipt before resending the message. In the interval after the message is delivered
and before it is acknowledged, it is considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is
used as the initial value for the ack deadline. To override this value for a given message, call
ModifyAckDeadlinewith the correspondingackIdif using non-streaming pull or send theackIdin aStreamingModifyAckDeadlineRequestif using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. - bigquery
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Bigquery Config - If delivery to BigQuery is used with this subscription, this field is used to configure it. Structure is documented below.
- cloud
Storage ListingConfig Subscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config - If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. Structure is documented below.
- dead
Letter ListingPolicy Subscription Destination Pubsub Subscription Pubsub Subscription Dead Letter Policy - A policy that specifies the conditions for dead lettering messages in this subscription. If
deadLetterPolicyis not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. Structure is documented below. - detached boolean
- Indicates whether the subscription is detached from its topic. Detached subscriptions don't
receive messages from their topic and don't retain any backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. - enable
Exactly booleanOnce Delivery - If true, Pub/Sub provides the following guarantees for the delivery of a message with a given
value of
messageIdon this subscription: The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenableExactlyOnceDeliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessageIdvalues. - enable
Message booleanOrdering - If true, messages published with the same
orderingKeyinPubsubMessagewill be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. - expiration
Policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Expiration Policy - A policy that specifies the conditions for this subscription's expiration. A subscription is
considered active as long as any connected subscriber is successfully consuming messages from
the subscription or is issuing operations on the subscription. If
expirationPolicyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpirationPolicy.ttlis 1 day. IfexpirationPolicyis set, butexpirationPolicy.ttlis not set, the subscription never expires. Structure is documented below. - filter string
- An expression written in the Pub/Sub filter language. If non-empty, then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - labels {[key: string]: string}
- See Creating and managing labels.
- message
Retention stringDuration - How long to retain unacknowledged messages in the subscription's backlog, from the moment a
message is published. If
retainAckedMessagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. - push
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config - If push delivery is used with this subscription, this field is used to configure it. Structure is documented below.
- retain
Acked booleanMessages - Indicates whether to retain acknowledged messages. If true, then messages are not expunged from
the subscription's backlog, even if they are acknowledged, until they fall out of the
messageRetentionDurationwindow. This must be true if you would like to Seek to a timestamp in the past to replay previously-acknowledged messages. - retry
Policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Retry Policy - A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Structure is documented below.
- name str
- Name of the subscription. Format is
projects/{project}/subscriptions/{sub}. - ack_
deadline_ intseconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to
acknowledge receipt before resending the message. In the interval after the message is delivered
and before it is acknowledged, it is considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is
used as the initial value for the ack deadline. To override this value for a given message, call
ModifyAckDeadlinewith the correspondingackIdif using non-streaming pull or send theackIdin aStreamingModifyAckDeadlineRequestif using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. - bigquery_
config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Bigquery Config - If delivery to BigQuery is used with this subscription, this field is used to configure it. Structure is documented below.
- cloud_
storage_ Listingconfig Subscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config - If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. Structure is documented below.
- dead_
letter_ Listingpolicy Subscription Destination Pubsub Subscription Pubsub Subscription Dead Letter Policy - A policy that specifies the conditions for dead lettering messages in this subscription. If
deadLetterPolicyis not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. Structure is documented below. - detached bool
- Indicates whether the subscription is detached from its topic. Detached subscriptions don't
receive messages from their topic and don't retain any backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. - enable_
exactly_ boolonce_ delivery - If true, Pub/Sub provides the following guarantees for the delivery of a message with a given
value of
messageIdon this subscription: The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenableExactlyOnceDeliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessageIdvalues. - enable_
message_ boolordering - If true, messages published with the same
orderingKeyinPubsubMessagewill be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. - expiration_
policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Expiration Policy - A policy that specifies the conditions for this subscription's expiration. A subscription is
considered active as long as any connected subscriber is successfully consuming messages from
the subscription or is issuing operations on the subscription. If
expirationPolicyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpirationPolicy.ttlis 1 day. IfexpirationPolicyis set, butexpirationPolicy.ttlis not set, the subscription never expires. Structure is documented below. - filter str
- An expression written in the Pub/Sub filter language. If non-empty, then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - labels Mapping[str, str]
- See Creating and managing labels.
- message_
retention_ strduration - How long to retain unacknowledged messages in the subscription's backlog, from the moment a
message is published. If
retainAckedMessagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. - push_
config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config - If push delivery is used with this subscription, this field is used to configure it. Structure is documented below.
- retain_
acked_ boolmessages - Indicates whether to retain acknowledged messages. If true, then messages are not expunged from
the subscription's backlog, even if they are acknowledged, until they fall out of the
messageRetentionDurationwindow. This must be true if you would like to Seek to a timestamp in the past to replay previously-acknowledged messages. - retry_
policy ListingSubscription Destination Pubsub Subscription Pubsub Subscription Retry Policy - A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Structure is documented below.
- name String
- Name of the subscription. Format is
projects/{project}/subscriptions/{sub}. - ack
Deadline NumberSeconds - The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to
acknowledge receipt before resending the message. In the interval after the message is delivered
and before it is acknowledged, it is considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is
used as the initial value for the ack deadline. To override this value for a given message, call
ModifyAckDeadlinewith the correspondingackIdif using non-streaming pull or send theackIdin aStreamingModifyAckDeadlineRequestif using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. - bigquery
Config Property Map - If delivery to BigQuery is used with this subscription, this field is used to configure it. Structure is documented below.
- cloud
Storage Property MapConfig - If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. Structure is documented below.
- dead
Letter Property MapPolicy - A policy that specifies the conditions for dead lettering messages in this subscription. If
deadLetterPolicyis not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. Structure is documented below. - detached Boolean
- Indicates whether the subscription is detached from its topic. Detached subscriptions don't
receive messages from their topic and don't retain any backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. - enable
Exactly BooleanOnce Delivery - If true, Pub/Sub provides the following guarantees for the delivery of a message with a given
value of
messageIdon this subscription: The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenableExactlyOnceDeliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessageIdvalues. - enable
Message BooleanOrdering - If true, messages published with the same
orderingKeyinPubsubMessagewill be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. - expiration
Policy Property Map - A policy that specifies the conditions for this subscription's expiration. A subscription is
considered active as long as any connected subscriber is successfully consuming messages from
the subscription or is issuing operations on the subscription. If
expirationPolicyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpirationPolicy.ttlis 1 day. IfexpirationPolicyis set, butexpirationPolicy.ttlis not set, the subscription never expires. Structure is documented below. - filter String
- An expression written in the Pub/Sub filter language. If non-empty, then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - labels Map<String>
- See Creating and managing labels.
- message
Retention StringDuration - How long to retain unacknowledged messages in the subscription's backlog, from the moment a
message is published. If
retainAckedMessagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. - push
Config Property Map - If push delivery is used with this subscription, this field is used to configure it. Structure is documented below.
- retain
Acked BooleanMessages - Indicates whether to retain acknowledged messages. If true, then messages are not expunged from
the subscription's backlog, even if they are acknowledged, until they fall out of the
messageRetentionDurationwindow. This must be true if you would like to Seek to a timestamp in the past to replay previously-acknowledged messages. - retry
Policy Property Map - A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Structure is documented below.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionBigqueryConfig, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionBigqueryConfigArgs
- Drop
Unknown boolFields - When true and
useTopicSchemais true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. - Service
Account stringEmail - The service account to use to write to BigQuery. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. - Table string
- The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- Use
Table boolSchema - When true, use the BigQuery table's schema as the columns to write to in BigQuery.
useTableSchemaanduseTopicSchemacannot be enabled at the same time. - Use
Topic boolSchema - When true, use the topic's schema as the columns to write to in BigQuery,
if it exists.
useTopicSchemaanduseTableSchemacannot be enabled at the same time. - Write
Metadata bool - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey to additional columns in the table. The subscription name, message_id, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
- Drop
Unknown boolFields - When true and
useTopicSchemais true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. - Service
Account stringEmail - The service account to use to write to BigQuery. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. - Table string
- The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- Use
Table boolSchema - When true, use the BigQuery table's schema as the columns to write to in BigQuery.
useTableSchemaanduseTopicSchemacannot be enabled at the same time. - Use
Topic boolSchema - When true, use the topic's schema as the columns to write to in BigQuery,
if it exists.
useTopicSchemaanduseTableSchemacannot be enabled at the same time. - Write
Metadata bool - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey to additional columns in the table. The subscription name, message_id, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
- drop_
unknown_ boolfields - When true and
useTopicSchemais true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. - service_
account_ stringemail - The service account to use to write to BigQuery. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. - table string
- The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- use_
table_ boolschema - When true, use the BigQuery table's schema as the columns to write to in BigQuery.
useTableSchemaanduseTopicSchemacannot be enabled at the same time. - use_
topic_ boolschema - When true, use the topic's schema as the columns to write to in BigQuery,
if it exists.
useTopicSchemaanduseTableSchemacannot be enabled at the same time. - write_
metadata bool - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey to additional columns in the table. The subscription name, message_id, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
- drop
Unknown BooleanFields - When true and
useTopicSchemais true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. - service
Account StringEmail - The service account to use to write to BigQuery. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. - table String
- The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- use
Table BooleanSchema - When true, use the BigQuery table's schema as the columns to write to in BigQuery.
useTableSchemaanduseTopicSchemacannot be enabled at the same time. - use
Topic BooleanSchema - When true, use the topic's schema as the columns to write to in BigQuery,
if it exists.
useTopicSchemaanduseTableSchemacannot be enabled at the same time. - write
Metadata Boolean - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey to additional columns in the table. The subscription name, message_id, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
- drop
Unknown booleanFields - When true and
useTopicSchemais true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. - service
Account stringEmail - The service account to use to write to BigQuery. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. - table string
- The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- use
Table booleanSchema - When true, use the BigQuery table's schema as the columns to write to in BigQuery.
useTableSchemaanduseTopicSchemacannot be enabled at the same time. - use
Topic booleanSchema - When true, use the topic's schema as the columns to write to in BigQuery,
if it exists.
useTopicSchemaanduseTableSchemacannot be enabled at the same time. - write
Metadata boolean - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey to additional columns in the table. The subscription name, message_id, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
- drop_
unknown_ boolfields - When true and
useTopicSchemais true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. - service_
account_ stremail - The service account to use to write to BigQuery. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. - table str
- The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- use_
table_ boolschema - When true, use the BigQuery table's schema as the columns to write to in BigQuery.
useTableSchemaanduseTopicSchemacannot be enabled at the same time. - use_
topic_ boolschema - When true, use the topic's schema as the columns to write to in BigQuery,
if it exists.
useTopicSchemaanduseTableSchemacannot be enabled at the same time. - write_
metadata bool - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey to additional columns in the table. The subscription name, message_id, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
- drop
Unknown BooleanFields - When true and
useTopicSchemais true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. - service
Account StringEmail - The service account to use to write to BigQuery. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. - table String
- The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- use
Table BooleanSchema - When true, use the BigQuery table's schema as the columns to write to in BigQuery.
useTableSchemaanduseTopicSchemacannot be enabled at the same time. - use
Topic BooleanSchema - When true, use the topic's schema as the columns to write to in BigQuery,
if it exists.
useTopicSchemaanduseTableSchemacannot be enabled at the same time. - write
Metadata Boolean - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey to additional columns in the table. The subscription name, message_id, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfig, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigArgs
- Avro
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config Avro Config - If set, message data will be written to Cloud Storage in Avro format. Structure is documented below.
- Bucket string
- User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.
- Filename
Datetime stringFormat - User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
- Filename
Prefix string - User-provided prefix for Cloud Storage filename. See the object naming requirements.
- Filename
Suffix string - User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
- Max
Bytes string - The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The maxBytes limit may be exceeded in cases where messages are larger than the limit.
- Max
Duration string - The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
- Max
Messages string - The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- Service
Account stringEmail - The service account to use to write to Cloud Storage. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
- Avro
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config Avro Config - If set, message data will be written to Cloud Storage in Avro format. Structure is documented below.
- Bucket string
- User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.
- Filename
Datetime stringFormat - User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
- Filename
Prefix string - User-provided prefix for Cloud Storage filename. See the object naming requirements.
- Filename
Suffix string - User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
- Max
Bytes string - The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The maxBytes limit may be exceeded in cases where messages are larger than the limit.
- Max
Duration string - The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
- Max
Messages string - The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- Service
Account stringEmail - The service account to use to write to Cloud Storage. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
- avro_
config object - If set, message data will be written to Cloud Storage in Avro format. Structure is documented below.
- bucket string
- User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.
- filename_
datetime_ stringformat - User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
- filename_
prefix string - User-provided prefix for Cloud Storage filename. See the object naming requirements.
- filename_
suffix string - User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
- max_
bytes string - The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The maxBytes limit may be exceeded in cases where messages are larger than the limit.
- max_
duration string - The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
- max_
messages string - The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- service_
account_ stringemail - The service account to use to write to Cloud Storage. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
- avro
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config Avro Config - If set, message data will be written to Cloud Storage in Avro format. Structure is documented below.
- bucket String
- User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.
- filename
Datetime StringFormat - User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
- filename
Prefix String - User-provided prefix for Cloud Storage filename. See the object naming requirements.
- filename
Suffix String - User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
- max
Bytes String - The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The maxBytes limit may be exceeded in cases where messages are larger than the limit.
- max
Duration String - The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
- max
Messages String - The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- service
Account StringEmail - The service account to use to write to Cloud Storage. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
- avro
Config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config Avro Config - If set, message data will be written to Cloud Storage in Avro format. Structure is documented below.
- bucket string
- User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.
- filename
Datetime stringFormat - User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
- filename
Prefix string - User-provided prefix for Cloud Storage filename. See the object naming requirements.
- filename
Suffix string - User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
- max
Bytes string - The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The maxBytes limit may be exceeded in cases where messages are larger than the limit.
- max
Duration string - The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
- max
Messages string - The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- service
Account stringEmail - The service account to use to write to Cloud Storage. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
- avro_
config ListingSubscription Destination Pubsub Subscription Pubsub Subscription Cloud Storage Config Avro Config - If set, message data will be written to Cloud Storage in Avro format. Structure is documented below.
- bucket str
- User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.
- filename_
datetime_ strformat - User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
- filename_
prefix str - User-provided prefix for Cloud Storage filename. See the object naming requirements.
- filename_
suffix str - User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
- max_
bytes str - The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The maxBytes limit may be exceeded in cases where messages are larger than the limit.
- max_
duration str - The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
- max_
messages str - The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- service_
account_ stremail - The service account to use to write to Cloud Storage. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
- avro
Config Property Map - If set, message data will be written to Cloud Storage in Avro format. Structure is documented below.
- bucket String
- User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.
- filename
Datetime StringFormat - User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
- filename
Prefix String - User-provided prefix for Cloud Storage filename. See the object naming requirements.
- filename
Suffix String - User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
- max
Bytes String - The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The maxBytes limit may be exceeded in cases where messages are larger than the limit.
- max
Duration String - The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
- max
Messages String - The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- service
Account StringEmail - The service account to use to write to Cloud Storage. The subscription creator or updater that
specifies this field must have
iam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigAvroConfig, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionCloudStorageConfigAvroConfigArgs
- Use
Topic boolSchema - When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
- Write
Metadata bool - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey as additional fields in the output. The subscription name, message_id, and publishTime fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
- Use
Topic boolSchema - When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
- Write
Metadata bool - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey as additional fields in the output. The subscription name, message_id, and publishTime fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
- use_
topic_ boolschema - When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
- write_
metadata bool - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey as additional fields in the output. The subscription name, message_id, and publishTime fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
- use
Topic BooleanSchema - When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
- write
Metadata Boolean - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey as additional fields in the output. The subscription name, message_id, and publishTime fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
- use
Topic booleanSchema - When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
- write
Metadata boolean - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey as additional fields in the output. The subscription name, message_id, and publishTime fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
- use_
topic_ boolschema - When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
- write_
metadata bool - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey as additional fields in the output. The subscription name, message_id, and publishTime fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
- use
Topic BooleanSchema - When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
- write
Metadata Boolean - When true, write the subscription name, message_id, publish_time, attributes, and orderingKey as additional fields in the output. The subscription name, message_id, and publishTime fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionDeadLetterPolicy, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionDeadLetterPolicyArgs
- Dead
Letter stringTopic - The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}. The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. - Max
Delivery intAttempts - The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
- Dead
Letter stringTopic - The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}. The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. - Max
Delivery intAttempts - The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
- dead_
letter_ stringtopic - The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}. The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. - max_
delivery_ numberattempts - The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
- dead
Letter StringTopic - The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}. The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. - max
Delivery IntegerAttempts - The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
- dead
Letter stringTopic - The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}. The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. - max
Delivery numberAttempts - The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
- dead_
letter_ strtopic - The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}. The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. - max_
delivery_ intattempts - The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
- dead
Letter StringTopic - The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}. The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. - max
Delivery NumberAttempts - The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionExpirationPolicy, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionExpirationPolicyArgs
- Ttl string
- Specifies the "time-to-live" duration for an associated resource. The resource expires if it
is not active for a period of
ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values forttldepend on the type of the associated resource, as well. Ifttlis not set, the associated resource never expires.
- Ttl string
- Specifies the "time-to-live" duration for an associated resource. The resource expires if it
is not active for a period of
ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values forttldepend on the type of the associated resource, as well. Ifttlis not set, the associated resource never expires.
- ttl string
- Specifies the "time-to-live" duration for an associated resource. The resource expires if it
is not active for a period of
ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values forttldepend on the type of the associated resource, as well. Ifttlis not set, the associated resource never expires.
- ttl String
- Specifies the "time-to-live" duration for an associated resource. The resource expires if it
is not active for a period of
ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values forttldepend on the type of the associated resource, as well. Ifttlis not set, the associated resource never expires.
- ttl string
- Specifies the "time-to-live" duration for an associated resource. The resource expires if it
is not active for a period of
ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values forttldepend on the type of the associated resource, as well. Ifttlis not set, the associated resource never expires.
- ttl str
- Specifies the "time-to-live" duration for an associated resource. The resource expires if it
is not active for a period of
ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values forttldepend on the type of the associated resource, as well. Ifttlis not set, the associated resource never expires.
- ttl String
- Specifies the "time-to-live" duration for an associated resource. The resource expires if it
is not active for a period of
ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values forttldepend on the type of the associated resource, as well. Ifttlis not set, the associated resource never expires.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfig, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigArgs
- Attributes Dictionary<string, string>
- Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is
x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during theCreateSubscriptioncall, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfigcall, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription was created without this attribute. The only supported values for thex-goog-versionattribute are:v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. - No
Wrapper ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config No Wrapper - When set, the payload to the push endpoint is not wrapped. Structure is documented below.
- Oidc
Token ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config Oidc Token - If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. Structure is documented below.
- Push
Endpoint string - A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use
https://example.com/push.
- Attributes map[string]string
- Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is
x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during theCreateSubscriptioncall, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfigcall, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription was created without this attribute. The only supported values for thex-goog-versionattribute are:v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. - No
Wrapper ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config No Wrapper - When set, the payload to the push endpoint is not wrapped. Structure is documented below.
- Oidc
Token ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config Oidc Token - If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. Structure is documented below.
- Push
Endpoint string - A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use
https://example.com/push.
- attributes map(string)
- Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is
x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during theCreateSubscriptioncall, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfigcall, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription was created without this attribute. The only supported values for thex-goog-versionattribute are:v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. - no_
wrapper object - When set, the payload to the push endpoint is not wrapped. Structure is documented below.
- oidc_
token object - If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. Structure is documented below.
- push_
endpoint string - A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use
https://example.com/push.
- attributes Map<String,String>
- Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is
x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during theCreateSubscriptioncall, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfigcall, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription was created without this attribute. The only supported values for thex-goog-versionattribute are:v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. - no
Wrapper ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config No Wrapper - When set, the payload to the push endpoint is not wrapped. Structure is documented below.
- oidc
Token ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config Oidc Token - If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. Structure is documented below.
- push
Endpoint String - A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use
https://example.com/push.
- attributes {[key: string]: string}
- Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is
x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during theCreateSubscriptioncall, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfigcall, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription was created without this attribute. The only supported values for thex-goog-versionattribute are:v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. - no
Wrapper ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config No Wrapper - When set, the payload to the push endpoint is not wrapped. Structure is documented below.
- oidc
Token ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config Oidc Token - If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. Structure is documented below.
- push
Endpoint string - A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use
https://example.com/push.
- attributes Mapping[str, str]
- Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is
x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during theCreateSubscriptioncall, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfigcall, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription was created without this attribute. The only supported values for thex-goog-versionattribute are:v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. - no_
wrapper ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config No Wrapper - When set, the payload to the push endpoint is not wrapped. Structure is documented below.
- oidc_
token ListingSubscription Destination Pubsub Subscription Pubsub Subscription Push Config Oidc Token - If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. Structure is documented below.
- push_
endpoint str - A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use
https://example.com/push.
- attributes Map<String>
- Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is
x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during theCreateSubscriptioncall, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfigcall, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription was created without this attribute. The only supported values for thex-goog-versionattribute are:v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. - no
Wrapper Property Map - When set, the payload to the push endpoint is not wrapped. Structure is documented below.
- oidc
Token Property Map - If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. Structure is documented below.
- push
Endpoint String - A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use
https://example.com/push.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigNoWrapper, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigNoWrapperArgs
- Write
Metadata bool - When true, writes the Pub/Sub message metadata to
x-goog-pubsub-<KEY>:<VAL>headers of the HTTP request. Writes the Pub/Sub message attributes to<KEY>:<VAL>headers of the HTTP request.
- Write
Metadata bool - When true, writes the Pub/Sub message metadata to
x-goog-pubsub-<KEY>:<VAL>headers of the HTTP request. Writes the Pub/Sub message attributes to<KEY>:<VAL>headers of the HTTP request.
- write_
metadata bool - When true, writes the Pub/Sub message metadata to
x-goog-pubsub-<KEY>:<VAL>headers of the HTTP request. Writes the Pub/Sub message attributes to<KEY>:<VAL>headers of the HTTP request.
- write
Metadata Boolean - When true, writes the Pub/Sub message metadata to
x-goog-pubsub-<KEY>:<VAL>headers of the HTTP request. Writes the Pub/Sub message attributes to<KEY>:<VAL>headers of the HTTP request.
- write
Metadata boolean - When true, writes the Pub/Sub message metadata to
x-goog-pubsub-<KEY>:<VAL>headers of the HTTP request. Writes the Pub/Sub message attributes to<KEY>:<VAL>headers of the HTTP request.
- write_
metadata bool - When true, writes the Pub/Sub message metadata to
x-goog-pubsub-<KEY>:<VAL>headers of the HTTP request. Writes the Pub/Sub message attributes to<KEY>:<VAL>headers of the HTTP request.
- write
Metadata Boolean - When true, writes the Pub/Sub message metadata to
x-goog-pubsub-<KEY>:<VAL>headers of the HTTP request. Writes the Pub/Sub message attributes to<KEY>:<VAL>headers of the HTTP request.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigOidcToken, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionPushConfigOidcTokenArgs
- Audience string
- Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
- Service
Account stringEmail - Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
- Audience string
- Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
- Service
Account stringEmail - Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
- audience string
- Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
- service_
account_ stringemail - Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
- audience String
- Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
- service
Account StringEmail - Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
- audience string
- Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
- service
Account stringEmail - Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
- audience str
- Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
- service_
account_ stremail - Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
- audience String
- Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
- service
Account StringEmail - Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionRetryPolicy, ListingSubscriptionDestinationPubsubSubscriptionPubsubSubscriptionRetryPolicyArgs
- Maximum
Backoff string - The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- Minimum
Backoff string - The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
- Maximum
Backoff string - The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- Minimum
Backoff string - The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
- maximum_
backoff string - The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- minimum_
backoff string - The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
- maximum
Backoff String - The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- minimum
Backoff String - The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
- maximum
Backoff string - The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- minimum
Backoff string - The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
- maximum_
backoff str - The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- minimum_
backoff str - The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
- maximum
Backoff String - The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- minimum
Backoff String - The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
ListingSubscriptionLinkedDatasetMap, ListingSubscriptionLinkedDatasetMapArgs
- Resource
Name string - (Required) The identifier for this object. Format specified above.
- Linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- Linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- Listing string
- (Output) Output only. Listing for which linked resource is created.
- Resource
Name string - (Required) The identifier for this object. Format specified above.
- Linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- Linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- Listing string
- (Output) Output only. Listing for which linked resource is created.
- resource_
name string - (Required) The identifier for this object. Format specified above.
- linked_
dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked_
pubsub_ stringsubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing string
- (Output) Output only. Listing for which linked resource is created.
- resource
Name String - (Required) The identifier for this object. Format specified above.
- linked
Dataset String - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub StringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing String
- (Output) Output only. Listing for which linked resource is created.
- resource
Name string - (Required) The identifier for this object. Format specified above.
- linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing string
- (Output) Output only. Listing for which linked resource is created.
- resource_
name str - (Required) The identifier for this object. Format specified above.
- linked_
dataset str - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked_
pubsub_ strsubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing str
- (Output) Output only. Listing for which linked resource is created.
- resource
Name String - (Required) The identifier for this object. Format specified above.
- linked
Dataset String - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub StringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing String
- (Output) Output only. Listing for which linked resource is created.
ListingSubscriptionLinkedResource, ListingSubscriptionLinkedResourceArgs
- Linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- Linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- Listing string
- (Output) Output only. Listing for which linked resource is created.
- Linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- Linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- Listing string
- (Output) Output only. Listing for which linked resource is created.
- linked_
dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked_
pubsub_ stringsubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing string
- (Output) Output only. Listing for which linked resource is created.
- linked
Dataset String - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub StringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing String
- (Output) Output only. Listing for which linked resource is created.
- linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing string
- (Output) Output only. Listing for which linked resource is created.
- linked_
dataset str - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked_
pubsub_ strsubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing str
- (Output) Output only. Listing for which linked resource is created.
- linked
Dataset String - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub StringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/sub_id
- listing String
- (Output) Output only. Listing for which linked resource is created.
Import
ListingSubscription can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/subscriptions/{{subscription_id}}{{project}}/{{location}}/{{subscription_id}}{{location}}/{{subscription_id}}
When using the pulumi import command, ListingSubscription can be imported using one of the formats above. For example:
$ pulumi import gcp:bigqueryanalyticshub/listingSubscription:ListingSubscription default projects/{{project}}/locations/{{location}}/subscriptions/{{subscription_id}}
$ pulumi import gcp:bigqueryanalyticshub/listingSubscription:ListingSubscription default {{project}}/{{location}}/{{subscription_id}}
$ pulumi import gcp:bigqueryanalyticshub/listingSubscription:ListingSubscription default {{location}}/{{subscription_id}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
published on Wednesday, Nov 18, 2026 by Pulumi