Class TranscoderServiceAsyncClient (1.3.2)

TranscoderServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.video.transcoder_v1.services.transcoder_service.transports.base.TranscoderServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = 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.

Inheritance

builtins.object > TranscoderServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
TranscoderServiceTransportThe transport used by the client instance.

Methods

TranscoderServiceAsyncClient

TranscoderServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.video.transcoder_v1.services.transcoder_service.transports.base.TranscoderServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the transcoder service client.

Parameters
NameDescription
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_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_job

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

Creates a job in the specified region.

from google.cloud.video import transcoder_v1

async def sample_create_job():
    # Create a client
    client = transcoder_v1.TranscoderServiceAsyncClient()

    # Initialize request argument(s)
    job = transcoder_v1.Job()
    job.template_id = "template_id_value"

    request = transcoder_v1.CreateJobRequest(
        parent="parent_value",
        job=job,
    )

    # Make the request
    response = await client.create_job(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.video.transcoder_v1.types.CreateJobRequest, dict]

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 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
TypeDescription
google.cloud.video.transcoder_v1.types.JobTranscoding job resource.

create_job_template

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

Creates a job template in the specified region.

from google.cloud.video import transcoder_v1

async def sample_create_job_template():
    # Create a client
    client = transcoder_v1.TranscoderServiceAsyncClient()

    # Initialize request argument(s)
    request = transcoder_v1.CreateJobTemplateRequest(
        parent="parent_value",
        job_template_id="job_template_id_value",
    )

    # Make the request
    response = await client.create_job_template(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.video.transcoder_v1.types.CreateJobTemplateRequest, dict]

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 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 must match the regular expression `a-zA-Z][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
TypeDescription
google.cloud.video.transcoder_v1.types.JobTemplateTranscoding job template resource.

delete_job

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

Deletes a job.

from google.cloud.video import transcoder_v1

async def sample_delete_job():
    # Create a client
    client = transcoder_v1.TranscoderServiceAsyncClient()

    # Initialize request argument(s)
    request = transcoder_v1.DeleteJobRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_job(request=request)
Parameters
NameDescription
request Union[google.cloud.video.transcoder_v1.types.DeleteJobRequest, dict]

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[Union[google.cloud.video.transcoder_v1.types.services.DeleteJobTemplateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a job template.

from google.cloud.video import transcoder_v1

async def sample_delete_job_template():
    # Create a client
    client = transcoder_v1.TranscoderServiceAsyncClient()

    # Initialize request argument(s)
    request = transcoder_v1.DeleteJobTemplateRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_job_template(request=request)
Parameters
NameDescription
request Union[google.cloud.video.transcoder_v1.types.DeleteJobTemplateRequest, dict]

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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
TranscoderServiceAsyncClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
TranscoderServiceAsyncClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
TranscoderServiceAsyncClientThe constructed client.

get_job

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

Returns the job data.

from google.cloud.video import transcoder_v1

async def sample_get_job():
    # Create a client
    client = transcoder_v1.TranscoderServiceAsyncClient()

    # Initialize request argument(s)
    request = transcoder_v1.GetJobRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_job(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.video.transcoder_v1.types.GetJobRequest, dict]

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
TypeDescription
google.cloud.video.transcoder_v1.types.JobTranscoding job resource.

get_job_template

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

Returns the job template data.

from google.cloud.video import transcoder_v1

async def sample_get_job_template():
    # Create a client
    client = transcoder_v1.TranscoderServiceAsyncClient()

    # Initialize request argument(s)
    request = transcoder_v1.GetJobTemplateRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_job_template(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.video.transcoder_v1.types.GetJobTemplateRequest, dict]

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
TypeDescription
google.cloud.video.transcoder_v1.types.JobTemplateTranscoding job template resource.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

job_path

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

Returns a fully-qualified job string.

job_template_path

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

Returns a fully-qualified job_template string.

list_job_templates

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

Lists job templates in the specified region.

from google.cloud.video import transcoder_v1

async def sample_list_job_templates():
    # Create a client
    client = transcoder_v1.TranscoderServiceAsyncClient()

    # Initialize request argument(s)
    request = transcoder_v1.ListJobTemplatesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_job_templates(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.video.transcoder_v1.types.ListJobTemplatesRequest, dict]

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
TypeDescription
google.cloud.video.transcoder_v1.services.transcoder_service.pagers.ListJobTemplatesAsyncPagerResponse message for TranscoderService.ListJobTemplates. Iterating over this object will yield results and resolve additional pages automatically.

list_jobs

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

Lists jobs in the specified region.

from google.cloud.video import transcoder_v1

async def sample_list_jobs():
    # Create a client
    client = transcoder_v1.TranscoderServiceAsyncClient()

    # Initialize request argument(s)
    request = transcoder_v1.ListJobsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_jobs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.video.transcoder_v1.types.ListJobsRequest, dict]

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
TypeDescription
google.cloud.video.transcoder_v1.services.transcoder_service.pagers.ListJobsAsyncPagerResponse message for TranscoderService.ListJobs. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_job_path

parse_job_path(path: str)

Parses a job path into its component segments.

parse_job_template_path

parse_job_template_path(path: str)

Parses a job_template path into its component segments.