class Google::Cloud::Video::Transcoder::V1::TranscoderService::Client
Client
for the TranscoderService
service.
Using the Transcoder
API, you can queue asynchronous jobs for transcoding media into various output formats. Output formats may include different streaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can also customize jobs using advanced features such as Digital Rights Management (DRM), audio equalization, content concatenation, and digital ad-stitch ready content generation.
Attributes
@private
Public Class Methods
Configure the TranscoderService
Client
class.
See {::Google::Cloud::Video::Transcoder::V1::TranscoderService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all TranscoderService clients ::Google::Cloud::Video::Transcoder::V1::TranscoderService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 62 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Video", "Transcoder", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.create_job.timeout = 60.0 default_config.rpcs.list_jobs.timeout = 60.0 default_config.rpcs.get_job.timeout = 60.0 default_config.rpcs.delete_job.timeout = 60.0 default_config.rpcs.create_job_template.timeout = 60.0 default_config.rpcs.list_job_templates.timeout = 60.0 default_config.rpcs.get_job_template.timeout = 60.0 default_config.rpcs.delete_job_template.timeout = 60.0 default_config end yield @configure if block_given? @configure end
Create a new TranscoderService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Video::Transcoder::V1::TranscoderService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Video::Transcoder::V1::TranscoderService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the TranscoderService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 136 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/video/transcoder/v1/services_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @transcoder_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Video::Transcoder::V1::TranscoderService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the TranscoderService
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 {::Google::Cloud::Video::Transcoder::V1::TranscoderService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 115 def configure yield @config if block_given? @config end
Creates a job in the specified region.
@overload create_job
(request, options = nil)
Pass arguments to `create_job` via a request object, either of type {::Google::Cloud::Video::Transcoder::V1::CreateJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Video::Transcoder::V1::CreateJobRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_job
(parent: nil, job: nil)
Pass arguments to `create_job` 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). @param parent [::String] Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}` @param job [::Google::Cloud::Video::Transcoder::V1::Job, ::Hash] Required. Parameters for creating transcoding job.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Video::Transcoder::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Video::Transcoder::V1::Job]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 206 def create_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Transcoder::V1::CreateJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Video::Transcoder::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_job.timeout, metadata: metadata, retry_policy: @config.rpcs.create_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @transcoder_service_stub.call_rpc :create_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Creates a job template in the specified region.
@overload create_job_template
(request, options = nil)
Pass arguments to `create_job_template` via a request object, either of type {::Google::Cloud::Video::Transcoder::V1::CreateJobTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Video::Transcoder::V1::CreateJobTemplateRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_job_template
(parent: nil, job_template: nil, job_template_id: nil)
Pass arguments to `create_job_template` 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). @param parent [::String] Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}` @param job_template [::Google::Cloud::Video::Transcoder::V1::JobTemplate, ::Hash] Required. Parameters for creating job template. @param job_template_id [::String] Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the regular expression `[a-zA-Z][a-zA-Z0-9_-]*`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Video::Transcoder::V1::JobTemplate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Video::Transcoder::V1::JobTemplate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 501 def create_job_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Transcoder::V1::CreateJobTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_job_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Video::Transcoder::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_job_template.timeout, metadata: metadata, retry_policy: @config.rpcs.create_job_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @transcoder_service_stub.call_rpc :create_job_template, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a job.
@overload delete_job
(request, options = nil)
Pass arguments to `delete_job` via a request object, either of type {::Google::Cloud::Video::Transcoder::V1::DeleteJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Video::Transcoder::V1::DeleteJobRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_job
(name: nil)
Pass arguments to `delete_job` 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). @param name [::String] Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 424 def delete_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Transcoder::V1::DeleteJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Video::Transcoder::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_job.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @transcoder_service_stub.call_rpc :delete_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a job template.
@overload delete_job_template
(request, options = nil)
Pass arguments to `delete_job_template` via a request object, either of type {::Google::Cloud::Video::Transcoder::V1::DeleteJobTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Video::Transcoder::V1::DeleteJobTemplateRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_job_template
(name: nil)
Pass arguments to `delete_job_template` 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). @param name [::String] Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 721 def delete_job_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Transcoder::V1::DeleteJobTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_job_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Video::Transcoder::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_job_template.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_job_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @transcoder_service_stub.call_rpc :delete_job_template, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Returns the job data.
@overload get_job
(request, options = nil)
Pass arguments to `get_job` via a request object, either of type {::Google::Cloud::Video::Transcoder::V1::GetJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Video::Transcoder::V1::GetJobRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_job
(name: nil)
Pass arguments to `get_job` 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). @param name [::String] Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Video::Transcoder::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Video::Transcoder::V1::Job]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 355 def get_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Transcoder::V1::GetJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Video::Transcoder::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_job.timeout, metadata: metadata, retry_policy: @config.rpcs.get_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @transcoder_service_stub.call_rpc :get_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Returns the job template data.
@overload get_job_template
(request, options = nil)
Pass arguments to `get_job_template` via a request object, either of type {::Google::Cloud::Video::Transcoder::V1::GetJobTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Video::Transcoder::V1::GetJobTemplateRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_job_template
(name: nil)
Pass arguments to `get_job_template` 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). @param name [::String] Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Video::Transcoder::V1::JobTemplate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Video::Transcoder::V1::JobTemplate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 652 def get_job_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Transcoder::V1::GetJobTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_job_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Video::Transcoder::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_job_template.timeout, metadata: metadata, retry_policy: @config.rpcs.get_job_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @transcoder_service_stub.call_rpc :get_job_template, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists job templates in the specified region.
@overload list_job_templates
(request, options = nil)
Pass arguments to `list_job_templates` via a request object, either of type {::Google::Cloud::Video::Transcoder::V1::ListJobTemplatesRequest} or an equivalent Hash. @param request [::Google::Cloud::Video::Transcoder::V1::ListJobTemplatesRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_job_templates
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_job_templates` 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). @param parent [::String] Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}` @param page_size [::Integer] The maximum number of items to return. @param page_token [::String] The `next_page_token` value returned from a previous List request, if any. @param filter [::String] The filter expression, following the syntax outlined in https://google.aip.dev/160. @param order_by [::String] One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Video::Transcoder::V1::JobTemplate>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Video::Transcoder::V1::JobTemplate>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 581 def list_job_templates request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Transcoder::V1::ListJobTemplatesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_job_templates.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Video::Transcoder::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_job_templates.timeout, metadata: metadata, retry_policy: @config.rpcs.list_job_templates.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @transcoder_service_stub.call_rpc :list_job_templates, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @transcoder_service_stub, :list_job_templates, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists jobs in the specified region.
@overload list_jobs
(request, options = nil)
Pass arguments to `list_jobs` via a request object, either of type {::Google::Cloud::Video::Transcoder::V1::ListJobsRequest} or an equivalent Hash. @param request [::Google::Cloud::Video::Transcoder::V1::ListJobsRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_jobs
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_jobs` 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). @param parent [::String] Required. Format: `projects/{project}/locations/{location}` @param page_size [::Integer] The maximum number of items to return. @param page_token [::String] The `next_page_token` value returned from a previous List request, if any. @param filter [::String] The filter expression, following the syntax outlined in https://google.aip.dev/160. @param order_by [::String] One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Video::Transcoder::V1::Job>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Video::Transcoder::V1::Job>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/video/transcoder/v1/transcoder_service/client.rb, line 285 def list_jobs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Video::Transcoder::V1::ListJobsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_jobs.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Video::Transcoder::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_jobs.timeout, metadata: metadata, retry_policy: @config.rpcs.list_jobs.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @transcoder_service_stub.call_rpc :list_jobs, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @transcoder_service_stub, :list_jobs, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end