Module: Google::Cloud::Video::LiveStream::V1::LivestreamService::Paths

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

Overview

Path helper methods for the LivestreamService API.

Instance Method Summary collapse

Instance Method Details

#asset_path(project:, location:, asset:) ⇒ ::String

Create a fully-qualified Asset resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/assets/{asset}

Parameters:

  • project (String)
  • location (String)
  • asset (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


40
41
42
43
44
45
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 40

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

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

#channel_path(project:, location:, channel:) ⇒ ::String

Create a fully-qualified Channel resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/channels/{channel}

Parameters:

  • project (String)
  • location (String)
  • channel (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


59
60
61
62
63
64
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 59

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

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

#clip_path(project:, location:, channel:, clip:) ⇒ ::String

Create a fully-qualified Clip resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/channels/{channel}/clips/{clip}

Parameters:

  • project (String)
  • location (String)
  • channel (String)
  • clip (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


79
80
81
82
83
84
85
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 79

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

  "projects/#{project}/locations/#{location}/channels/#{channel}/clips/#{clip}"
end

#dvr_session_path(project:, location:, channel:, dvr_session:) ⇒ ::String

Create a fully-qualified DvrSession resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_session}

Parameters:

  • project (String)
  • location (String)
  • channel (String)
  • dvr_session (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


100
101
102
103
104
105
106
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 100

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

  "projects/#{project}/locations/#{location}/channels/#{channel}/dvrSessions/#{dvr_session}"
end

#event_path(project:, location:, channel:, event:) ⇒ ::String

Create a fully-qualified Event resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/channels/{channel}/events/{event}

Parameters:

  • project (String)
  • location (String)
  • channel (String)
  • event (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


121
122
123
124
125
126
127
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 121

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

  "projects/#{project}/locations/#{location}/channels/#{channel}/events/#{event}"
end

#input_path(project:, location:, input:) ⇒ ::String

Create a fully-qualified Input resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/inputs/{input}

Parameters:

  • project (String)
  • location (String)
  • input (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


141
142
143
144
145
146
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 141

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

  "projects/#{project}/locations/#{location}/inputs/#{input}"
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) 


159
160
161
162
163
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 159

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

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

#network_path(project:, network:) ⇒ ::String

Create a fully-qualified Network resource string.

The resource will be in the following format:

projects/{project}/global/networks/{network}

Parameters:

  • project (String)
  • network (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


176
177
178
179
180
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 176

def network_path project:, network:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

  "projects/#{project}/global/networks/#{network}"
end

#pool_path(project:, location:, pool:) ⇒ ::String

Create a fully-qualified Pool resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/pools/{pool}

Parameters:

  • project (String)
  • location (String)
  • pool (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


194
195
196
197
198
199
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 194

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

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

#secret_version_path(project:, secret:, version:) ⇒ ::String

Create a fully-qualified SecretVersion resource string.

The resource will be in the following format:

projects/{project}/secrets/{secret}/versions/{version}

Parameters:

  • project (String)
  • secret (String)
  • version (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


213
214
215
216
217
218
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/paths.rb', line 213

def secret_version_path project:, secret:, version:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "secret cannot contain /" if secret.to_s.include? "/"

  "projects/#{project}/secrets/#{secret}/versions/#{version}"
end