Class: Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb

Overview

Client for the VideoStitcherService service.

Video-On-Demand content stitching API allows you to insert ads into (VoD) video on demand files. You will be able to render custom scrubber bars with highlighted ads, enforce ad policies, allow seamless playback and tracking on native players and monetize content with any standard VMAP compliant ad server.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#cdn_key_path, #live_ad_tag_detail_path, #live_config_path, #live_session_path, #location_path, #slate_path, #vod_ad_tag_detail_path, #vod_config_path, #vod_session_path, #vod_stitch_detail_path

Constructor Details

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

Create a new VideoStitcherService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.new

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

Yields:

  • (config) —

    Configure the VideoStitcherService 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/stitcher/v1/video_stitcher_service/client.rb', line 182

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/video/stitcher/v1/video_stitcher_service_services_pb"

  # 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 = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @video_stitcher_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @video_stitcher_service_stub.stub_logger&.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
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



245
246
247
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 245

def operations_client
  @operations_client
end

Class Method Details

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

Configure the VideoStitcherService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



67
68
69
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/stitcher/v1/video_stitcher_service/client.rb', line 67

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Video", "Stitcher", "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.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_cdn_key.timeout = 60.0

    default_config.rpcs.list_cdn_keys.timeout = 60.0

    default_config.rpcs.get_cdn_key.timeout = 60.0

    default_config.rpcs.delete_cdn_key.timeout = 60.0

    default_config.rpcs.update_cdn_key.timeout = 60.0

    default_config.rpcs.create_vod_session.timeout = 60.0

    default_config.rpcs.get_vod_session.timeout = 60.0

    default_config.rpcs.list_vod_stitch_details.timeout = 60.0

    default_config.rpcs.get_vod_stitch_detail.timeout = 60.0

    default_config.rpcs.list_vod_ad_tag_details.timeout = 60.0

    default_config.rpcs.get_vod_ad_tag_detail.timeout = 60.0

    default_config.rpcs.list_live_ad_tag_details.timeout = 60.0

    default_config.rpcs.get_live_ad_tag_detail.timeout = 60.0

    default_config.rpcs.create_slate.timeout = 60.0

    default_config.rpcs.list_slates.timeout = 60.0

    default_config.rpcs.get_slate.timeout = 60.0

    default_config.rpcs.update_slate.timeout = 60.0

    default_config.rpcs.delete_slate.timeout = 60.0

    default_config.rpcs.create_live_session.timeout = 60.0

    default_config.rpcs.get_live_session.timeout = 60.0

    default_config.rpcs.create_live_config.timeout = 60.0

    default_config.rpcs.list_live_configs.timeout = 60.0

    default_config.rpcs.get_live_config.timeout = 60.0

    default_config.rpcs.delete_live_config.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the VideoStitcherService 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/stitcher/v1/video_stitcher_service/client.rb', line 152

def configure
  yield @config if block_given?
  @config
end

#create_cdn_key(request, options = nil) ⇒ ::Gapic::Operation #create_cdn_key(parent: nil, cdn_key: nil, cdn_key_id: nil) ⇒ ::Gapic::Operation

