ListingState class
Input properties used for looking up and filtering Listing resources.
Constructors
-
ListingState({Input<
bool?> ? allowOnlyMetadataSharing, Input<ListingBigqueryDataset?> ? bigqueryDataset, Input<List< ? categories, Input<String> ?>List< ? commercialInfos, Input<ListingCommercialInfo> ?>String?> ? dataExchangeId, Input<ListingDataProvider?> ? dataProvider, Input<bool?> ? deleteCommercial, Input<String?> ? deletionPolicy, Input<String?> ? description, Input<String?> ? discoveryType, Input<String?> ? displayName, Input<String?> ? documentation, Input<String?> ? icon, Input<String?> ? listingId, Input<String?> ? location, Input<bool?> ? logLinkedDatasetQueryUserEmail, Input<String?> ? name, Input<String?> ? primaryContact, Input<String?> ? project, Input<ListingPublisher?> ? publisher, Input<ListingPubsubTopic?> ? pubsubTopic, Input<String?> ? requestAccess, Input<ListingRestrictedExportConfig?> ? restrictedExportConfig, Input<String?> ? state}) -
Creates a new ListingState.
allowOnlyMetadataSharingIf true, the listing is only available to get the resource metadata. Listing is non subscribable.bigqueryDatasetShared dataset i.e. BigQuery dataset source.categoriesCategories of the listing. Up to two categories are allowed.commercialInfosCommercial info contains the information about the commercial data products associated with the listing.dataExchangeIdThe 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.dataProviderDetails of the data provider who owns the source data.deleteCommercialIf the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.deletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to DELETE.descriptionShort description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF).discoveryTypeSpecifies the type of discovery on the discovery page. Cannot be set for a restricted listing. Note that this does not control the visibility of the exchange/listing which is defined by IAM permission.displayNameHuman-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces.documentationDocumentation describing the listing.iconBase64 encoded image representing the listing.listingIdThe 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.locationThe name of the location this data exchange listing.logLinkedDatasetQueryUserEmailIf true, subscriber email logging is enabled and all queries on the linked dataset will log the email address of the querying user. Once enabled, this setting cannot be turned off.nameThe resource name of the listing. e.g. "projects/myproject/locations/US/dataExchanges/123/listings/456"primaryContactEmail or URL of the primary point of contact of the listing.projectThe ID of the project in which the resource belongs.publisherDetails of the publisher who owns the listing and who can share the source data.pubsubTopicPub/Sub topic source.requestAccessEmail or URL of the request access of the listing. Subscribers can use this reference to request access.restrictedExportConfigIf set, restricted export configuration will be propagated and enforced on the linked dataset.stateCurrent state of the listing.const -
ListingState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allowOnlyMetadataSharing
→ Input<
bool?> ? -
If true, the listing is only available to get the resource metadata. Listing is non subscribable.
final
-
bigqueryDataset
→ Input<
ListingBigqueryDataset?> ? -
Shared dataset i.e. BigQuery dataset source.
Structure is documented below.
final
-
categories
→ Input<
List< ?String> ?> -
Categories of the listing. Up to two categories are allowed.
final
-
commercialInfos
→ Input<
List< ?ListingCommercialInfo> ?> -
Commercial info contains the information about the commercial data products associated with the listing.
Structure is documented below.
final
-
dataExchangeId
→ Input<
String?> ? -
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.
final
-
dataProvider
→ Input<
ListingDataProvider?> ? -
Details of the data provider who owns the source data.
Structure is documented below.
final
-
deleteCommercial
→ Input<
bool?> ? -
If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.
final
-
deletionPolicy
→ Input<
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.
final
-
description
→ Input<
String?> ? -
Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF).
final
-
discoveryType
→ Input<
String?> ? -
Specifies the type of discovery on the discovery page. Cannot be set for a restricted listing. Note that this does not control the visibility of the exchange/listing which is defined by IAM permission.
Possible values are:
DISCOVERY_TYPE_PRIVATE,DISCOVERY_TYPE_PUBLIC.final -
displayName
→ Input<
String?> ? -
Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces.
final
-
documentation
→ Input<
String?> ? -
Documentation describing the listing.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
icon
→ Input<
String?> ? -
Base64 encoded image representing the listing.
final
-
listingId
→ Input<
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.
final
-
location
→ Input<
String?> ? -
The name of the location this data exchange listing.
final
-
logLinkedDatasetQueryUserEmail
→ Input<
bool?> ? -
If true, subscriber email logging is enabled and all queries on the linked dataset will log the email address of the querying user. Once enabled, this setting cannot be turned off.
final
-
name
→ Input<
String?> ? -
The resource name of the listing. e.g. "projects/myproject/locations/US/dataExchanges/123/listings/456"
final
-
primaryContact
→ Input<
String?> ? -
Email or URL of the primary point of contact of the listing.
final
-
project
→ Input<
String?> ? -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
final
-
publisher
→ Input<
ListingPublisher?> ? -
Details of the publisher who owns the listing and who can share the source data.
Structure is documented below.
final
-
pubsubTopic
→ Input<
ListingPubsubTopic?> ? -
Pub/Sub topic source.
Structure is documented below.
final
-
requestAccess
→ Input<
String?> ? -
Email or URL of the request access of the listing. Subscribers can use this reference to request access.
final
-
restrictedExportConfig
→ Input<
ListingRestrictedExportConfig?> ? -
If set, restricted export configuration will be propagated and enforced on the linked dataset.
Structure is documented below.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
→ Input<
String?> ? -
Current state of the listing.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited