`airflow.providers.google.cloud.hooks.vision`¶

This module contains a Google Cloud Vision Hook.

Module Contents¶

Classes¶

`NameDeterminer`	Helper class to determine entity name.
`CloudVisionHook`	Hook for Google Cloud Vision APIs.

Attributes¶

`ERR_DIFF_NAMES`
`ERR_UNABLE_TO_CREATE`

airflow.providers.google.cloud.hooks.vision.ERR_DIFF_NAMES = Multiline-String[source]¶

Show Value

"""The {label} name provided in the object ({explicit_name}) is different
    than the name created from the input parameters ({constructed_name}). Please either:
    1) Remove the {label} name,
    2) Remove the location and {id_label} parameters,
    3) Unify the {label} name and input parameters.
    """

airflow.providers.google.cloud.hooks.vision.ERR_UNABLE_TO_CREATE = Multiline-String[source]¶

Show Value

"""Unable to determine the {label} name. Please either set the name directly
    in the {label} object or provide the `location` and `{id_label}` parameters.
    """

class airflow.providers.google.cloud.hooks.vision.NameDeterminer(label, id_label, get_path)[source]¶

Helper class to determine entity name.

get_entity_with_name(entity, entity_id, location, project_id)[source]¶

Check if entity has the name attribute set.

If so, no action is taken.
If not, and the name can be constructed from other parameters provided, it is created and filled in
the entity.
If both the entity’s ‘name’ attribute is set and the name can be constructed from other parameters
provided: * If they are the same - no action is taken * if they are different - an exception is thrown.

Parameters

entity (Any) – Entity
entity_id (str | None) – Entity id
location (str | None) – Location
project_id (str) – The id of Google Cloud Vision project.

Returns

The same entity or entity with new name

Raises

AirflowException

Return type

Any

class airflow.providers.google.cloud.hooks.vision.CloudVisionHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

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

Hook for Google Cloud Vision APIs.

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

product_name_determiner[source]¶

product_set_name_determiner[source]¶

get_conn()[source]¶

Retrieves connection to Cloud Vision.

Returns: Google Cloud Vision client object.
Return type: google.cloud.vision_v1.ProductSearchClient

annotator_client()[source]¶

Creates ImageAnnotatorClient.

Returns: Google Image Annotator client object.
Return type: google.cloud.vision_v1.ImageAnnotatorClient

create_product_set(location, product_set, project_id=PROVIDE_PROJECT_ID, product_set_id=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

Create product set.

For the documentation see: CloudVisionCreateProductSetOperator.

get_product_set(location, product_set_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

Get product set.

For the documentation see: CloudVisionGetProductSetOperator.

update_product_set(product_set, project_id=PROVIDE_PROJECT_ID, location=None, product_set_id=None, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

Update product set.

For the documentation see: CloudVisionUpdateProductSetOperator.

delete_product_set(location, product_set_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

Delete product set.

For the documentation see: CloudVisionDeleteProductSetOperator.

create_product(location, product, project_id=PROVIDE_PROJECT_ID, product_id=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

Create product.

For the documentation see: CloudVisionCreateProductOperator.

get_product(location, product_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

Get product.

For the documentation see: CloudVisionGetProductOperator.

update_product(product, project_id=PROVIDE_PROJECT_ID, location=None, product_id=None, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

Update product.

For the documentation see: CloudVisionUpdateProductOperator.

delete_product(location, product_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶

Delete product.

For the documentation see: CloudVisionDeleteProductOperator.

create_reference_image(location, product_id, reference_image, project_id, reference_image_id=None, retry=DEFAULT, timeout=None, metadata=())[source]¶

Create reference image.

For the documentation see: CloudVisionCreateReferenceImageOperator.

delete_reference_image(location, product_id, reference_image_id, project_id, retry=DEFAULT, timeout=None, metadata=())[source]¶

Delete reference image.

For the documentation see: CloudVisionDeleteReferenceImageOperator.

add_product_to_product_set(product_set_id, product_id, project_id, location, retry=DEFAULT, timeout=None, metadata=())[source]¶

Add product to product set.

For the documentation see: CloudVisionAddProductToProductSetOperator.

remove_product_from_product_set(product_set_id, product_id, project_id, location, retry=DEFAULT, timeout=None, metadata=())[source]¶