Class TranscoderServiceClient (0.1.0)

TranscoderServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.video.transcoder_v1beta1.services.transcoder_service.transports.base.TranscoderServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-video-transcoder/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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.

Methods

TranscoderServiceClient

TranscoderServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.video.transcoder_v1beta1.services.transcoder_service.transports.base.TranscoderServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-video-transcoder/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the transcoder service client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .TranscoderServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

create_job

create_job(request: Optional[google.cloud.video.transcoder_v1beta1.types.services.CreateJobRequest] = None, *, parent: Optional[str] = None, job: Optional[google.cloud.video.transcoder_v1beta1.types.resources.Job] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a job in the specified region.

Parameters
Name	Description
`request`	`.services.CreateJobRequest` The request object. Request message for `TranscoderService.CreateJob`.
`parent`	`str` Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`job`	`.resources.Job` Required. Parameters for creating transcoding job. This corresponds to the `job` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.resources.Job`	Transcoding job resource.

create_job_template

create_job_template(request: Optional[google.cloud.video.transcoder_v1beta1.types.services.CreateJobTemplateRequest] = None, *, parent: Optional[str] = None, job_template: Optional[google.cloud.video.transcoder_v1beta1.types.resources.JobTemplate] = None, job_template_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a job template in the specified region.

Parameters
Name	Description
`request`	`.services.CreateJobTemplateRequest` The request object. Request message for `TranscoderService.CreateJobTemplate`.
`parent`	`str` Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`job_template`	`.resources.JobTemplate` Required. Parameters for creating job template. This corresponds to the `job_template` field on the `request` instance; if `request` is provided, this should not be set.
`job_template_id`	`str` 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 are `/[a-zA-Z0-9_-_]/`. This corresponds to the `job_template_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.resources.JobTemplate`	Transcoding job template resource.

delete_job

delete_job(request: Optional[google.cloud.video.transcoder_v1beta1.types.services.DeleteJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a job.

Parameters
Name	Description
`request`	`.services.DeleteJobRequest` The request object. Request message for `TranscoderService.DeleteJob`.
`name`	`str` Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

delete_job_template

delete_job_template(request: Optional[google.cloud.video.transcoder_v1beta1.types.services.DeleteJobTemplateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a job template.

Parameters
Name	Description
`request`	`.services.DeleteJobTemplateRequest` The request object. Request message for `TranscoderService.DeleteJobTemplate`.
`name`	`str` Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

get_job

get_job(request: Optional[google.cloud.video.transcoder_v1beta1.types.services.GetJobRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the job data.

Parameters
Name	Description
`request`	`.services.GetJobRequest` The request object. Request message for `TranscoderService.GetJob`.
`name`	`str` Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.resources.Job`	Transcoding job resource.

get_job_template

get_job_template(request: Optional[google.cloud.video.transcoder_v1beta1.types.services.GetJobTemplateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the job template data.

Parameters
Name	Description
`request`	`.services.GetJobTemplateRequest` The request object. Request message for `TranscoderService.GetJobTemplate`.
`name`	`str` Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.resources.JobTemplate`	Transcoding job template resource.

job_path

job_path(project: str, location: str, job: str)

Return a fully-qualified job string.

job_template_path

job_template_path(project: str, location: str, job_template: str)

Return a fully-qualified job_template string.

list_job_templates

list_job_templates(request: Optional[google.cloud.video.transcoder_v1beta1.types.services.ListJobTemplatesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists job templates in the specified region.

Parameters
Name	Description
`request`	`.services.ListJobTemplatesRequest` The request object. Request message for `TranscoderService.ListJobTemplates`.
`parent`	`str` Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.pagers.ListJobTemplatesPager`	Response message for `TranscoderService.ListJobTemplates`. Iterating over this object will yield results and resolve additional pages automatically.

list_jobs

list_jobs(request: Optional[google.cloud.video.transcoder_v1beta1.types.services.ListJobsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists jobs in the specified region.

Parameters
Name	Description
`request`	`.services.ListJobsRequest` The request object. Request message for `TranscoderService.ListJobs`. The parent location from which to retrieve the collection of jobs.
`parent`	`str` Required. Format: `projects/{project}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.pagers.ListJobsPager`	Response message for `TranscoderService.ListJobs`. Iterating over this object will yield results and resolve additional pages automatically.

parse_job_path

parse_job_path(path: str)

Parse a job path into its component segments.

parse_job_template_path

parse_job_template_path(path: str)

Parse a job_template path into its component segments.