Module: Google::Cloud::Monitoring::V3::MetricService::Paths

Extended by:
Paths
Included in:
Client, Paths
Defined in:
lib/google/cloud/monitoring/v3/metric_service/paths.rb

Overview

Path helper methods for the MetricService API.

Instance Method Summary collapse

Instance Method Details

#folder_path(folder:) ⇒ ::String

Create a fully-qualified Folder resource string.

The resource will be in the following format:

folders/{folder}

Parameters:

  • folder (String)

Returns:

  • (::String) 


37
38
39
 
# File 'lib/google/cloud/monitoring/v3/metric_service/paths.rb', line 37

def folder_path folder:
  "folders/#{folder}"
end

#metric_descriptor_path(project: , metric_descriptor: ) ⇒ ::String #metric_descriptor_path(organization: , metric_descriptor: ) ⇒ ::String #metric_descriptor_path(folder: , metric_descriptor: ) ⇒ ::String

Create a fully-qualified MetricDescriptor resource string.

Overloads:

  • #metric_descriptor_path(project: , metric_descriptor: ) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/metricDescriptors/{metric_descriptor=**}

    Parameters:

    • project (String) (defaults to: )
    • metric_descriptor (String) (defaults to: )
  • #metric_descriptor_path(organization: , metric_descriptor: ) ⇒ ::String

    The resource will be in the following format:

    organizations/{organization}/metricDescriptors/{metric_descriptor=**}

    Parameters:

    • organization (String) (defaults to: )
    • metric_descriptor (String) (defaults to: )
  • #metric_descriptor_path(folder: , metric_descriptor: ) ⇒ ::String

    The resource will be in the following format:

    folders/{folder}/metricDescriptors/{metric_descriptor=**}

    Parameters:

    • folder (String) (defaults to: )
    • metric_descriptor (String) (defaults to: )

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/google/cloud/monitoring/v3/metric_service/paths.rb', line 69

def metric_descriptor_path **args
  resources = {
    "metric_descriptor:project" => (proc do |project:, metric_descriptor:|
      raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

      "projects/#{project}/metricDescriptors/#{metric_descriptor}"
    end),
    "metric_descriptor:organization" => (proc do |organization:, metric_descriptor:|
      raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"

      "organizations/#{organization}/metricDescriptors/#{metric_descriptor}"
    end),
    "folder:metric_descriptor" => (proc do |folder:, metric_descriptor:|
      raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"

      "folders/#{folder}/metricDescriptors/#{metric_descriptor}"
    end)
  }

  resource = resources[args.keys.sort.join(":")]
  raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
  resource.call(**args)
end

#monitored_resource_descriptor_path(project: , monitored_resource_descriptor: ) ⇒ ::String #monitored_resource_descriptor_path(organization: , monitored_resource_descriptor: ) ⇒ ::String #monitored_resource_descriptor_path(folder: , monitored_resource_descriptor: ) ⇒ ::String

Create a fully-qualified MonitoredResourceDescriptor resource string.

Overloads:

  • #monitored_resource_descriptor_path(project: , monitored_resource_descriptor: ) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}

    Parameters:

    • project (String) (defaults to: )
    • monitored_resource_descriptor (String) (defaults to: )
  • #monitored_resource_descriptor_path(organization: , monitored_resource_descriptor: ) ⇒ ::String

    The resource will be in the following format:

    organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}

    Parameters:

    • organization (String) (defaults to: )
    • monitored_resource_descriptor (String) (defaults to: )
  • #monitored_resource_descriptor_path(folder: , monitored_resource_descriptor: ) ⇒ ::String

    The resource will be in the following format:

    folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}

    Parameters:

    • folder (String) (defaults to: )
    • monitored_resource_descriptor (String) (defaults to: )

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/google/cloud/monitoring/v3/metric_service/paths.rb', line 121

def monitored_resource_descriptor_path **args
  resources = {
    "monitored_resource_descriptor:project" => (proc do |project:, monitored_resource_descriptor:|
      raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

      "projects/#{project}/monitoredResourceDescriptors/#{monitored_resource_descriptor}"
    end),
    "monitored_resource_descriptor:organization" => (proc do |organization:, monitored_resource_descriptor:|
      raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"

      "organizations/#{organization}/monitoredResourceDescriptors/#{monitored_resource_descriptor}"
    end),
    "folder:monitored_resource_descriptor" => (proc do |folder:, monitored_resource_descriptor:|
      raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"

      "folders/#{folder}/monitoredResourceDescriptors/#{monitored_resource_descriptor}"
    end)
  }

  resource = resources[args.keys.sort.join(":")]
  raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
  resource.call(**args)
end

#organization_path(organization:) ⇒ ::String

Create a fully-qualified Organization resource string.

The resource will be in the following format:

organizations/{organization}

Parameters:

  • organization (String)

Returns:

  • (::String) 


155
156
157
 
# File 'lib/google/cloud/monitoring/v3/metric_service/paths.rb', line 155

def organization_path organization:
  "organizations/#{organization}"
end

#project_path(project:) ⇒ ::String

Create a fully-qualified Project resource string.

The resource will be in the following format:

projects/{project}

Parameters:

  • project (String)

Returns:

  • (::String) 


169
170
171
 
# File 'lib/google/cloud/monitoring/v3/metric_service/paths.rb', line 169

def project_path project:
  "projects/#{project}"
end

#workspace_path(project: ) ⇒ ::String #workspace_path(workspace: ) ⇒ ::String

Create a fully-qualified Workspace resource string.

Overloads:

  • #workspace_path(project: ) ⇒ ::String

    The resource will be in the following format:

    projects/{project}

    Parameters:

    • project (String) (defaults to: )
  • #workspace_path(workspace: ) ⇒ ::String

    The resource will be in the following format:

    workspaces/{workspace}

    Parameters:

    • workspace (String) (defaults to: )

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/google/cloud/monitoring/v3/metric_service/paths.rb', line 191

def workspace_path **args
  resources = {
    "project" => (proc do |project:|
      "projects/#{project}"
    end),
    "workspace" => (proc do |workspace:|
      "workspaces/#{workspace}"
    end)
  }

  resource = resources[args.keys.sort.join(":")]
  raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
  resource.call(**args)
end