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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
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
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 167

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 == 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
  end

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

Instance Attribute Details

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

Get the associated client for long-running operations.

Returns:



215
216
217
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 215

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:



61
62
63
64
65
66
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
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 61

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:



146
147
148
149
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 146

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.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 280

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 and x-goog-user-project 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-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?
    return 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.



2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2157

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 and x-goog-user-project 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-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?
    return 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.



1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1959

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 and x-goog-user-project 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-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?
    return response
  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.



1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1495

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 and x-goog-user-project 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-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?
    return 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.



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 748

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 and x-goog-user-project 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-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?
    return response
  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.



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 560

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 and x-goog-user-project 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-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?
    return 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.



2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2442

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 and x-goog-user-project 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-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?
    return 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.



1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1870

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 and x-goog-user-project 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-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?
    return 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.



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 467

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 and x-goog-user-project 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-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?
    return response
  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.



1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1381

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 and x-goog-user-project 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-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?
    return response
  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.



2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2349

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 and x-goog-user-project 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-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?
    return response
  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.



2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2045

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 and x-goog-user-project 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-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?
    return response
  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.



1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1682

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 and x-goog-user-project 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-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?
    return response
  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.



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1200

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 and x-goog-user-project 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-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?
    return response
  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.



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 835

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 and x-goog-user-project 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-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?
    return response
  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.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1018

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 and x-goog-user-project 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-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?
    return response
  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.



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 380

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 and x-goog-user-project 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-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?
    return 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.



1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1294

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 and x-goog-user-project 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-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?
    return 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.



2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 2260

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 and x-goog-user-project 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-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?
    return 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.



1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1595

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 and x-goog-user-project 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-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?
    return 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.



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1112

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 and x-goog-user-project 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-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?
    return 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.



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 930

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 and x-goog-user-project 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-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?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
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.



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 658

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 and x-goog-user-project 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-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?
    return 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.



1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
 
# File 'lib/google/cloud/video/stitcher/v1/video_stitcher_service/client.rb', line 1776

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 and x-goog-user-project 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-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?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end