Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::LivestreamService::Client (v0.5.0)

Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::LivestreamService::Client.

Client for the LivestreamService service.

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

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the LivestreamService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all LivestreamService clients
::Google::Cloud::Video::LiveStream::V1::LivestreamService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the LivestreamService Client instance.

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

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_channel

def create_channel(request, options = nil) -> ::Gapic::Operation
def create_channel(parent: nil, channel: nil, channel_id: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads 
def create_channel(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_channel via a request object, either of type CreateChannelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::CreateChannelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_channel(parent: nil, channel: nil, channel_id: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.
  • channel (::Google::Cloud::Video::LiveStream::V1::Channel, ::Hash) — Required. The channel resource to be created.
  • channel_id (::String) — Required. The ID of the channel resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.
  • request_id (::String) — 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.
Example

Basic example

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

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

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

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

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

#create_event

def create_event(request, options = nil) -> ::Google::Cloud::Video::LiveStream::V1::Event
def create_event(parent: nil, event: nil, event_id: nil, request_id: nil) -> ::Google::Cloud::Video::LiveStream::V1::Event

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

Overloads 
def create_event(request, options = nil) -> ::Google::Cloud::Video::LiveStream::V1::Event
Pass arguments to create_event via a request object, either of type CreateEventRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::CreateEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_event(parent: nil, event: nil, event_id: nil, request_id: nil) -> ::Google::Cloud::Video::LiveStream::V1::Event
Pass arguments to create_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.
  • event (::Google::Cloud::Video::LiveStream::V1::Event, ::Hash) — Required. The event resource to be created.
  • event_id (::String) — Required. The ID of the event resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.
  • request_id (::String) — 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
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

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

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

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

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

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

#create_input

def create_input(request, options = nil) -> ::Gapic::Operation
def create_input(parent: nil, input: nil, input_id: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads 
def create_input(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_input via a request object, either of type CreateInputRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::CreateInputRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_input(parent: nil, input: nil, input_id: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_input via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.
  • input (::Google::Cloud::Video::LiveStream::V1::Input, ::Hash) — Required. The input resource to be created.
  • input_id (::String) — Required. The ID of the input resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.
  • request_id (::String) — 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.
Example

Basic example

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

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

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

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

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

#delete_channel

def delete_channel(request, options = nil) -> ::Gapic::Operation
def delete_channel(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation

Deletes the specified channel.

Overloads 
def delete_channel(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_channel via a request object, either of type DeleteChannelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_channel(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.
  • 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 after the first request.

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

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

  • force (::Boolean) — If the force field is set to the default value of false, you must delete all of a channel's events before you can delete the channel itself. If the field is set to true, requests to delete a channel also delete associated channel events.
Yields
  • (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.
Example

Basic example

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

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

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

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

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

#delete_event

def delete_event(request, options = nil) -> ::Google::Protobuf::Empty
def delete_event(name: nil, request_id: nil) -> ::Google::Protobuf::Empty

Deletes the specified event.

Overloads 
def delete_event(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_event via a request object, either of type DeleteEventRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::DeleteEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_event(name: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the event resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.
  • 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).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

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

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

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

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

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

#delete_input

def delete_input(request, options = nil) -> ::Gapic::Operation
def delete_input(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes the specified input.

Overloads 
def delete_input(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_input via a request object, either of type DeleteInputRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::DeleteInputRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_input(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_input via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the input resource, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.
  • 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).

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.
Example

Basic example

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

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

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

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

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

#get_channel

def get_channel(request, options = nil) -> ::Google::Cloud::Video::LiveStream::V1::Channel
def get_channel(name: nil) -> ::Google::Cloud::Video::LiveStream::V1::Channel

Returns the specified channel.

Overloads 
def get_channel(request, options = nil) -> ::Google::Cloud::Video::LiveStream::V1::Channel
Pass arguments to get_channel via a request object, either of type GetChannelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::GetChannelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_channel(name: nil) -> ::Google::Cloud::Video::LiveStream::V1::Channel
Pass arguments to get_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

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

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

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

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

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

#get_event

def get_event(request, options = nil) -> ::Google::Cloud::Video::LiveStream::V1::Event
def get_event(name: nil) -> ::Google::Cloud::Video::LiveStream::V1::Event

Returns the specified event.

Overloads 
def get_event(request, options = nil) -> ::Google::Cloud::Video::LiveStream::V1::Event
Pass arguments to get_event via a request object, either of type GetEventRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::GetEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_event(name: nil) -> ::Google::Cloud::Video::LiveStream::V1::Event
Pass arguments to get_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the event resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

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

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

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

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

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

#get_input

def get_input(request, options = nil) -> ::Google::Cloud::Video::LiveStream::V1::Input
def get_input(name: nil) -> ::Google::Cloud::Video::LiveStream::V1::Input

Returns the specified input.

Overloads 
def get_input(request, options = nil) -> ::Google::Cloud::Video::LiveStream::V1::Input
Pass arguments to get_input via a request object, either of type GetInputRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::GetInputRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_input(name: nil) -> ::Google::Cloud::Video::LiveStream::V1::Input
Pass arguments to get_input via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the input resource, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

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

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

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

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

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

#initialize

def initialize() { |config| ... } -> Client

Create a new LivestreamService client object.

Yields
  • (config) — Configure the LivestreamService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Client.new

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

#list_channels

def list_channels(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Channel>
def list_channels(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Channel>

Returns a list of all channels in the specified region.

Overloads 
def list_channels(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Channel>
Pass arguments to list_channels via a request object, either of type Google::Cloud::Video::LiveStream::V1::ListChannelsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::ListChannelsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_channels(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Channel>
Pass arguments to list_channels via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.
  • page_size (::Integer) — The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
  • page_token (::String) — The next_page_token value returned from a previous List request, if any.
  • filter (::String) — The filter to apply to list results.
  • order_by (::String) — Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

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

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

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

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

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

#list_events

def list_events(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Event>
def list_events(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Event>

Returns a list of all events in the specified channel.

Overloads 
def list_events(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Event>
Pass arguments to list_events via a request object, either of type Google::Cloud::Video::LiveStream::V1::ListEventsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::ListEventsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_events(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Event>
Pass arguments to list_events via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.
  • page_size (::Integer) — The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
  • page_token (::String) — The next_page_token value returned from a previous List request, if any.
  • filter (::String) — The filter to apply to list results.
  • order_by (::String) — Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

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

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

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

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

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

#list_inputs

def list_inputs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Input>
def list_inputs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Input>

Returns a list of all inputs in the specified region.

Overloads 
def list_inputs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Input>
Pass arguments to list_inputs via a request object, either of type Google::Cloud::Video::LiveStream::V1::ListInputsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::ListInputsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_inputs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Video::LiveStream::V1::Input>
Pass arguments to list_inputs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.
  • page_size (::Integer) — The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.
  • page_token (::String) — The next_page_token value returned from a previous List request, if any.
  • filter (::String) — The filter to apply to list results.
  • order_by (::String) — Specifies the ordering of results following syntax at Sorting Order.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

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

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

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

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

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

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

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

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

#operations_client

def operations_client() -> ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Operations

Get the associated client for long-running operations.

Returns

#start_channel

def start_channel(request, options = nil) -> ::Gapic::Operation
def start_channel(name: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads 
def start_channel(request, options = nil) -> ::Gapic::Operation
Pass arguments to start_channel via a request object, either of type StartChannelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::StartChannelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def start_channel(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to start_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.
  • 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).

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.
Example

Basic example

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

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

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

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

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

#stop_channel

def stop_channel(request, options = nil) -> ::Gapic::Operation
def stop_channel(name: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads 
def stop_channel(request, options = nil) -> ::Gapic::Operation
Pass arguments to stop_channel via a request object, either of type StopChannelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::StopChannelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def stop_channel(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to stop_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.
  • 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).

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.
Example

Basic example

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

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

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

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

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

#update_channel

def update_channel(request, options = nil) -> ::Gapic::Operation
def update_channel(update_mask: nil, channel: nil, request_id: nil) -> ::Gapic::Operation

Updates the specified channel.

Overloads 
def update_channel(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_channel via a request object, either of type UpdateChannelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::UpdateChannelRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_channel(update_mask: nil, channel: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_channel via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Field mask is used to specify the fields to be overwritten in the Channel resource by the update. You can only update the following fields:

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

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

  • channel (::Google::Cloud::Video::LiveStream::V1::Channel, ::Hash) — Required. The channel resource to be updated.
  • 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).

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.
Example

Basic example

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

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

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

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

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

#update_input

def update_input(request, options = nil) -> ::Gapic::Operation
def update_input(update_mask: nil, input: nil, request_id: nil) -> ::Gapic::Operation

Updates the specified input.

Overloads 
def update_input(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_input via a request object, either of type UpdateInputRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Video::LiveStream::V1::UpdateInputRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_input(update_mask: nil, input: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_input via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Field mask is used to specify the fields to be overwritten in the Input resource by the update. You can only update the following fields:

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

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

  • input (::Google::Cloud::Video::LiveStream::V1::Input, ::Hash) — Required. The input resource to be updated.
  • 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).

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.
Example

Basic example

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

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

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

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

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