Class: Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb

Overview

REST client for the LivestreamService service.

Using Live Stream API, you can generate live streams in the various renditions and streaming formats. The streaming format include HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send a source stream in the various ways, including Real-Time Messaging Protocol (RTMP) and Secure Reliable Transport (SRT).

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#asset_path, #channel_path, #clip_path, #event_path, #input_path, #location_path, #network_path, #pool_path, #secret_version_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new LivestreamService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the LivestreamService client.

Yield Parameters:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 182

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @livestream_service_stub = ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @livestream_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @livestream_service_stub.endpoint
    config.universe_domain = @livestream_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @livestream_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Rest::Client) 


252
253
254
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 252

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



245
246
247
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 245

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the LivestreamService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all LivestreamService clients
::Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 70

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Video", "LiveStream", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.create_channel.timeout = 60.0

    default_config.rpcs.list_channels.timeout = 60.0
    default_config.rpcs.list_channels.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_channel.timeout = 60.0
    default_config.rpcs.get_channel.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_channel.timeout = 60.0

    default_config.rpcs.update_channel.timeout = 60.0

    default_config.rpcs.start_channel.timeout = 60.0

    default_config.rpcs.stop_channel.timeout = 60.0

    default_config.rpcs.create_input.timeout = 60.0

    default_config.rpcs.list_inputs.timeout = 60.0
    default_config.rpcs.list_inputs.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_input.timeout = 60.0
    default_config.rpcs.get_input.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_input.timeout = 60.0

    default_config.rpcs.update_input.timeout = 60.0

    default_config.rpcs.create_event.timeout = 60.0

    default_config.rpcs.list_events.timeout = 60.0
    default_config.rpcs.list_events.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_event.timeout = 60.0
    default_config.rpcs.get_event.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_event.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the LivestreamService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



152
153
154
155
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 152

def configure
  yield @config if block_given?
  @config
end

#create_asset(request, options = nil) ⇒ ::Gapic::Operation #create_asset(parent: nil, asset: nil, asset_id: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a Asset with the provided unique ID in the specified region.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::CreateAssetRequest.new

