Class: GoodData::AnalyticalDashboard

Inherits:
AnalyticalVisualizationObject show all
Defined in:
lib/gooddata/models/metadata/analytical_dashboard.rb

Constant Summary collapse

EMPTY_OBJECT = 
{
  'analyticalDashboard' => {
    'content' => {
      'filterContext' => '',
      'layout' => {},
      'widgets' => []
    },
    'meta' => {
      'deprecated' => '0',
      'summary' => '',
      'title' => ''
    }
  }
}
ASSIGNABLE_MEMBERS = 
%i[filterContext layout widgets deprecated summary title]

Constants inherited from MdObject

MdObject::IDENTIFIERS_CFG, MdObject::MD_OBJ_CTG

Constants included from Mixin::MdIdToUri

Mixin::MdIdToUri::IDENTIFIERS_CFG

Constants included from Mixin::MdObjectIndexer

Mixin::MdObjectIndexer::MD_OBJ_CTG

Constants included from Mixin::MdObjectQuery

Mixin::MdObjectQuery::ERROR_MESSAGE_NO_PROJECT

Instance Attribute Summary

Attributes inherited from Rest::Object

#client, #json, #project

Class Method Summary collapse

Methods inherited from MdObject

#==, #add_tag, #browser_uri, #delete, #deprecated, #deprecated=, find_replaceable_values, #get_flag?, #initialize, #listed?, #production, #production=, #project, #reload!, #remove_tag, replace, #replace, #replace!, replace_bracketed, replace_quoted, #restricted, #restricted=, #save, #save_as, #set_flag, #tag_set, #unlisted, #unlisted=, #validate

Methods included from Mixin::MdIdToUri

#identifier_to_uri

Methods included from Mixin::MdObjectIndexer

#[]

Methods included from Mixin::MdObjectQuery

#all, #dependency, #dependency?, #query, #usedby, #usedby?, #using, #using?

Methods included from Mixin::MdFinders

#find_by_identifier, #find_by_tag, #find_by_title, #find_first_by_identifier, #find_first_by_title

Methods included from Mixin::MdObjId

#uri_obj_id

Methods included from Mixin::MdGrantees

#change_permission, #grant, #grantees, #revoke

Methods included from Mixin::MdRelations

#dependency, #dependency?, #usedby, #usedby?, #using, #using?

Methods included from Mixin::ObjId

#obj_id

Methods included from Mixin::Links

#links

Methods inherited from Rest::Resource

#initialize

Methods inherited from Rest::Object

client, default_client, #initialize, #saved?

Methods included from Mixin::DataPropertyReader

#data_property_reader

Methods included from Mixin::DataPropertyWriter

#data_property_writer

Methods included from Mixin::MetaPropertyReader

#metadata_property_reader

Methods included from Mixin::MetaPropertyWriter

#metadata_property_writer

Methods included from Mixin::MetaGetter

#meta

Methods included from Mixin::DataGetter

#data

Methods included from Mixin::RootKeyGetter

#root_key

Methods included from Mixin::ContentGetter

#content

Constructor Details

This class inherits a constructor from GoodData::MdObject

Class Method Details

.all(options = { :client => GoodData.connection, :project => GoodData.project }) ⇒ Array<GoodData::AnalyticalDashboard>

Method intended to get all AnalyticalDashboard objects in a specified project

Parameters:

  • options (Hash) (defaults to: { :client => GoodData.connection, :project => GoodData.project }) —

    the options hash

Options Hash (options):

  • :full (Boolean) —

    with true value will pull in full objects. Default is false value

Returns:



35
36
37
 
# File 'lib/gooddata/models/metadata/analytical_dashboard.rb', line 35

def all(options = { :client => GoodData.connection, :project => GoodData.project })
  query('analyticalDashboard', AnalyticalDashboard, options)
end

.create(analytical_dashboard = {}, options = { :client => GoodData.client, :project => GoodData.project }) ⇒ Object

Create Analytical Dashboard in the specify project

Parameters:

  • analytical_dashboard (Hash) (defaults to: {}) —

    the data of object will be created

  • options (Hash) (defaults to: { :client => GoodData.client, :project => GoodData.project }) —

    The project that the object will be created in

Returns:

  • GoodData::AnalyticalDashboard object



44
45
46
 
# File 'lib/gooddata/models/metadata/analytical_dashboard.rb', line 44

def create(analytical_dashboard = {}, options = { :client => GoodData.client, :project => GoodData.project })
  GoodData::AnalyticalVisualizationObject.create(analytical_dashboard, AnalyticalDashboard, EMPTY_OBJECT, ASSIGNABLE_MEMBERS, options)
end