Module: Google::Cloud::ContactCenterInsights::V1::ContactCenterInsights::Paths

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

Overview

Path helper methods for the ContactCenterInsights API.

Instance Method Summary collapse

Instance Method Details

#analysis_path(project:, location:, conversation:, analysis:) ⇒ ::String #analysis_path(project:, location:, authorized_view_set:, authorized_view:, conversation:, analysis:) ⇒ ::String

Create a fully-qualified Analysis resource string.

Overloads:

  • #analysis_path(project:, location:, conversation:, analysis:) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

    Parameters:

    • project (String)
    • location (String)
    • conversation (String)
    • analysis (String)
  • #analysis_path(project:, location:, authorized_view_set:, authorized_view:, conversation:, analysis:) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}/conversations/{conversation}/analyses/{analysis}

    Parameters:

    • project (String)
    • location (String)
    • authorized_view_set (String)
    • authorized_view (String)
    • conversation (String)
    • analysis (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 53

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

      "projects/#{project}/locations/#{location}/conversations/#{conversation}/analyses/#{analysis}"
    end),
    "analysis:authorized_view:authorized_view_set:conversation:location:project" => (proc do |project:, location:, authorized_view_set:, authorized_view:, conversation:, analysis:|
      raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
      raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
      raise ::ArgumentError, "authorized_view_set cannot contain /" if authorized_view_set.to_s.include? "/"
      raise ::ArgumentError, "authorized_view cannot contain /" if authorized_view.to_s.include? "/"
      raise ::ArgumentError, "conversation cannot contain /" if conversation.to_s.include? "/"

      "projects/#{project}/locations/#{location}/authorizedViewSets/#{authorized_view_set}/authorizedViews/#{authorized_view}/conversations/#{conversation}/analyses/#{analysis}"
    end)
  }

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

#analysis_rule_path(project:, location:, analysis_rule:) ⇒ ::String

Create a fully-qualified AnalysisRule resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/analysisRules/{analysis_rule}

Parameters:

  • project (String)
  • location (String)
  • analysis_rule (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


90
91
92
93
94
95
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 90

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

  "projects/#{project}/locations/#{location}/analysisRules/#{analysis_rule}"
end

#conversation_path(project:, location:, conversation:) ⇒ ::String #conversation_path(project:, location:, authorized_view_set:, authorized_view:, conversation:) ⇒ ::String

Create a fully-qualified Conversation resource string.

Overloads:

  • #conversation_path(project:, location:, conversation:) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/locations/{location}/conversations/{conversation}

    Parameters:

    • project (String)
    • location (String)
    • conversation (String)
  • #conversation_path(project:, location:, authorized_view_set:, authorized_view:, conversation:) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}/conversations/{conversation}

    Parameters:

    • project (String)
    • location (String)
    • authorized_view_set (String)
    • authorized_view (String)
    • conversation (String)

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
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 121

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

      "projects/#{project}/locations/#{location}/conversations/#{conversation}"
    end),
    "authorized_view:authorized_view_set:conversation:location:project" => (proc do |project:, location:, authorized_view_set:, authorized_view:, conversation:|
      raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
      raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
      raise ::ArgumentError, "authorized_view_set cannot contain /" if authorized_view_set.to_s.include? "/"
      raise ::ArgumentError, "authorized_view cannot contain /" if authorized_view.to_s.include? "/"

      "projects/#{project}/locations/#{location}/authorizedViewSets/#{authorized_view_set}/authorizedViews/#{authorized_view}/conversations/#{conversation}"
    end)
  }

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

#conversation_profile_path(project:, location:, conversation_profile:) ⇒ ::String

Create a fully-qualified ConversationProfile resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}

