Class: Google::Apis::AnalyticshubV1::DataExchange

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticshub_v1/classes.rb,
lib/google/apis/analyticshub_v1/representations.rb,
lib/google/apis/analyticshub_v1/representations.rb

Overview

A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DataExchange

Returns a new instance of DataExchange.



279
280
281
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 279

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

Optional. Description of the data exchange. 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. Corresponds to the JSON property description

Returns:

  • (String) 


231
232
233
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 231

def description
  @description
end

#display_name ⇒ String

Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


239
240
241
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 239

def display_name
  @display_name
end

#documentation ⇒ String

Optional. Documentation describing the data exchange. Corresponds to the JSON property documentation

Returns:

  • (String) 


244
245
246
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 244

def documentation
  @documentation
end

#icon ⇒ 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 content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. Corresponds to the JSON property icon NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


254
255
256
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 254

def icon
  @icon
end

#listing_count ⇒ Fixnum

Output only. Number of listings contained in the data exchange. Corresponds to the JSON property listingCount

Returns:

  • (Fixnum) 


259
260
261
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 259

def listing_count
  @listing_count
end

#name ⇒ String

Output only. The resource name of the data exchange. e.g. projects/myproject/ locations/US/dataExchanges/123. Corresponds to the JSON property name

Returns:

  • (String) 


265
266
267
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 265

def name
  @name
end

#primary_contact ⇒ String

Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. Corresponds to the JSON property primaryContact

Returns:

  • (String) 


271
272
273
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 271

def primary_contact
  @primary_contact
end

#sharing_environment_config ⇒ Google::Apis::AnalyticshubV1::SharingEnvironmentConfig

Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. Corresponds to the JSON property sharingEnvironmentConfig

Returns:



277
278
279
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 277

def sharing_environment_config
  @sharing_environment_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



284
285
286
287
288
289
290
291
292
293
 
# File 'lib/google/apis/analyticshub_v1/classes.rb', line 284

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @documentation = args[:documentation] if args.key?(:documentation)
  @icon = args[:icon] if args.key?(:icon)
  @listing_count = args[:listing_count] if args.key?(:listing_count)
  @name = args[:name] if args.key?(:name)
  @primary_contact = args[:primary_contact] if args.key?(:primary_contact)
  @sharing_environment_config = args[:sharing_environment_config] if args.key?(:sharing_environment_config)
end