Module: Google::Cloud::PubSub::V1::TopicAdmin::Paths

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

Overview

Path helper methods for the TopicAdmin API.

Instance Method Summary collapse

Instance Method Details

#crypto_key_path(project:, location:, key_ring:, crypto_key:) ⇒ ::String

Create a fully-qualified CryptoKey resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}

Parameters:

  • project (String)
  • location (String)
  • key_ring (String)
  • crypto_key (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

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

  "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}"
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) 


58
59
60
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/paths.rb', line 58

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

#schema_path(project:, schema:) ⇒ ::String

Create a fully-qualified Schema resource string.

The resource will be in the following format:

projects/{project}/schemas/{schema}

Parameters:

  • project (String)
  • schema (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


73
74
75
76
77
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/paths.rb', line 73

def schema_path project:, schema:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

  "projects/#{project}/schemas/#{schema}"
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) 


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

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) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/paths.rb', line 113

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