# Call the create_asset method.
result = client.create_asset request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_asset(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_asset via a request object, either of type CreateAssetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::CreateAssetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_asset(parent: nil, asset: nil, asset_id: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_asset via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

    • asset (::Google::Cloud::Video::LiveStream::V1::Asset, ::Hash) (defaults to: nil) —

      Required. The asset resource to be created.

    • asset_id (::String) (defaults to: nil) —

      Required. The ID of the asset resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 2304

def create_asset request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::CreateAssetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_asset.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_asset.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_asset.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.create_asset request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_channel(request, options = nil) ⇒ ::Gapic::Operation #create_channel(parent: nil, channel: nil, channel_id: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a channel with the provided unique ID in the specified region.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::CreateChannelRequest.new

# Call the create_channel method.
result = client.create_channel request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_channel(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_channel via a request object, either of type CreateChannelRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::CreateChannelRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_channel(parent: nil, channel: nil, channel_id: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

    • channel (::Google::Cloud::Video::LiveStream::V1::Channel, ::Hash) (defaults to: nil) —

      Required. The channel resource to be created.

    • channel_id (::String) (defaults to: nil) —

      Required. The ID of the channel resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 337

def create_channel request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::CreateChannelRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_channel.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_channel.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_channel.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.create_channel request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_clip(request, options = nil) ⇒ ::Gapic::Operation #create_clip(parent: nil, clip_id: nil, clip: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a clip with the provided clip ID in the specified channel.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::CreateClipRequest.new

# Call the create_clip method.
result = client.create_clip request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_clip(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_clip via a request object, either of type CreateClipRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::CreateClipRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_clip(parent: nil, clip_id: nil, clip: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_clip via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, in the following form: projects/{project}/locations/{location}/channels/{channel}.

    • clip_id (::String) (defaults to: nil) —

      Required. Id of the requesting object in the following form:

      1. 1 character minimum, 63 characters maximum
      2. Only contains letters, digits, underscores, and hyphens
    • clip (::Google::Cloud::Video::LiveStream::V1::Clip, ::Hash) (defaults to: nil) —

      Required. The resource being created

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 2092

def create_clip request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::CreateClipRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_clip.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_clip.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_clip.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.create_clip request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_event(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Event #create_event(parent: nil, event: nil, event_id: nil, request_id: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Event

Creates an event with the provided unique ID in the specified channel.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::CreateEventRequest.new

# Call the create_event method.
result = client.create_event request

# The returned object is of type Google::Cloud::Video::LiveStream::V1::Event.
p result

Overloads:

  • #create_event(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Event

    Pass arguments to create_event via a request object, either of type CreateEventRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::CreateEventRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_event(parent: nil, event: nil, event_id: nil, request_id: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Event

    Pass arguments to create_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

    • event (::Google::Cloud::Video::LiveStream::V1::Event, ::Hash) (defaults to: nil) —

      Required. The event resource to be created.

    • event_id (::String) (defaults to: nil) —

      Required. The ID of the event resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1547

def create_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::CreateEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_event.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_event.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.create_event request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_input(request, options = nil) ⇒ ::Gapic::Operation #create_input(parent: nil, input: nil, input_id: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates an input with the provided unique ID in the specified region.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::CreateInputRequest.new

# Call the create_input method.
result = client.create_input request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_input(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_input via a request object, either of type CreateInputRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::CreateInputRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_input(parent: nil, input: nil, input_id: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_input via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

    • input (::Google::Cloud::Video::LiveStream::V1::Input, ::Hash) (defaults to: nil) —

      Required. The input resource to be created.

    • input_id (::String) (defaults to: nil) —

      Required. The ID of the input resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1055

def create_input request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::CreateInputRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_input.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_input.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_input.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.create_input request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_asset(request, options = nil) ⇒ ::Gapic::Operation #delete_asset(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes the specified asset if it is not used.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::DeleteAssetRequest.new

# Call the delete_asset method.
result = client.delete_asset request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_asset(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_asset via a request object, either of type DeleteAssetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::DeleteAssetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_asset(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_asset via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the asset resource, in the form of: projects/{project}/locations/{location}/assets/{assetId}.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 2406

def delete_asset request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::DeleteAssetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_asset.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_asset.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_asset.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.delete_asset request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_channel(request, options = nil) ⇒ ::Gapic::Operation #delete_channel(name: nil, request_id: nil, force: nil) ⇒ ::Gapic::Operation

Deletes the specified channel.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest.new

# Call the delete_channel method.
result = client.delete_channel request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_channel(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_channel via a request object, either of type DeleteChannelRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_channel(name: nil, request_id: nil, force: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • force (::Boolean) (defaults to: nil) —

      If the force field is set to the default value of false, you must delete all of a channel's events before you can delete the channel itself. If the field is set to true, requests to delete a channel also delete associated channel events.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 619

def delete_channel request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_channel.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_channel.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_channel.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.delete_channel request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_clip(request, options = nil) ⇒ ::Gapic::Operation #delete_clip(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes the specified clip job resource. This method only deletes the clip job and does not delete the VOD clip stored in the GCS.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::DeleteClipRequest.new

# Call the delete_clip method.
result = client.delete_clip request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_clip(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_clip via a request object, either of type DeleteClipRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::DeleteClipRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_clip(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_clip via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the clip resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 2195

def delete_clip request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::DeleteClipRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_clip.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_clip.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_clip.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.delete_clip request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_event(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_event(name: nil, request_id: nil) ⇒ ::Google::Protobuf::Empty

Deletes the specified event.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::DeleteEventRequest.new

# Call the delete_event method.
result = client.delete_event request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_event(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_event via a request object, either of type DeleteEventRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::DeleteEventRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_event(name: nil, request_id: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the event resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1815

def delete_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::DeleteEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_event.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_event.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.delete_event request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_input(request, options = nil) ⇒ ::Gapic::Operation #delete_input(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes the specified input.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::DeleteInputRequest.new

# Call the delete_input method.
result = client.delete_input request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_input(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_input via a request object, either of type DeleteInputRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::DeleteInputRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_input(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_input via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the input resource, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1332

def delete_input request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::DeleteInputRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_input.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_input.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_input.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.delete_input request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_asset(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Asset #get_asset(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Asset

Returns the specified asset.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::GetAssetRequest.new

# Call the get_asset method.
result = client.get_asset request

# The returned object is of type Google::Cloud::Video::LiveStream::V1::Asset.
p result

Overloads:

  • #get_asset(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Asset

    Pass arguments to get_asset via a request object, either of type GetAssetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::GetAssetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_asset(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Asset

    Pass arguments to get_asset via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the resource, in the following form: projects/{project}/locations/{location}/assets/{asset}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 2487

def get_asset request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::GetAssetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_asset.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_asset.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_asset.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.get_asset request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_channel(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Channel #get_channel(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Channel

Returns the specified channel.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::GetChannelRequest.new

# Call the get_channel method.
result = client.get_channel request

# The returned object is of type Google::Cloud::Video::LiveStream::V1::Channel.
p result

Overloads:

  • #get_channel(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Channel

    Pass arguments to get_channel via a request object, either of type GetChannelRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::GetChannelRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_channel(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Channel

    Pass arguments to get_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 514

def get_channel request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::GetChannelRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_channel.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_channel.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_channel.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.get_channel request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_clip(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Clip #get_clip(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Clip

Returns the specified clip.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::GetClipRequest.new

# Call the get_clip method.
result = client.get_clip request

# The returned object is of type Google::Cloud::Video::LiveStream::V1::Clip.
p result

Overloads:

  • #get_clip(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Clip

    Pass arguments to get_clip via a request object, either of type GetClipRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::GetClipRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_clip(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Clip

    Pass arguments to get_clip via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the resource, in the following form: projects/{project}/locations/{location}/channels/{channel}/clips/{clip}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1985

def get_clip request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::GetClipRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_clip.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_clip.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_clip.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.get_clip request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_event(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Event #get_event(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Event

Returns the specified event.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::GetEventRequest.new

# Call the get_event method.
result = client.get_event request

# The returned object is of type Google::Cloud::Video::LiveStream::V1::Event.
p result

Overloads:

  • #get_event(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Event

    Pass arguments to get_event via a request object, either of type GetEventRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::GetEventRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_event(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Event

    Pass arguments to get_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the event resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1722

def get_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::GetEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_event.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_event.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.get_event request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_input(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Input #get_input(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Input

Returns the specified input.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::GetInputRequest.new

# Call the get_input method.
result = client.get_input request

# The returned object is of type Google::Cloud::Video::LiveStream::V1::Input.
p result

Overloads:

  • #get_input(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Input

    Pass arguments to get_input via a request object, either of type GetInputRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::GetInputRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_input(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Input

    Pass arguments to get_input via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the input resource, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1232

def get_input request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::GetInputRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_input.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_input.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_input.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.get_input request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_pool(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Pool #get_pool(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Pool

Returns the specified pool.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::GetPoolRequest.new

# Call the get_pool method.
result = client.get_pool request

# The returned object is of type Google::Cloud::Video::LiveStream::V1::Pool.
p result

Overloads:

  • #get_pool(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Pool

    Pass arguments to get_pool via a request object, either of type GetPoolRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::GetPoolRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_pool(name: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::Pool

    Pass arguments to get_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the pool resource, in the form of: projects/{project}/locations/{location}/pools/{poolId}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 2658

def get_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::GetPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_pool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.get_pool request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_assets(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListAssetsResponse #list_assets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListAssetsResponse

Returns a list of all assets in the specified region.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::ListAssetsRequest.new

# Call the list_assets method.
result = client.list_assets request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Video::LiveStream::V1::Asset.
  p item
end

Overloads:

  • #list_assets(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListAssetsResponse

    Pass arguments to list_assets via a request object, either of type Google::Cloud::Video::LiveStream::V1::ListAssetsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::ListAssetsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_assets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListAssetsResponse

    Pass arguments to list_assets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

    • page_size (::Integer) (defaults to: nil) —

      Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      A token identifying a page of results the server should return.

    • filter (::String) (defaults to: nil) —

      Filtering results

    • order_by (::String) (defaults to: nil) —

      Hint for how to order the results

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 2579

def list_assets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::ListAssetsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_assets.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_assets.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_assets.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.list_assets request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_channels(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListChannelsResponse #list_channels(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListChannelsResponse

Returns a list of all channels in the specified region.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::ListChannelsRequest.new

# Call the list_channels method.
result = client.list_channels request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Video::LiveStream::V1::Channel.
  p item
end

Overloads:

  • #list_channels(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListChannelsResponse

    Pass arguments to list_channels via a request object, either of type Google::Cloud::Video::LiveStream::V1::ListChannelsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::ListChannelsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_channels(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListChannelsResponse

    Pass arguments to list_channels via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.

    • page_token (::String) (defaults to: nil) —

      The next_page_token value returned from a previous List request, if any.

    • filter (::String) (defaults to: nil) —

      The filter to apply to list results.

    • order_by (::String) (defaults to: nil) —

      Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 435

def list_channels request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::ListChannelsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_channels.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_channels.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_channels.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.list_channels request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_clips(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListClipsResponse #list_clips(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListClipsResponse

Returns a list of all clips in the specified channel.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::ListClipsRequest.new

# Call the list_clips method.
result = client.list_clips request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Video::LiveStream::V1::Clip.
  p item
end

Overloads:

  • #list_clips(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListClipsResponse

    Pass arguments to list_clips via a request object, either of type Google::Cloud::Video::LiveStream::V1::ListClipsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::ListClipsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_clips(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListClipsResponse

    Pass arguments to list_clips via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Parent value for ListClipsRequest

    • page_size (::Integer) (defaults to: nil) —

      Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      A token identifying a page of results the server should return.

    • filter (::String) (defaults to: nil) —

      Filtering results

    • order_by (::String) (defaults to: nil) —

      Hint for how to order the results

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1906

def list_clips request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::ListClipsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_clips.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_clips.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_clips.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.list_clips request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_events(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListEventsResponse #list_events(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListEventsResponse

Returns a list of all events in the specified channel.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::ListEventsRequest.new

# Call the list_events method.
result = client.list_events request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Video::LiveStream::V1::Event.
  p item
end

Overloads:

  • #list_events(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListEventsResponse

    Pass arguments to list_events via a request object, either of type Google::Cloud::Video::LiveStream::V1::ListEventsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::ListEventsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_events(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListEventsResponse

    Pass arguments to list_events via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.

    • page_token (::String) (defaults to: nil) —

      The next_page_token value returned from a previous List request, if any.

    • filter (::String) (defaults to: nil) —

      The filter to apply to list results.

    • order_by (::String) (defaults to: nil) —

      Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1643

def list_events request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::ListEventsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_events.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_events.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_events.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.list_events request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_inputs(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListInputsResponse #list_inputs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListInputsResponse

Returns a list of all inputs in the specified region.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::ListInputsRequest.new

# Call the list_inputs method.
result = client.list_inputs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Video::LiveStream::V1::Input.
  p item
end

Overloads:

  • #list_inputs(request, options = nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListInputsResponse

    Pass arguments to list_inputs via a request object, either of type Google::Cloud::Video::LiveStream::V1::ListInputsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::ListInputsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_inputs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Video::LiveStream::V1::ListInputsResponse

    Pass arguments to list_inputs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.

    • page_token (::String) (defaults to: nil) —

      The next_page_token value returned from a previous List request, if any.

    • filter (::String) (defaults to: nil) —

      The filter to apply to list results.

    • order_by (::String) (defaults to: nil) —

      Specifies the ordering of results following syntax at Sorting Order.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1153

def list_inputs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::ListInputsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_inputs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_inputs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_inputs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.list_inputs request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


259
260
261
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 259

def logger
  @livestream_service_stub.logger
end

#start_channel(request, options = nil) ⇒ ::Gapic::Operation #start_channel(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Starts the specified channel. Part of the video pipeline will be created only when the StartChannel request is received by the server.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::StartChannelRequest.new

# Call the start_channel method.
result = client.start_channel request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #start_channel(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to start_channel via a request object, either of type StartChannelRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::StartChannelRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #start_channel(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to start_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 844

def start_channel request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::StartChannelRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.start_channel.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.start_channel.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.start_channel.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.start_channel request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#stop_channel(request, options = nil) ⇒ ::Gapic::Operation #stop_channel(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Stops the specified channel. Part of the video pipeline will be released when the StopChannel request is received by the server.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::StopChannelRequest.new

# Call the stop_channel method.
result = client.stop_channel request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #stop_channel(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to stop_channel via a request object, either of type StopChannelRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::StopChannelRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #stop_channel(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to stop_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 947

def stop_channel request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::StopChannelRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.stop_channel.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.stop_channel.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.stop_channel.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.stop_channel request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


162
163
164
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 162

def universe_domain
  @livestream_service_stub.universe_domain
end

#update_channel(request, options = nil) ⇒ ::Gapic::Operation #update_channel(update_mask: nil, channel: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates the specified channel.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::UpdateChannelRequest.new

# Call the update_channel method.
result = client.update_channel request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_channel(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_channel via a request object, either of type UpdateChannelRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::UpdateChannelRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_channel(update_mask: nil, channel: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Field mask is used to specify the fields to be overwritten in the Channel resource by the update. You can only update the following fields:

      The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

      If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.

    • channel (::Google::Cloud::Video::LiveStream::V1::Channel, ::Hash) (defaults to: nil) —

      Required. The channel resource to be updated.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 741

def update_channel request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::UpdateChannelRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_channel.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_channel.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_channel.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.update_channel request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_input(request, options = nil) ⇒ ::Gapic::Operation #update_input(update_mask: nil, input: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates the specified input.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::UpdateInputRequest.new

# Call the update_input method.
result = client.update_input request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_input(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_input via a request object, either of type UpdateInputRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::UpdateInputRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_input(update_mask: nil, input: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_input via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Field mask is used to specify the fields to be overwritten in the Input resource by the update. You can only update the following fields:

      The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

      If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.

    • input (::Google::Cloud::Video::LiveStream::V1::Input, ::Hash) (defaults to: nil) —

      Required. The input resource to be updated.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 1446

def update_input request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::UpdateInputRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_input.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_input.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_input.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.update_input request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_pool(request, options = nil) ⇒ ::Gapic::Operation #update_pool(update_mask: nil, pool: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates the specified pool.

Examples:

Basic example

require "google/cloud/video/live_stream/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Video::LiveStream::V1::LivestreamService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Video::LiveStream::V1::UpdatePoolRequest.new

# Call the update_pool method.
result = client.update_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_pool(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_pool via a request object, either of type UpdatePoolRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Video::LiveStream::V1::UpdatePoolRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_pool(update_mask: nil, pool: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Field mask is used to specify the fields to be overwritten in the Pool resource by the update. You can only update the following fields:

      • networkConfig

      The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

    • pool (::Google::Cloud::Video::LiveStream::V1::Pool, ::Hash) (defaults to: nil) —

      Required. The pool resource to be updated.

    • request_id (::String) (defaults to: nil) —

      A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
 
# File 'lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb', line 2765

def update_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::LiveStream::V1::UpdatePoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Video::LiveStream::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_pool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @livestream_service_stub.update_pool request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end