class Google::Apis::TranscoderV1::TranscoderService
Transcoder API
This API converts video files into formats suitable for consumer distribution.
@example
require 'google/apis/transcoder_v1' Transcoder = Google::Apis::TranscoderV1 # Alias the module service = Transcoder::TranscoderService.new
Attributes
@return [String]
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
Public Class Methods
# File lib/google/apis/transcoder_v1/service.rb, line 45 def initialize super('https://transcoder.googleapis.com/', '', client_name: 'google-apis-transcoder_v1', client_version: Google::Apis::TranscoderV1::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Creates a job in the specified region. @param [String] parent
Required. The parent location to create and process this job. Format: ` projects/`project`/locations/`location``
@param [Google::Apis::TranscoderV1::Job] job_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TranscoderV1::Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::TranscoderV1::Job]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/transcoder_v1/service.rb, line 224 def create_project_location_job(parent, job_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/jobs', options) command.request_representation = Google::Apis::TranscoderV1::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::TranscoderV1::Job::Representation command.response_class = Google::Apis::TranscoderV1::Job command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Creates a job template in the specified region. @param [String] parent
Required. The parent location to create this job template. Format: `projects/` project`/locations/`location``
@param [Google::Apis::TranscoderV1::JobTemplate] job_template_object @param [String] job_template_id
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*`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TranscoderV1::JobTemplate] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::TranscoderV1::JobTemplate]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/transcoder_v1/service.rb, line 78 def create_project_location_job_template(parent, job_template_object = nil, job_template_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/jobTemplates', options) command.request_representation = Google::Apis::TranscoderV1::JobTemplate::Representation command.request_object = job_template_object command.response_representation = Google::Apis::TranscoderV1::JobTemplate::Representation command.response_class = Google::Apis::TranscoderV1::JobTemplate command.params['parent'] = parent unless parent.nil? command.query['jobTemplateId'] = job_template_id unless job_template_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes a job. @param [String] name
Required. The name of the job to delete. Format: `projects/`project`/locations/ `location`/jobs/`job``
@param [Boolean] allow_missing
If set to true, and the job is not found, the request will succeed but no action will be taken on the server.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TranscoderV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::TranscoderV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/transcoder_v1/service.rb, line 260 def delete_project_location_job(name, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::TranscoderV1::Empty::Representation command.response_class = Google::Apis::TranscoderV1::Empty command.params['name'] = name unless name.nil? command.query['allowMissing'] = allow_missing unless allow_missing.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes a job template. @param [String] name
Required. The name of the job template to delete. `projects/`project`/ locations/`location`/jobTemplates/`job_template``
@param [Boolean] allow_missing
If set to true, and the job template is not found, the request will succeed but no action will be taken on the server.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TranscoderV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::TranscoderV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/transcoder_v1/service.rb, line 115 def delete_project_location_job_template(name, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::TranscoderV1::Empty::Representation command.response_class = Google::Apis::TranscoderV1::Empty command.params['name'] = name unless name.nil? command.query['allowMissing'] = allow_missing unless allow_missing.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Returns the job data. @param [String] name
Required. The name of the job to retrieve. Format: `projects/`project`/ locations/`location`/jobs/`job``
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TranscoderV1::Job] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::TranscoderV1::Job]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/transcoder_v1/service.rb, line 292 def get_project_location_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::TranscoderV1::Job::Representation command.response_class = Google::Apis::TranscoderV1::Job command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Returns the job template data. @param [String] name
Required. The name of the job template to retrieve. Format: `projects/`project` /locations/`location`/jobTemplates/`job_template``
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TranscoderV1::JobTemplate] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::TranscoderV1::JobTemplate]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/transcoder_v1/service.rb, line 147 def get_project_location_job_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::TranscoderV1::JobTemplate::Representation command.response_class = Google::Apis::TranscoderV1::JobTemplate command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists job templates in the specified region. @param [String] parent
Required. The parent location from which to retrieve the collection of job templates. Format: `projects/`project`/locations/`location``
@param [String] filter
The filter expression, following the syntax outlined in https://google.aip.dev/ 160.
@param [String] order_by
One or more fields to compare and use to sort the output. See https://google. aip.dev/132#ordering.
@param [Fixnum] page_size
The maximum number of items to return.
@param [String] page_token
The `next_page_token` value returned from a previous List request, if any.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TranscoderV1::ListJobTemplatesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::TranscoderV1::ListJobTemplatesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/transcoder_v1/service.rb, line 188 def list_project_location_job_templates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/jobTemplates', options) command.response_representation = Google::Apis::TranscoderV1::ListJobTemplatesResponse::Representation command.response_class = Google::Apis::TranscoderV1::ListJobTemplatesResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists jobs in the specified region. @param [String] parent
Required. Format: `projects/`project`/locations/`location``
@param [String] filter
The filter expression, following the syntax outlined in https://google.aip.dev/ 160.
@param [String] order_by
One or more fields to compare and use to sort the output. See https://google. aip.dev/132#ordering.
@param [Fixnum] page_size
The maximum number of items to return.
@param [String] page_token
The `next_page_token` value returned from a previous List request, if any.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::TranscoderV1::ListJobsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::TranscoderV1::ListJobsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/transcoder_v1/service.rb, line 332 def list_project_location_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/jobs', options) command.response_representation = Google::Apis::TranscoderV1::ListJobsResponse::Representation command.response_class = Google::Apis::TranscoderV1::ListJobsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File lib/google/apis/transcoder_v1/service.rb, line 348 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end