Reference documentation and code samples for the Analytics Hub V1beta1 API class Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange.
A data exchange is a container that enables data sharing. It contains a set of listings of the data sources along with descriptive information of the data exchange.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#description
def description() -> ::String
Returns
- (::String) — Optional. Short description of the data exchange 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.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Short description of the data exchange 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 data exchange 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.
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. Human-readable display name of the data exchange. 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.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. Human-readable display name of the data exchange. 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 data exchange. 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.
#documentation
def documentation() -> ::String
Returns
- (::String) — Optional. Documentation describing the data exchange.
#documentation=
def documentation=(value) -> ::String
Parameter
- value (::String) — Optional. Documentation describing the data exchange.
Returns
- (::String) — Optional. Documentation describing the data exchange.
#icon
def icon() -> ::String
Returns
- (::String) — Optional. Base64 encoded image representing the data exchange. 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.
#icon=
def icon=(value) -> ::String
Parameter
- value (::String) — Optional. Base64 encoded image representing the data exchange. 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 data exchange. 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.
#listing_count
def listing_count() -> ::Integer
Returns
- (::Integer) — Output only. Number of listings contained in the data exchange.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name of the data exchange.
e.g.
projects/myproject/locations/US/dataExchanges/123.
#primary_contact
def primary_contact() -> ::String
Returns
- (::String) — Optional. Email, URL or other reference of the primary point of contact of the data exchange Max Length: 1000 bytes.
#primary_contact=
def primary_contact=(value) -> ::String
Parameter
- value (::String) — Optional. Email, URL or other reference of the primary point of contact of the data exchange Max Length: 1000 bytes.
Returns
- (::String) — Optional. Email, URL or other reference of the primary point of contact of the data exchange Max Length: 1000 bytes.