GoogleApi.AnalyticsHub.V1.Model.Subscription (google_api_analytics_hub v0.6.0)

View Source

A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.

Attributes

  • commercialInfo (type: GoogleApi.AnalyticsHub.V1.Model.GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfo.t, default: nil) - Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.
  • creationTime (type: DateTime.t, default: nil) - Output only. Timestamp when the subscription was created.
  • dataExchange (type: String.t, default: nil) - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
  • lastModifyTime (type: DateTime.t, default: nil) - Output only. Timestamp when the subscription was last modified.
  • linkedDatasetMap (type: %{optional(String.t) => GoogleApi.AnalyticsHub.V1.Model.LinkedResource.t}, default: nil) - 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 For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
  • linkedResources (type: list(GoogleApi.AnalyticsHub.V1.Model.LinkedResource.t), default: nil) - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.
  • listing (type: String.t, default: nil) - Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
  • logLinkedDatasetQueryUserEmail (type: boolean(), default: nil) - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
  • name (type: String.t, default: nil) - Output only. The resource name of the subscription. e.g. projects/myproject/locations/US/subscriptions/123.
  • organizationDisplayName (type: String.t, default: nil) - Output only. Display name of the project of this subscription.
  • organizationId (type: String.t, default: nil) - Output only. Organization of the project this subscription belongs to.
  • resourceType (type: String.t, default: nil) - Output only. Listing shared asset type.
  • state (type: String.t, default: nil) - Output only. Current state of the subscription.
  • subscriberContact (type: String.t, default: nil) - Output only. Email of the subscriber.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.AnalyticsHub.V1.Model.Subscription{
  commercialInfo:
    GoogleApi.AnalyticsHub.V1.Model.GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfo.t()
    | nil,
  creationTime: DateTime.t() | nil,
  dataExchange: String.t() | nil,
  lastModifyTime: DateTime.t() | nil,
  linkedDatasetMap:
    %{
      optional(String.t()) => GoogleApi.AnalyticsHub.V1.Model.LinkedResource.t()
    }
    | nil,
  linkedResources: [GoogleApi.AnalyticsHub.V1.Model.LinkedResource.t()] | nil,
  listing: String.t() | nil,
  logLinkedDatasetQueryUserEmail: boolean() | nil,
  name: String.t() | nil,
  organizationDisplayName: String.t() | nil,
  organizationId: String.t() | nil,
  resourceType: String.t() | nil,
  state: String.t() | nil,
  subscriberContact: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.