Class: Google::Cloud::Bigquery::DataExchange::V1beta1::Listing

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

Overview

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.

Defined Under Namespace

Modules: State Classes: BigQueryDatasetSource

Instance Attribute Summary collapse

Instance Attribute Details

#bigquery_dataset ⇒ ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing::BigQueryDatasetSource

Returns Required. Shared dataset i.e. BigQuery dataset source.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#categories ⇒ ::Array<::Google::Cloud::Bigquery::DataExchange::Common::Category>

Returns Optional. Categories of the Listing. Up to two categories are allowed.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#data_provider ⇒ ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataProvider

Returns Optional. The details of the Data Provider who owns the source data.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#description ⇒ ::String

Optional. Short description of the listing that can consist of sentences or paragraphs. The description must not contain Unicode non-characters as well as 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.

Returns:

  • (::String) —

    Optional. Short description of the listing that can consist of sentences or paragraphs. The description must not contain Unicode non-characters as well as 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.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#display_name ⇒ ::String

Returns Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.

Returns:

  • (::String) —

    Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#documentation ⇒ ::String

Returns Optional. Documentation describing the listing.

Returns:

  • (::String) —

    Optional. Documentation describing the listing.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#icon ⇒ ::String

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

Returns:

  • (::String) —

    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.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.

Returns:

  • (::String) —

    Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#primary_contact ⇒ ::String

Returns Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.

Returns:

  • (::String) —

    Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#publisher ⇒ ::Google::Cloud::Bigquery::DataExchange::V1beta1::Publisher

Returns Optional. The details of the Publisher who owns the listing and has rights to share the source data.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#request_access ⇒ ::String

Returns Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

Returns:

  • (::String) —

    Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end

#state ⇒ ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing::State (readonly)

Returns Output only. Current state of the Listing.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'proto_docs/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.rb', line 204

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

  # A reference to a Shared dataset. It's an existing BigQuery dataset with a
  # collection of objects, such as tables and views, that you want to share
  # with subscribers.
  # Upon subscription to a Listing, Data Exchange creates a Linked dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a "symbolic link" to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this Listing.
    ACTIVE = 1
  end
end