Module: Google::Cloud::Chronicle::V1::NativeDashboardService::Paths

Extended by:
Paths
Included in:
Client, Paths, Rest::Client
Defined in:
lib/google/cloud/chronicle/v1/native_dashboard_service/paths.rb

Overview

Path helper methods for the NativeDashboardService API.

Instance Method Summary collapse

Instance Method Details

#dashboard_chart_path(project:, location:, instance:, chart:) ⇒ ::String

Create a fully-qualified DashboardChart resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}

Parameters:

  • project (String)
  • location (String)
  • instance (String)
  • chart (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


40
41
42
43
44
45
46
 
# File 'lib/google/cloud/chronicle/v1/native_dashboard_service/paths.rb', line 40

def dashboard_chart_path project:, location:, instance:, chart:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project}/locations/#{location}/instances/#{instance}/dashboardCharts/#{chart}"
end

#dashboard_query_path(project:, location:, instance:, query:) ⇒ ::String

Create a fully-qualified DashboardQuery resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}

Parameters:

  • project (String)
  • location (String)
  • instance (String)
  • query (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


61
62
63
64
65
66
67
 
# File 'lib/google/cloud/chronicle/v1/native_dashboard_service/paths.rb', line 61

def dashboard_query_path project:, location:, instance:, query:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project}/locations/#{location}/instances/#{instance}/dashboardQueries/#{query}"
end

#instance_path(project:, location:, instance:) ⇒ ::String

Create a fully-qualified Instance resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/instances/{instance}

Parameters:

  • project (String)
  • location (String)
  • instance (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


81
82
83
84
85
86
 
# File 'lib/google/cloud/chronicle/v1/native_dashboard_service/paths.rb', line 81

def instance_path project:, location:, instance:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"

  "projects/#{project}/locations/#{location}/instances/#{instance}"
end

#native_dashboard_path(project:, location:, instance:, dashboard:) ⇒ ::String

Create a fully-qualified NativeDashboard resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

Parameters:

  • project (String)
  • location (String)
  • instance (String)
  • dashboard (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


101
102
103
104
105
106
107
 
# File 'lib/google/cloud/chronicle/v1/native_dashboard_service/paths.rb', line 101

def native_dashboard_path project:, location:, instance:, dashboard:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project}/locations/#{location}/instances/#{instance}/nativeDashboards/#{dashboard}"
end