Class: Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb

Overview

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

Defined Under Namespace

Modules: State Classes: LinkedDatasetMapEntry, LinkedResource

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when the subscription was created.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#data_exchange ⇒ ::String (readonly)

Returns Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456.

Returns:

  • (::String) —

    Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#last_modify_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when the subscription was last modified.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#linked_dataset_map ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource} (readonly)

Returns 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.

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource}) —

    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.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#listing ⇒ ::String (readonly)

Returns Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789.

Returns:

  • (::String) —

    Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the subscription. e.g. projects/myproject/locations/US/subscriptions/123.

Returns:

  • (::String) —

    Output only. The resource name of the subscription. e.g. projects/myproject/locations/US/subscriptions/123.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#organization_display_name ⇒ ::String (readonly)

Returns Output only. Display name of the project of this subscription.

Returns:

  • (::String) —

    Output only. Display name of the project of this subscription.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#organization_id ⇒ ::String (readonly)

Returns Output only. Organization of the project this subscription belongs to.

Returns:

  • (::String) —

    Output only. Organization of the project this subscription belongs to.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#state ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::State (readonly)

Returns Output only. Current state of the subscription.

Returns:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end

#subscriber_contact ⇒ ::String (readonly)

Returns Output only. Email of the subscriber.

Returns:

  • (::String) —

    Output only. Email of the subscriber.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 426

class Subscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Reference to a linked resource tracked by this Subscription.
  # @!attribute [r] linked_dataset
  #   @return [::String]
  #     Output only. Name of the linked dataset, e.g.
  #     projects/subscriberproject/datasets/linked_dataset
  class LinkedResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
  class LinkedDatasetMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This subscription is active and the data is accessible.
    STATE_ACTIVE = 1

    # The data referenced by this subscription is out of date and should be
    # refreshed. This can happen when a data provider adds or removes datasets.
    STATE_STALE = 2

    # This subscription has been cancelled or revoked and the data is no longer
    # accessible.
    STATE_INACTIVE = 3
  end
end