Reference documentation and code samples for the Video Stitcher V1 API class Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.
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.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the VideoStitcherService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all VideoStitcherService clients ::Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.configure do |config| config.timeout = 10.0 end
#configure
def 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 Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_cdn_key
def create_cdn_key(request, options = nil) -> ::Gapic::Operation
def create_cdn_key(parent: nil, cdn_key: nil, cdn_key_id: nil) -> ::Gapic::Operation
Creates a new CDN key.
def create_cdn_key(request, options = nil) -> ::Gapic::Operation
create_cdn_key
via a request object, either of type
CreateCdnKeyRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_cdn_key(parent: nil, cdn_key: nil, cdn_key_id: nil) -> ::Gapic::Operation
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).
-
parent (::String) — 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) — Required. The CDN key resource to create.
-
cdn_key_id (::String) — 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#create_live_config
def create_live_config(request, options = nil) -> ::Gapic::Operation
def 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.
def create_live_config(request, options = nil) -> ::Gapic::Operation
create_live_config
via a request object, either of type
CreateLiveConfigRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_live_config(parent: nil, live_config_id: nil, live_config: nil, request_id: nil) -> ::Gapic::Operation
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).
-
parent (::String) — Required. The project in which the live config should be created, in
the form of
projects/{project_number}/locations/{location}
. - live_config_id (::String) — Required. The unique identifier ID to use for the live config.
- live_config (::Google::Cloud::Video::Stitcher::V1::LiveConfig, ::Hash) — Required. The live config resource to create.
-
request_id (::String) — 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)
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#create_live_session
def create_live_session(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession
def create_live_session(parent: nil, live_session: nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession
Creates a new live session.
def create_live_session(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession
create_live_session
via a request object, either of type
CreateLiveSessionRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_live_session(parent: nil, live_session: nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession
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).
-
parent (::String) — 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) — Required. Parameters for creating a live session.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::LiveSession)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#create_slate
def create_slate(request, options = nil) -> ::Gapic::Operation
def create_slate(parent: nil, slate_id: nil, slate: nil, request_id: nil) -> ::Gapic::Operation
Creates a slate.
def create_slate(request, options = nil) -> ::Gapic::Operation
create_slate
via a request object, either of type
CreateSlateRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_slate(parent: nil, slate_id: nil, slate: nil, request_id: nil) -> ::Gapic::Operation
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).
-
parent (::String) — Required. The project in which the slate should be created, in the form of
projects/{project_number}/locations/{location}
. - slate_id (::String) — 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) — Required. The slate to create.
-
request_id (::String) — 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)
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#create_vod_config
def create_vod_config(request, options = nil) -> ::Gapic::Operation
def create_vod_config(parent: nil, vod_config_id: nil, vod_config: nil, request_id: nil) -> ::Gapic::Operation
Registers the VOD config with the provided unique ID in the specified region.
def create_vod_config(request, options = nil) -> ::Gapic::Operation
create_vod_config
via a request object, either of type
CreateVodConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Video::Stitcher::V1::CreateVodConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_vod_config(parent: nil, vod_config_id: nil, vod_config: nil, request_id: nil) -> ::Gapic::Operation
create_vod_config
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The project in which the VOD config should be created, in
the form of
projects/{project_number}/locations/{location}
. - vod_config_id (::String) — Required. The unique identifier ID to use for the VOD config.
- vod_config (::Google::Cloud::Video::Stitcher::V1::VodConfig, ::Hash) — Required. The VOD config resource to create.
-
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server will know to ignore
the request if it has already been completed. The server will guarantee
that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000)
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/video/stitcher/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Video::Stitcher::V1::CreateVodConfigRequest.new # Call the create_vod_config method. result = client.create_vod_config request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#create_vod_session
def create_vod_session(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodSession
def 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.
def create_vod_session(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodSession
create_vod_session
via a request object, either of type
CreateVodSessionRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_vod_session(parent: nil, vod_session: nil) -> ::Google::Cloud::Video::Stitcher::V1::VodSession
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).
-
parent (::String) — 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) — Required. Parameters for creating a session.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::VodSession)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#delete_cdn_key
def delete_cdn_key(request, options = nil) -> ::Gapic::Operation
def delete_cdn_key(name: nil) -> ::Gapic::Operation
Deletes the specified CDN key.
def delete_cdn_key(request, options = nil) -> ::Gapic::Operation
delete_cdn_key
via a request object, either of type
DeleteCdnKeyRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_cdn_key(name: nil) -> ::Gapic::Operation
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).
-
name (::String) — Required. The name of the CDN key to be deleted, in the form of
projects/{project_number}/locations/{location}/cdnKeys/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#delete_live_config
def delete_live_config(request, options = nil) -> ::Gapic::Operation
def delete_live_config(name: nil) -> ::Gapic::Operation
Deletes the specified live config.
def delete_live_config(request, options = nil) -> ::Gapic::Operation
delete_live_config
via a request object, either of type
DeleteLiveConfigRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_live_config(name: nil) -> ::Gapic::Operation
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).
-
name (::String) — Required. The name of the live config to be deleted, in the form of
projects/{project_number}/locations/{location}/liveConfigs/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#delete_slate
def delete_slate(request, options = nil) -> ::Gapic::Operation
def delete_slate(name: nil) -> ::Gapic::Operation
Deletes the specified slate.
def delete_slate(request, options = nil) -> ::Gapic::Operation
delete_slate
via a request object, either of type
DeleteSlateRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_slate(name: nil) -> ::Gapic::Operation
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).
-
name (::String) — Required. The name of the slate to be deleted, in the form of
projects/{project_number}/locations/{location}/slates/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#delete_vod_config
def delete_vod_config(request, options = nil) -> ::Gapic::Operation
def delete_vod_config(name: nil) -> ::Gapic::Operation
Deletes the specified VOD config.
def delete_vod_config(request, options = nil) -> ::Gapic::Operation
delete_vod_config
via a request object, either of type
DeleteVodConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Video::Stitcher::V1::DeleteVodConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_vod_config(name: nil) -> ::Gapic::Operation
delete_vod_config
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the VOD config to be deleted, in the form of
projects/{project_number}/locations/{location}/vodConfigs/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/video/stitcher/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Video::Stitcher::V1::DeleteVodConfigRequest.new # Call the delete_vod_config method. result = client.delete_vod_config request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#get_cdn_key
def get_cdn_key(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::CdnKey
def get_cdn_key(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::CdnKey
Returns the specified CDN key.
def get_cdn_key(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::CdnKey
get_cdn_key
via a request object, either of type
GetCdnKeyRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_cdn_key(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::CdnKey
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).
-
name (::String) — Required. The name of the CDN key to be retrieved, in the form of
projects/{project}/locations/{location}/cdnKeys/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::CdnKey)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_live_ad_tag_detail
def get_live_ad_tag_detail(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail
def get_live_ad_tag_detail(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail
Returns the specified ad tag detail for the specified live session.
def get_live_ad_tag_detail(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail
get_live_ad_tag_detail
via a request object, either of type
GetLiveAdTagDetailRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_live_ad_tag_detail(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail
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).
-
name (::String) — Required. The resource name in the form of
projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{live_ad_tag_detail}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_live_config
def get_live_config(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveConfig
def get_live_config(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveConfig
Returns the specified live config managed by the Video Stitcher service.
def get_live_config(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveConfig
get_live_config
via a request object, either of type
GetLiveConfigRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_live_config(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveConfig
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).
-
name (::String) — Required. The name of the live config to be retrieved, in the form
of
projects/{project_number}/locations/{location}/liveConfigs/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::LiveConfig)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_live_session
def get_live_session(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession
def get_live_session(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession
Returns the details for the specified live session.
def get_live_session(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession
get_live_session
via a request object, either of type
GetLiveSessionRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_live_session(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::LiveSession
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).
-
name (::String) — Required. The name of the live session, in the form of
projects/{project_number}/locations/{location}/liveSessions/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::LiveSession)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_slate
def get_slate(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::Slate
def get_slate(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::Slate
Returns the specified slate.
def get_slate(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::Slate
get_slate
via a request object, either of type
GetSlateRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_slate(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::Slate
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).
-
name (::String) — Required. The name of the slate to be retrieved, of the slate, in the form
of
projects/{project_number}/locations/{location}/slates/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::Slate)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_vod_ad_tag_detail
def get_vod_ad_tag_detail(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail
def get_vod_ad_tag_detail(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail
Returns the specified ad tag detail for the specified VOD session.
def get_vod_ad_tag_detail(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail
get_vod_ad_tag_detail
via a request object, either of type
GetVodAdTagDetailRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_vod_ad_tag_detail(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail
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).
-
name (::String) — 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}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_vod_config
def get_vod_config(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodConfig
def get_vod_config(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::VodConfig
Returns the specified VOD config managed by the Video Stitcher API service.
def get_vod_config(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodConfig
get_vod_config
via a request object, either of type
GetVodConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Video::Stitcher::V1::GetVodConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_vod_config(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::VodConfig
get_vod_config
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the VOD config to be retrieved, in the form
of
projects/{project_number}/locations/{location}/vodConfigs/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::VodConfig)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/video/stitcher/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Video::Stitcher::V1::GetVodConfigRequest.new # Call the get_vod_config method. result = client.get_vod_config request # The returned object is of type Google::Cloud::Video::Stitcher::V1::VodConfig. p result
#get_vod_session
def get_vod_session(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodSession
def 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.
def get_vod_session(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodSession
get_vod_session
via a request object, either of type
GetVodSessionRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_vod_session(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::VodSession
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).
-
name (::String) — Required. The name of the VOD session to be retrieved, in the form of
projects/{project_number}/locations/{location}/vodSessions/{id}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::VodSession)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_vod_stitch_detail
def get_vod_stitch_detail(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodStitchDetail
def get_vod_stitch_detail(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::VodStitchDetail
Returns the specified stitching information for the specified VOD session.
def get_vod_stitch_detail(request, options = nil) -> ::Google::Cloud::Video::Stitcher::V1::VodStitchDetail
get_vod_stitch_detail
via a request object, either of type
GetVodStitchDetailRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_vod_stitch_detail(name: nil) -> ::Google::Cloud::Video::Stitcher::V1::VodStitchDetail
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).
-
name (::String) — 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}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Video::Stitcher::V1::VodStitchDetail)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#initialize
def initialize() { |config| ... } -> Client
Create a new VideoStitcherService client object.
- (config) — Configure the VideoStitcherService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# 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
#list_cdn_keys
def list_cdn_keys(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey>
def 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.
def list_cdn_keys(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey>
list_cdn_keys
via a request object, either of type
ListCdnKeysRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_cdn_keys(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey>
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).
-
parent (::String) — Required. The project that contains the list of CDN keys, in the form of
projects/{project_number}/locations/{location}
. - page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- page_token (::String) — A token identifying a page of results the server should return.
- filter (::String) — Filtering results
- order_by (::String) — Hint for how to order the results
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::CdnKey>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_live_ad_tag_details
def list_live_ad_tag_details(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail>
def 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.
def list_live_ad_tag_details(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail>
list_live_ad_tag_details
via a request object, either of type
ListLiveAdTagDetailsRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_live_ad_tag_details(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail>
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).
-
parent (::String) — Required. The resource parent in the form of
projects/{project}/locations/{location}/liveSessions/{live_session}
. - page_size (::Integer) — The maximum number of items to return.
- page_token (::String) — The pagination token returned from a previous List request.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveAdTagDetail>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_live_configs
def list_live_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig>
def 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.
def list_live_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig>
list_live_configs
via a request object, either of type
ListLiveConfigsRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_live_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig>
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).
-
parent (::String) — Required. The project that contains the list of live configs, in the
form of
projects/{project_number}/locations/{location}
. - page_size (::Integer) — The maximum number of items to return.
- page_token (::String) — The next_page_token value returned from a previous List request, if any.
- filter (::String) — Optional. The filter to apply to list results (see Filtering).
- order_by (::String) — Optional. Specifies the ordering of results following Cloud API syntax.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::LiveConfig>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_slates
def list_slates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate>
def 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.
def list_slates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate>
list_slates
via a request object, either of type
ListSlatesRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_slates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate>
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).
-
parent (::String) — Required. The project to list slates, in the form of
projects/{project_number}/locations/{location}
. - page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- page_token (::String) — A token identifying a page of results the server should return.
- filter (::String) — Filtering results
- order_by (::String) — Hint for how to order the results
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::Slate>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_vod_ad_tag_details
def list_vod_ad_tag_details(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail>
def 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.
def list_vod_ad_tag_details(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail>
list_vod_ad_tag_details
via a request object, either of type
ListVodAdTagDetailsRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_vod_ad_tag_details(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail>
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).
-
parent (::String) — 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) — The maximum number of items to return.
- page_token (::String) — The next_page_token value returned from a previous List request, if any.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodAdTagDetail>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_vod_configs
def list_vod_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>
def list_vod_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>
Lists all VOD configs managed by the Video Stitcher API that belong to the specified project and region.
def list_vod_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>
list_vod_configs
via a request object, either of type
ListVodConfigsRequest or an equivalent Hash.
- request (::Google::Cloud::Video::Stitcher::V1::ListVodConfigsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_vod_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>
list_vod_configs
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The project that contains the list of VOD configs, in the
form of
projects/{project_number}/locations/{location}
. - page_size (::Integer) — Optional. The maximum number of items to return.
- page_token (::String) — Optional. The next_page_token value returned from a previous List request, if any.
- filter (::String) — Optional. The filter to apply to list results (see Filtering).
- order_by (::String) — Optional. Specifies the ordering of results following Cloud API syntax.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodConfig>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/video/stitcher/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Video::Stitcher::V1::ListVodConfigsRequest.new # Call the list_vod_configs method. result = client.list_vod_configs request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::Video::Stitcher::V1::VodConfig. p item end
#list_vod_stitch_details
def list_vod_stitch_details(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail>
def 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.
def list_vod_stitch_details(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail>
list_vod_stitch_details
via a request object, either of type
ListVodStitchDetailsRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_vod_stitch_details(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail>
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).
-
parent (::String) — Required. The VOD session where the stitch details belong to, in the form
of
projects/{project}/locations/{location}/vodSessions/{id}
. - page_size (::Integer) — The maximum number of items to return.
- page_token (::String) — The next_page_token value returned from a previous List request, if any.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Video::Stitcher::V1::VodStitchDetail>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#operations_client
def operations_client() -> ::Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Operations
Get the associated client for long-running operations.
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_cdn_key
def update_cdn_key(request, options = nil) -> ::Gapic::Operation
def 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.
def update_cdn_key(request, options = nil) -> ::Gapic::Operation
update_cdn_key
via a request object, either of type
UpdateCdnKeyRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_cdn_key(cdn_key: nil, update_mask: nil) -> ::Gapic::Operation
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).
- cdn_key (::Google::Cloud::Video::Stitcher::V1::CdnKey, ::Hash) — Required. The CDN key resource which replaces the resource on the server.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update mask applies to the resource.
For the
FieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#update_live_config
def update_live_config(request, options = nil) -> ::Gapic::Operation
def update_live_config(live_config: nil, update_mask: nil) -> ::Gapic::Operation
Updates the specified LiveConfig. Only update fields specified in the call method body.
def update_live_config(request, options = nil) -> ::Gapic::Operation
update_live_config
via a request object, either of type
UpdateLiveConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Video::Stitcher::V1::UpdateLiveConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_live_config(live_config: nil, update_mask: nil) -> ::Gapic::Operation
update_live_config
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- live_config (::Google::Cloud::Video::Stitcher::V1::LiveConfig, ::Hash) — Required. The LiveConfig resource which replaces the resource on the server.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update mask applies to the resource.
For the
FieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/video/stitcher/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Video::Stitcher::V1::UpdateLiveConfigRequest.new # Call the update_live_config method. result = client.update_live_config request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#update_slate
def update_slate(request, options = nil) -> ::Gapic::Operation
def update_slate(slate: nil, update_mask: nil) -> ::Gapic::Operation
Updates the specified slate.
def update_slate(request, options = nil) -> ::Gapic::Operation
update_slate
via a request object, either of type
UpdateSlateRequest or an equivalent Hash.
- 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_slate(slate: nil, update_mask: nil) -> ::Gapic::Operation
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).
- slate (::Google::Cloud::Video::Stitcher::V1::Slate, ::Hash) — Required. The resource with updated fields.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update mask which specifies fields which should be updated.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#update_vod_config
def update_vod_config(request, options = nil) -> ::Gapic::Operation
def update_vod_config(vod_config: nil, update_mask: nil) -> ::Gapic::Operation
Updates the specified VOD config. Only update fields specified in the call method body.
def update_vod_config(request, options = nil) -> ::Gapic::Operation
update_vod_config
via a request object, either of type
UpdateVodConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Video::Stitcher::V1::UpdateVodConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_vod_config(vod_config: nil, update_mask: nil) -> ::Gapic::Operation
update_vod_config
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- vod_config (::Google::Cloud::Video::Stitcher::V1::VodConfig, ::Hash) — Required. The VOD config resource which replaces the resource on the server.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update mask applies to the resource.
For the
FieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/video/stitcher/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Video::Stitcher::V1::VideoStitcherService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Video::Stitcher::V1::UpdateVodConfigRequest.new # Call the update_vod_config method. result = client.update_vod_config request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end