Class: DatadogAPIClient::V2::DashboardSharingAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/dashboard_sharing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ DashboardSharingAPI

Returns a new instance of DashboardSharingAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/dashboard_sharing_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/dashboard_sharing_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#list_shared_dashboards_by_dashboard_id(dashboard_id, opts = {}) ⇒ Object

List shared dashboards for a dashboard.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/dashboard_sharing_api.rb', line 29

def list_shared_dashboards_by_dashboard_id(dashboard_id, opts = {})
  data, _status_code, _headers = list_shared_dashboards_by_dashboard_id_with_http_info(dashboard_id, opts)
  data
end

#list_shared_dashboards_by_dashboard_id_with_http_info(dashboard_id, opts = {}) ⇒ Array<(ListSharedDashboardsResponse, Integer, Hash)>

List shared dashboards for a dashboard.

Retrieve shared dashboards associated with the specified dashboard.

Parameters:

  • dashboard_id (String) —

    ID of the dashboard.

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

    the optional parameters

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/datadog_api_client/v2/api/dashboard_sharing_api.rb', line 41

def list_shared_dashboards_by_dashboard_id_with_http_info(dashboard_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_shared_dashboards_by_dashboard_id".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_shared_dashboards_by_dashboard_id")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_shared_dashboards_by_dashboard_id"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardSharingAPI.list_shared_dashboards_by_dashboard_id ...'
  end
  # verify the required parameter 'dashboard_id' is set
  if @api_client.config.client_side_validation && dashboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_id' when calling DashboardSharingAPI.list_shared_dashboards_by_dashboard_id"
  end
  # resource path
  local_var_path = '/api/v2/dashboard/{dashboard_id}/shared'.sub('{dashboard_id}', CGI.escape(dashboard_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListSharedDashboardsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_shared_dashboards_by_dashboard_id,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardSharingAPI#list_shared_dashboards_by_dashboard_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end