Creates a new CDN key.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the create_cdn_key method.
result = client.create_cdn_key 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_cdn_key(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::CreateCdnKeyRequest, ::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_cdn_key(parent: nil, cdn_key: nil, cdn_key_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_cdn_key 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 project in which the CDN key should be created, in the form of projects/{project_number}/locations/{location}.

    • cdn_key (::Google::Cloud::Video::Stitcher::V1::CdnKey, ::Hash) (defaults to: nil) —

      Required. The CDN key resource to create.

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

      Required. The ID to use for the CDN key, which will become the final component of the CDN key's resource name.

      This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 319

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::CreateCdnKeyRequest

  # 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
  metadata = @config.rpcs.create_cdn_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :create_cdn_key, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_live_config(request, options = nil) ⇒ ::Gapic::Operation #create_live_config(parent: nil, live_config_id: nil, live_config: nil, request_id: nil) ⇒ ::Gapic::Operation

Registers the live config with the provided unique ID in the specified region.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the create_live_config method.
result = client.create_live_config 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_live_config(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::CreateLiveConfigRequest, ::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_live_config(parent: nil, live_config_id: nil, live_config: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_live_config 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 project in which the live config should be created, in the form of projects/{project_number}/locations/{location}.

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

      Required. The unique identifier ID to use for the live config.

    • live_config (::Google::Cloud::Video::Stitcher::V1::LiveConfig, ::Hash) (defaults to: nil) —

      Required. The live config resource to create.

    • 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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2207

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::CreateLiveConfigRequest

  # 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
  metadata = @config.rpcs.create_live_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :create_live_config, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_live_session(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveSession #create_live_session(parent: nil, live_session: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveSession

Creates a new live session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::LiveSession.
p result

Overloads:

  • #create_live_session(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveSession

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::CreateLiveSessionRequest, ::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_live_session(parent: nil, live_session: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveSession

    Pass arguments to create_live_session 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 project and location in which the live session should be created, in the form of projects/{project_number}/locations/{location}.

    • live_session (::Google::Cloud::Video::Stitcher::V1::LiveSession, ::Hash) (defaults to: nil) —

      Required. Parameters for creating a live session.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2009

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::CreateLiveSessionRequest

  # 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
  metadata = @config.rpcs.create_live_session.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :create_live_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_slate(request, options = nil) ⇒ ::Gapic::Operation #create_slate(parent: nil, slate_id: nil, slate: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a slate.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the create_slate method.
result = client.create_slate 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_slate(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::CreateSlateRequest, ::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_slate(parent: nil, slate_id: nil, slate: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_slate 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 project in which the slate should be created, in the form of projects/{project_number}/locations/{location}.

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

      Required. The unique identifier for the slate. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

    • slate (::Google::Cloud::Video::Stitcher::V1::Slate, ::Hash) (defaults to: nil) —

      Required. The slate to create.

    • 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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1541
1542
1543
1544
1545
1546
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
1581
1582
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1541

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::CreateSlateRequest

  # 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
  metadata = @config.rpcs.create_slate.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :create_slate, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_vod_config(request, options = nil) ⇒ ::Gapic::Operation #create_vod_config(parent: nil, vod_config_id: nil, vod_config: nil, request_id: nil) ⇒ ::Gapic::Operation

Registers the VOD config with the provided unique ID in the specified region.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the create_vod_config method.
result = client.create_vod_config 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_vod_config(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::CreateVodConfigRequest, ::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_vod_config(parent: nil, vod_config_id: nil, vod_config: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_vod_config 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 project in which the VOD config should be created, in the form of projects/{project_number}/locations/{location}.

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

      Required. The unique identifier ID to use for the VOD config.

    • vod_config (::Google::Cloud::Video::Stitcher::V1::VodConfig, ::Hash) (defaults to: nil) —

      Required. The VOD config resource to create.

    • 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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2708

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::CreateVodConfigRequest

  # 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
  metadata = @config.rpcs.create_vod_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :create_vod_config, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_vod_session(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession #create_vod_session(parent: nil, vod_session: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession

Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::VodSession.
p result

Overloads:

  • #create_vod_session(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::CreateVodSessionRequest, ::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_vod_session(parent: nil, vod_session: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession

    Pass arguments to create_vod_session 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 project and location in which the VOD session should be created, in the form of projects/{project_number}/locations/{location}.

    • vod_session (::Google::Cloud::Video::Stitcher::V1::VodSession, ::Hash) (defaults to: nil) —

      Required. Parameters for creating a session.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 791

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::CreateVodSessionRequest

  # 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
  metadata = @config.rpcs.create_vod_session.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :create_vod_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes the specified CDN key.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the delete_cdn_key method.
result = client.delete_cdn_key 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_cdn_key(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::DeleteCdnKeyRequest, ::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_cdn_key(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_cdn_key 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 CDN key to be deleted, in the form of projects/{project_number}/locations/{location}/cdnKeys/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 601

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::DeleteCdnKeyRequest

  # 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
  metadata = @config.rpcs.delete_cdn_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :delete_cdn_key, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes the specified live config.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the delete_live_config method.
result = client.delete_live_config 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_live_config(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::DeleteLiveConfigRequest, ::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_live_config(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_live_config 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 live config to be deleted, in the form of projects/{project_number}/locations/{location}/liveConfigs/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



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
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2494

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::DeleteLiveConfigRequest

  # 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
  metadata = @config.rpcs.delete_live_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :delete_live_config, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes the specified slate.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the delete_slate method.
result = client.delete_slate 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_slate(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::DeleteSlateRequest, ::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_slate(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_slate 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 slate to be deleted, in the form of projects/{project_number}/locations/{location}/slates/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1919

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::DeleteSlateRequest

  # 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
  metadata = @config.rpcs.delete_slate.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :delete_slate, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes the specified VOD config.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the delete_vod_config method.
result = client.delete_vod_config 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_vod_config(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::DeleteVodConfigRequest, ::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_vod_config(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_vod_config 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 VOD config to be deleted, in the form of projects/{project_number}/locations/{location}/vodConfigs/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2995

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::DeleteVodConfigRequest

  # 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
  metadata = @config.rpcs.delete_vod_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :delete_vod_config, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_cdn_key(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::CdnKey #get_cdn_key(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::CdnKey

Returns the specified CDN key.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::CdnKey.
p result

Overloads:

  • #get_cdn_key(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::CdnKey

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetCdnKeyRequest, ::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_cdn_key(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::CdnKey

    Pass arguments to get_cdn_key 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 CDN key to be retrieved, in the form of projects/{project}/locations/{location}/cdnKeys/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



508
509
510
511
512
513
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/stitcher/v1/video_stitcher_service/client.rb', line 508

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetCdnKeyRequest

  # 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
  metadata = @config.rpcs.get_cdn_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_cdn_key, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_live_ad_tag_detail(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail #get_live_ad_tag_detail(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail

Returns the specified ad tag detail for the specified live session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail.
p result

Overloads:

  • #get_live_ad_tag_detail(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetLiveAdTagDetailRequest, ::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_live_ad_tag_detail(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail

    Pass arguments to get_live_ad_tag_detail 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 resource name in the form of projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{live_ad_tag_detail}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1427

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetLiveAdTagDetailRequest

  # 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
  metadata = @config.rpcs.get_live_ad_tag_detail.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_live_ad_tag_detail, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_live_config(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveConfig #get_live_config(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveConfig

Returns the specified live config managed by the Video Stitcher service.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::LiveConfig.
p result

Overloads:

  • #get_live_config(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveConfig

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetLiveConfigRequest, ::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_live_config(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveConfig

    Pass arguments to get_live_config 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 live config to be retrieved, in the form of projects/{project_number}/locations/{location}/liveConfigs/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2401
2402
2403
2404
2405
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
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2401

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetLiveConfigRequest

  # 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
  metadata = @config.rpcs.get_live_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_live_config, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_live_session(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveSession #get_live_session(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveSession

Returns the details for the specified live session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::LiveSession.
p result

Overloads:

  • #get_live_session(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveSession

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetLiveSessionRequest, ::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_live_session(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::LiveSession

    Pass arguments to get_live_session 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 live session, in the form of projects/{project_number}/locations/{location}/liveSessions/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
2128
2129
2130
2131
2132
2133
2134
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2095

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetLiveSessionRequest

  # 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
  metadata = @config.rpcs.get_live_session.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_live_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_slate(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::Slate #get_slate(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::Slate

Returns the specified slate.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::Slate.
p result

Overloads:

  • #get_slate(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::Slate

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetSlateRequest, ::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_slate(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::Slate

    Pass arguments to get_slate 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 slate to be retrieved, of the slate, in the form of projects/{project_number}/locations/{location}/slates/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1730

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetSlateRequest

  # 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
  metadata = @config.rpcs.get_slate.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_slate, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_vod_ad_tag_detail(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail #get_vod_ad_tag_detail(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail

Returns the specified ad tag detail for the specified VOD session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::VodAdTagDetail.
p result

Overloads:

  • #get_vod_ad_tag_detail(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetVodAdTagDetailRequest, ::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_vod_ad_tag_detail(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail

    Pass arguments to get_vod_ad_tag_detail 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 ad tag detail for the specified VOD session, in the form of projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodAdTagDetails/{vod_ad_tag_detail}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1245

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetVodAdTagDetailRequest

  # 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
  metadata = @config.rpcs.get_vod_ad_tag_detail.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_vod_ad_tag_detail, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_vod_config(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodConfig #get_vod_config(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodConfig

Returns the specified VOD config managed by the Video Stitcher API service.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::VodConfig.
p result

Overloads:

  • #get_vod_config(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodConfig

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetVodConfigRequest, ::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_vod_config(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodConfig

    Pass arguments to get_vod_config 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 VOD config to be retrieved, in the form of projects/{project_number}/locations/{location}/vodConfigs/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2902

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetVodConfigRequest

  # 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
  metadata = @config.rpcs.get_vod_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_vod_config, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_vod_session(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession #get_vod_session(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession

Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::VodSession.
p result

Overloads:

  • #get_vod_session(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetVodSessionRequest, ::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_vod_session(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodSession

    Pass arguments to get_vod_session 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 VOD session to be retrieved, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 878

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetVodSessionRequest

  # 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
  metadata = @config.rpcs.get_vod_session.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_vod_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_vod_stitch_detail(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodStitchDetail #get_vod_stitch_detail(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodStitchDetail

Returns the specified stitching information for the specified VOD session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

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

# The returned object is of type Google::Cloud::Video::Stitcher::V1::VodStitchDetail.
p result

Overloads:

  • #get_vod_stitch_detail(request, options = nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodStitchDetail

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::GetVodStitchDetailRequest, ::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_vod_stitch_detail(name: nil) ⇒ ::Google::Cloud::Video::Stitcher::V1::VodStitchDetail

    Pass arguments to get_vod_stitch_detail 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 stitch detail in the specified VOD session, in the form of projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodStitchDetails/{id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1062

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::GetVodStitchDetailRequest

  # 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
  metadata = @config.rpcs.get_vod_stitch_detail.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :get_vod_stitch_detail, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_cdn_keys(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey> #list_cdn_keys(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey>

Lists all CDN keys in the specified project and location.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the list_cdn_keys method.
result = client.list_cdn_keys 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::Stitcher::V1::CdnKey.
  p item
end

Overloads:

  • #list_cdn_keys(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey>

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::ListCdnKeysRequest, ::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_cdn_keys(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey>

    Pass arguments to list_cdn_keys 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 project that contains the list of CDN keys, in the form of projects/{project_number}/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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
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
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 420

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::ListCdnKeysRequest

  # 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
  metadata = @config.rpcs.list_cdn_keys.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :list_cdn_keys, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @video_stitcher_service_stub, :list_cdn_keys, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_live_ad_tag_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail> #list_live_ad_tag_details(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail>

Return the list of ad tag details for the specified live session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the list_live_ad_tag_details method.
result = client.list_live_ad_tag_details 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::Stitcher::V1::LiveAdTagDetail.
  p item
end

Overloads:

  • #list_live_ad_tag_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail>

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::ListLiveAdTagDetailsRequest, ::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_live_ad_tag_details(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail>

    Pass arguments to list_live_ad_tag_details 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 resource parent in the form of projects/{project}/locations/{location}/liveSessions/{live_session}.

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

      The maximum number of items to return.

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

      The pagination token returned from a previous List request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1339

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::ListLiveAdTagDetailsRequest

  # 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
  metadata = @config.rpcs.list_live_ad_tag_details.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :list_live_ad_tag_details, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @video_stitcher_service_stub, :list_live_ad_tag_details, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_live_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig> #list_live_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig>

Lists all live configs managed by the Video Stitcher that belong to the specified project and region.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the list_live_configs method.
result = client.list_live_configs 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::Stitcher::V1::LiveConfig.
  p item
end

Overloads:

  • #list_live_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig>

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::ListLiveConfigsRequest, ::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_live_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig>

    Pass arguments to list_live_configs 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 project that contains the list of live configs, in the form of projects/{project_number}/locations/{location}.

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

      The maximum number of items to return.

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

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

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

      Optional. The filter to apply to list results (see Filtering).

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

      Optional. Specifies the ordering of results following Cloud API syntax.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2311

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::ListLiveConfigsRequest

  # 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
  metadata = @config.rpcs.list_live_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :list_live_configs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @video_stitcher_service_stub, :list_live_configs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_slates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate> #list_slates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate>

Lists all slates in the specified project and location.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the list_slates method.
result = client.list_slates 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::Stitcher::V1::Slate.
  p item
end

Overloads:

  • #list_slates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate>

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::ListSlatesRequest, ::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_slates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate>

    Pass arguments to list_slates 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 project to list slates, in the form of projects/{project_number}/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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1642
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
1677
1678
1679
1680
1681
1682
1683
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1642

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::ListSlatesRequest

  # 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
  metadata = @config.rpcs.list_slates.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :list_slates, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @video_stitcher_service_stub, :list_slates, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_vod_ad_tag_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail> #list_vod_ad_tag_details(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail>

Return the list of ad tag details for the specified VOD session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the list_vod_ad_tag_details method.
result = client.list_vod_ad_tag_details 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::Stitcher::V1::VodAdTagDetail.
  p item
end

Overloads:

  • #list_vod_ad_tag_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail>

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::ListVodAdTagDetailsRequest, ::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_vod_ad_tag_details(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail>

    Pass arguments to list_vod_ad_tag_details 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 VOD session which the ad tag details belong to, in the form of projects/{project}/locations/{location}/vodSessions/{vod_session_id}.

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

      The maximum number of items to return.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1156

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::ListVodAdTagDetailsRequest

  # 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
  metadata = @config.rpcs.list_vod_ad_tag_details.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :list_vod_ad_tag_details, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @video_stitcher_service_stub, :list_vod_ad_tag_details, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_vod_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig> #list_vod_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>

Lists all VOD configs managed by the Video Stitcher API that belong to the specified project and region.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the list_vod_configs method.
result = client.list_vod_configs 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::Stitcher::V1::VodConfig.
  p item
end

Overloads:

  • #list_vod_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::ListVodConfigsRequest, ::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_vod_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>

    Pass arguments to list_vod_configs 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 project that contains the list of VOD configs, in the form of projects/{project_number}/locations/{location}.

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

      Optional. The maximum number of items to return.

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

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

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

      Optional. The filter to apply to list results (see Filtering).

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

      Optional. Specifies the ordering of results following Cloud API syntax.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2813

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::ListVodConfigsRequest

  # 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
  metadata = @config.rpcs.list_vod_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :list_vod_configs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @video_stitcher_service_stub, :list_vod_configs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_vod_stitch_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail> #list_vod_stitch_details(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail>

Returns a list of detailed stitching information of the specified VOD session.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the list_vod_stitch_details method.
result = client.list_vod_stitch_details 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::Stitcher::V1::VodStitchDetail.
  p item
end

Overloads:

  • #list_vod_stitch_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail>

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::ListVodStitchDetailsRequest, ::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_vod_stitch_details(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail>

    Pass arguments to list_vod_stitch_details 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 VOD session where the stitch details belong to, in the form of projects/{project}/locations/{location}/vodSessions/{id}.

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

      The maximum number of items to return.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 973

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::ListVodStitchDetailsRequest

  # 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
  metadata = @config.rpcs.list_vod_stitch_details.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :list_vod_stitch_details, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @video_stitcher_service_stub, :list_vod_stitch_details, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


252
253
254
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 252

def logger
  @video_stitcher_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


162
163
164
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 162

def universe_domain
  @video_stitcher_service_stub.universe_domain
end

#update_cdn_key(request, options = nil) ⇒ ::Gapic::Operation #update_cdn_key(cdn_key: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates the specified CDN key. Only update fields specified in the call method body.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the update_cdn_key method.
result = client.update_cdn_key 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_cdn_key(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::UpdateCdnKeyRequest, ::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_cdn_key(cdn_key: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_cdn_key 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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 700

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::UpdateCdnKeyRequest

  # 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
  metadata = @config.rpcs.update_cdn_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.cdn_key&.name
    header_params["cdn_key.name"] = request.cdn_key.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :update_cdn_key, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_live_config(request, options = nil) ⇒ ::Gapic::Operation #update_live_config(live_config: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates the specified LiveConfig. Only update fields specified in the call method body.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the update_live_config method.
result = client.update_live_config 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_live_config(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::UpdateLiveConfigRequest, ::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_live_config(live_config: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_live_config 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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2594

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::UpdateLiveConfigRequest

  # 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
  metadata = @config.rpcs.update_live_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.live_config&.name
    header_params["live_config.name"] = request.live_config.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :update_live_config, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_slate(request, options = nil) ⇒ ::Gapic::Operation #update_slate(slate: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates the specified slate.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the update_slate method.
result = client.update_slate 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_slate(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::UpdateSlateRequest, ::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_slate(slate: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_slate 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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



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
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1824

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::UpdateSlateRequest

  # 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
  metadata = @config.rpcs.update_slate.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.slate&.name
    header_params["slate.name"] = request.slate.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :update_slate, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_vod_config(request, options = nil) ⇒ ::Gapic::Operation #update_vod_config(vod_config: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates the specified VOD config. Only update fields specified in the call method body.

Examples:

Basic example

require "google/cloud/video/stitcher/v1"

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

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

# Call the update_vod_config method.
result = client.update_vod_config 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_vod_config(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Video::Stitcher::V1::UpdateVodConfigRequest, ::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_vod_config(vod_config: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_vod_config 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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 3095

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Stitcher::V1::UpdateVodConfigRequest

  # 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
  metadata = @config.rpcs.update_vod_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Stitcher::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.vod_config&.name
    header_params["vod_config.name"] = request.vod_config.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @video_stitcher_service_stub.call_rpc :update_vod_config, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end