blob: 050f6b28e7f289dff781524421501234790e03a4 [file] [log] [blame]
:mod:`airflow.contrib.operators.gcp_text_to_speech_operator`
============================================================
.. py:module:: airflow.contrib.operators.gcp_text_to_speech_operator
Module Contents
---------------
.. py:class:: GcpTextToSpeechSynthesizeOperator(input_data, voice, audio_config, target_bucket_name, target_filename, project_id=None, gcp_conn_id='google_cloud_default', retry=None, timeout=None, *args, **kwargs)
Bases: :class:`airflow.models.BaseOperator`
Synthesizes text to speech and stores it in Google Cloud Storage
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:GcpTextToSpeechSynthesizeOperator`
:param input_data: text input to be synthesized. See more:
https://googleapis.github.io/google-cloud-python/latest/texttospeech/gapic/v1/types.html#google.cloud.texttospeech_v1.types.SynthesisInput
:type input_data: dict or google.cloud.texttospeech_v1.types.SynthesisInput
:param voice: configuration of voice to be used in synthesis. See more:
https://googleapis.github.io/google-cloud-python/latest/texttospeech/gapic/v1/types.html#google.cloud.texttospeech_v1.types.VoiceSelectionParams
:type voice: dict or google.cloud.texttospeech_v1.types.VoiceSelectionParams
:param audio_config: configuration of the synthesized audio. See more:
https://googleapis.github.io/google-cloud-python/latest/texttospeech/gapic/v1/types.html#google.cloud.texttospeech_v1.types.AudioConfig
:type audio_config: dict or google.cloud.texttospeech_v1.types.AudioConfig
:param target_bucket_name: name of the GCS bucket in which output file should be stored
:type target_bucket_name: str
:param target_filename: filename of the output file.
:type target_filename: str
:param project_id: Optional, Google Cloud Platform Project ID where the Compute
Engine Instance exists. If set to None or missing, the default project_id from the GCP connection is
used.
:type project_id: str
:param gcp_conn_id: Optional, The connection ID used to connect to Google Cloud
Platform. Defaults to 'google_cloud_default'.
:type gcp_conn_id: str
:param retry: (Optional) A retry object used to retry requests. If None is specified,
requests will not be retried.
:type retry: google.api_core.retry.Retry
:param timeout: (Optional) The amount of time, in seconds, to wait for the request to complete.
Note that if retry is specified, the timeout applies to each individual attempt.
:type timeout: float
.. attribute:: template_fields
:annotation: = ['input_data', 'voice', 'audio_config', 'project_id', 'gcp_conn_id', 'target_bucket_name', 'target_filename']
.. method:: _validate_inputs(self)
.. method:: execute(self, context)