Module: Google::Cloud::PubSub::V1::Subscriber::Paths

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

Overview

Path helper methods for the Subscriber API.

Instance Method Summary collapse

Instance Method Details

#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) 


37
38
39
 
# File 'lib/google/cloud/pubsub/v1/subscriber/paths.rb', line 37

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

#snapshot_path(project:, snapshot:) ⇒ ::String

Create a fully-qualified Snapshot resource string.

The resource will be in the following format:

projects/{project}/snapshots/{snapshot}

Parameters:

  • project (String)
  • snapshot (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


52
53
54
55
56
 
# File 'lib/google/cloud/pubsub/v1/subscriber/paths.rb', line 52

def snapshot_path project:, snapshot:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

  "projects/#{project}/snapshots/#{snapshot}"
end

#subscription_path(project:, subscription:) ⇒ ::String

Create a fully-qualified Subscription resource string.

The resource will be in the following format:

projects/{project}/subscriptions/{subscription}

Parameters:

  • project (String)
  • subscription (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


69
70
71
72
73
 
# File 'lib/google/cloud/pubsub/v1/subscriber/paths.rb', line 69

def subscription_path project:, subscription:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

  "projects/#{project}/subscriptions/#{subscription}"
end

#topic_path(project: , topic: ) ⇒ ::String #topic_path ⇒ ::String

Create a fully-qualified Topic resource string.

Overloads:

  • #topic_path(project: , topic: ) ⇒ ::String

    The resource will be in the following format:

    projects/{project}/topics/{topic}

    Parameters:

    • project (String) (defaults to: )
    • topic (String) (defaults to: )
  • #topic_path ⇒ ::String

    The resource will be in the following format:

    _deleted-topic_

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/pubsub/v1/subscriber/paths.rb', line 92

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

      "projects/#{project}/topics/#{topic}"
    end),
    "" => (proc do
      "_deleted-topic_"
    end)
  }

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