Parameters:

  • project (String)
  • location (String)
  • conversation_profile (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


156
157
158
159
160
161
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 156

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

  "projects/#{project}/locations/#{location}/conversationProfiles/#{conversation_profile}"
end

#encryption_spec_path(project:, location:) ⇒ ::String

Create a fully-qualified EncryptionSpec resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/encryptionSpec

Parameters:

  • project (String)
  • location (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


174
175
176
177
178
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 174

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

  "projects/#{project}/locations/#{location}/encryptionSpec"
end

#feedback_label_path(project:, location:, conversation:, feedback_label:) ⇒ ::String #feedback_label_path(project:, location:, authorized_view_set:, authorized_view:, conversation:, feedback_label:) ⇒ ::String

Create a fully-qualified FeedbackLabel resource string.

Overloads:

  • #feedback_label_path(project:, location:, conversation:, feedback_label:) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}

    Parameters:

    • project (String)
    • location (String)
    • conversation (String)
    • feedback_label (String)
  • #feedback_label_path(project:, location:, authorized_view_set:, authorized_view:, conversation:, feedback_label:) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}/conversations/{conversation}/feedbackLabels/{feedback_label}

    Parameters:

    • project (String)
    • location (String)
    • authorized_view_set (String)
    • authorized_view (String)
    • conversation (String)
    • feedback_label (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 206

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

      "projects/#{project}/locations/#{location}/conversations/#{conversation}/feedbackLabels/#{feedback_label}"
    end),
    "authorized_view:authorized_view_set:conversation:feedback_label:location:project" => (proc do |project:, location:, authorized_view_set:, authorized_view:, conversation:, feedback_label:|
      raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
      raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
      raise ::ArgumentError, "authorized_view_set cannot contain /" if authorized_view_set.to_s.include? "/"
      raise ::ArgumentError, "authorized_view cannot contain /" if authorized_view.to_s.include? "/"
      raise ::ArgumentError, "conversation cannot contain /" if conversation.to_s.include? "/"

      "projects/#{project}/locations/#{location}/authorizedViewSets/#{authorized_view_set}/authorizedViews/#{authorized_view}/conversations/#{conversation}/feedbackLabels/#{feedback_label}"
    end)
  }

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

#issue_model_path(project:, location:, issue_model:) ⇒ ::String

Create a fully-qualified IssueModel resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/issueModels/{issue_model}

Parameters:

  • project (String)
  • location (String)
  • issue_model (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


264
265
266
267
268
269
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 264

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

  "projects/#{project}/locations/#{location}/issueModels/#{issue_model}"
end

#issue_path(project:, location:, issue_model:, issue:) ⇒ ::String

Create a fully-qualified Issue resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}

Parameters:

  • project (String)
  • location (String)
  • issue_model (String)
  • issue (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


244
245
246
247
248
249
250
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 244

def issue_path project:, location:, issue_model:, issue:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "issue_model cannot contain /" if issue_model.to_s.include? "/"

  "projects/#{project}/locations/#{location}/issueModels/#{issue_model}/issues/#{issue}"
end

#location_path(project:, location:) ⇒ ::String

Create a fully-qualified Location resource string.

The resource will be in the following format:

projects/{project}/locations/{location}

Parameters:

  • project (String)
  • location (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


282
283
284
285
286
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 282

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

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

#participant_path(project:, conversation:, participant:) ⇒ ::String #participant_path(project:, location:, conversation:, participant:) ⇒ ::String

Create a fully-qualified Participant resource string.

Overloads:

  • #participant_path(project:, conversation:, participant:) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/conversations/{conversation}/participants/{participant}

    Parameters:

    • project (String)
    • conversation (String)
    • participant (String)
  • #participant_path(project:, location:, conversation:, participant:) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}

    Parameters:

    • project (String)
    • location (String)
    • conversation (String)
    • participant (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 311

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

      "projects/#{project}/conversations/#{conversation}/participants/#{participant}"
    end),
    "conversation:location:participant:project" => (proc do |project:, location:, conversation:, participant:|
      raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
      raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
      raise ::ArgumentError, "conversation cannot contain /" if conversation.to_s.include? "/"

      "projects/#{project}/locations/#{location}/conversations/#{conversation}/participants/#{participant}"
    end)
  }

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

#phrase_matcher_path(project:, location:, phrase_matcher:) ⇒ ::String

Create a fully-qualified PhraseMatcher resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

Parameters:

  • project (String)
  • location (String)
  • phrase_matcher (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


345
346
347
348
349
350
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 345

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

  "projects/#{project}/locations/#{location}/phraseMatchers/#{phrase_matcher}"
end

#qa_question_path(project:, location:, qa_scorecard:, revision:, qa_question:) ⇒ ::String

Create a fully-qualified QaQuestion resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}

Parameters:

  • project (String)
  • location (String)
  • qa_scorecard (String)
  • revision (String)
  • qa_question (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


366
367
368
369
370
371
372
373
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 366

def qa_question_path project:, location:, qa_scorecard:, revision:, qa_question:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "qa_scorecard cannot contain /" if qa_scorecard.to_s.include? "/"
  raise ::ArgumentError, "revision cannot contain /" if revision.to_s.include? "/"

  "projects/#{project}/locations/#{location}/qaScorecards/#{qa_scorecard}/revisions/#{revision}/qaQuestions/#{qa_question}"
end

#qa_scorecard_path(project:, location:, qa_scorecard:) ⇒ ::String

Create a fully-qualified QaScorecard resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}

Parameters:

  • project (String)
  • location (String)
  • qa_scorecard (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


387
388
389
390
391
392
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 387

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

  "projects/#{project}/locations/#{location}/qaScorecards/#{qa_scorecard}"
end

#qa_scorecard_result_path(project:, location:, qa_scorecard_result:) ⇒ ::String

Create a fully-qualified QaScorecardResult resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}

Parameters:

  • project (String)
  • location (String)
  • qa_scorecard_result (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


406
407
408
409
410
411
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 406

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

  "projects/#{project}/locations/#{location}/qaScorecardResults/#{qa_scorecard_result}"
end

#qa_scorecard_revision_path(project:, location:, qa_scorecard:, revision:) ⇒ ::String

Create a fully-qualified QaScorecardRevision resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}

Parameters:

  • project (String)
  • location (String)
  • qa_scorecard (String)
  • revision (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


426
427
428
429
430
431
432
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 426

def qa_scorecard_revision_path project:, location:, qa_scorecard:, revision:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "qa_scorecard cannot contain /" if qa_scorecard.to_s.include? "/"

  "projects/#{project}/locations/#{location}/qaScorecards/#{qa_scorecard}/revisions/#{revision}"
end

#recognizer_path(project:, location:, recognizer:) ⇒ ::String

Create a fully-qualified Recognizer resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/recognizers/{recognizer}

Parameters:

  • project (String)
  • location (String)
  • recognizer (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


446
447
448
449
450
451
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 446

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

  "projects/#{project}/locations/#{location}/recognizers/#{recognizer}"
end

#settings_path(project:, location:) ⇒ ::String

Create a fully-qualified Settings resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/settings

Parameters:

  • project (String)
  • location (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


464
465
466
467
468
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 464

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

  "projects/#{project}/locations/#{location}/settings"
end

#view_path(project:, location:, view:) ⇒ ::String

Create a fully-qualified View resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/views/{view}

Parameters:

  • project (String)
  • location (String)
  • view (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


482
483
484
485
486
487
 
# File 'lib/google/cloud/contact_center_insights/v1/contact_center_insights/paths.rb', line 482

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

  "projects/#{project}/locations/#{location}/views/#{view}"
end