View Source GoogleApi.AnalyticsHub.V1beta1.Model.Listing (google_api_analytics_hub v0.5.0)

A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.

Attributes

  • bigqueryDataset (type: GoogleApi.AnalyticsHub.V1beta1.Model.BigQueryDatasetSource.t, default: nil) - Required. Shared dataset i.e. BigQuery dataset source.
  • categories (type: list(String.t), default: nil) - Optional. Categories of the listing. Up to two categories are allowed.
  • dataProvider (type: GoogleApi.AnalyticsHub.V1beta1.Model.DataProvider.t, default: nil) - Optional. Details of the data provider who owns the source data.
  • description (type: String.t, default: nil) - Optional. 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). Default value is an empty string. Max length: 2000 bytes.
  • displayName (type: String.t, default: nil) - Required. 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. Default value is an empty string. Max length: 63 bytes.
  • documentation (type: String.t, default: nil) - Optional. Documentation describing the listing.
  • icon (type: String.t, default: nil) - Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
  • name (type: String.t, default: nil) - Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456
  • primaryContact (type: String.t, default: nil) - Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
  • publisher (type: GoogleApi.AnalyticsHub.V1beta1.Model.Publisher.t, default: nil) - Optional. Details of the publisher who owns the listing and who can share the source data.
  • requestAccess (type: String.t, default: nil) - Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
  • restrictedExportConfig (type: GoogleApi.AnalyticsHub.V1beta1.Model.RestrictedExportConfig.t, default: nil) - Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. This is a required field for data clean room exchanges.
  • state (type: String.t, default: nil) - Output only. Current state of the listing.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.AnalyticsHub.V1beta1.Model.Listing{
  bigqueryDataset:
    GoogleApi.AnalyticsHub.V1beta1.Model.BigQueryDatasetSource.t() | nil,
  categories: [String.t()] | nil,
  dataProvider: GoogleApi.AnalyticsHub.V1beta1.Model.DataProvider.t() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  documentation: String.t() | nil,
  icon: String.t() | nil,
  name: String.t() | nil,
  primaryContact: String.t() | nil,
  publisher: GoogleApi.AnalyticsHub.V1beta1.Model.Publisher.t() | nil,
  requestAccess: String.t() | nil,
  restrictedExportConfig:
    GoogleApi.AnalyticsHub.V1beta1.Model.RestrictedExportConfig.t() | nil,
  state: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.