# Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module TranscoderV1beta1 # Transcoder API # # This API converts video files into formats suitable for consumer distribution. # # @example # require 'google/apis/transcoder_v1beta1' # # Transcoder = Google::Apis::TranscoderV1beta1 # Alias the module # service = Transcoder::TranscoderService.new # # @see https://cloud.google.com/transcoder/docs/ class TranscoderService < Google::Apis::Core::BaseService # @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. attr_accessor :key # @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. attr_accessor :quota_user def initialize super('https://transcoder.googleapis.com/', '') @batch_path = 'batch' 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::TranscoderV1beta1::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::TranscoderV1beta1::JobTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranscoderV1beta1::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 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, 'v1beta1/{+parent}/jobTemplates', options) command.request_representation = Google::Apis::TranscoderV1beta1::JobTemplate::Representation command.request_object = job_template_object command.response_representation = Google::Apis::TranscoderV1beta1::JobTemplate::Representation command.response_class = Google::Apis::TranscoderV1beta1::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 template. # @param [String] name # Required. The name of the job template to delete. `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::TranscoderV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranscoderV1beta1::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 def delete_project_location_job_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::TranscoderV1beta1::Empty::Representation command.response_class = Google::Apis::TranscoderV1beta1::Empty 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::TranscoderV1beta1::JobTemplate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranscoderV1beta1::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 def get_project_location_job_template(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::TranscoderV1beta1::JobTemplate::Representation command.response_class = Google::Apis::TranscoderV1beta1::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 [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::TranscoderV1beta1::ListJobTemplatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranscoderV1beta1::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 def list_project_location_job_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/jobTemplates', options) command.response_representation = Google::Apis::TranscoderV1beta1::ListJobTemplatesResponse::Representation command.response_class = Google::Apis::TranscoderV1beta1::ListJobTemplatesResponse command.params['parent'] = parent unless parent.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 # 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::TranscoderV1beta1::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::TranscoderV1beta1::Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranscoderV1beta1::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 def create_project_location_job(parent, job_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/jobs', options) command.request_representation = Google::Apis::TranscoderV1beta1::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::TranscoderV1beta1::Job::Representation command.response_class = Google::Apis::TranscoderV1beta1::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 # Deletes a job. # @param [String] name # Required. The name of the job to delete. 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::TranscoderV1beta1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranscoderV1beta1::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 def delete_project_location_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::TranscoderV1beta1::Empty::Representation command.response_class = Google::Apis::TranscoderV1beta1::Empty 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 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::TranscoderV1beta1::Job] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranscoderV1beta1::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 def get_project_location_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', options) command.response_representation = Google::Apis::TranscoderV1beta1::Job::Representation command.response_class = Google::Apis::TranscoderV1beta1::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 # Lists jobs in the specified region. # @param [String] parent # Required. Format: `projects/`project`/locations/`location`` # @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::TranscoderV1beta1::ListJobsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::TranscoderV1beta1::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 def list_project_location_jobs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/jobs', options) command.response_representation = Google::Apis::TranscoderV1beta1::ListJobsResponse::Representation command.response_class = Google::Apis::TranscoderV1beta1::ListJobsResponse command.params['parent'] = parent unless parent.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 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end end end end end