airflow.providers.google.cloud.hooks.video_intelligence

This module contains a Google Cloud Video Intelligence Hook.

Module Contents

class airflow.providers.google.cloud.hooks.video_intelligence.CloudVideoIntelligenceHook(gcp_conn_id: str = 'google_cloud_default', delegate_to: Optional[str] = None, impersonation_chain: Optional[Union[str, Sequence[str]]] = None)[source]

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Hook for Google Cloud Video Intelligence APIs.

All the methods in the hook where project_id is used must be called with keyword arguments rather than positional.

Parameters

  • gcp_conn_id (str) -- The connection ID to use when fetching connection info.

  • delegate_to (str) -- The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (Union[str, Sequence[str]]) -- Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account.

get_conn(self)[source]

Returns Gcp Video Intelligence Service client

Return type

google.cloud.videointelligence_v1.VideoIntelligenceServiceClient

annotate_video(self, input_uri: Optional[str] = None, input_content: Optional[bytes] = None, features: Optional[List[VideoIntelligenceServiceClient.enums.Feature]] = None, video_context: Union[Dict, VideoContext] = None, output_uri: Optional[str] = None, location: Optional[str] = None, retry: Optional[Retry] = None, timeout: Optional[float] = None, metadata: Optional[Sequence[Tuple[str, str]]] = None)[source]

Performs video annotation.

Parameters

  • input_uri (str) -- Input video location. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id.

  • input_content (bytes) -- The video data bytes. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

  • features (list[google.cloud.videointelligence_v1.VideoIntelligenceServiceClient.enums.Feature]) -- Requested video annotation features.

  • output_uri (str) -- Optional, location where the output (in JSON format) should be stored. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id.

  • video_context (dict or google.cloud.videointelligence_v1.types.VideoContext) -- Optional, Additional video context and/or feature-specific parameters.

  • location (str) -- Optional, cloud region where annotation should take place. Supported cloud regions: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, a region will be determined based on video file location.

  • retry (google.api_core.retry.Retry) -- Retry object used to determine when/if to retry requests. If None is specified, requests will not be retried.

  • timeout (float) -- 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.

  • metadata (seq[tuple[str, str]]) -- Optional, Additional metadata that is provided to the method.

Was this entry helpful?