CloudVisionUpdateProductSetOperator

Google

Makes changes to a ProductSet resource. Only display_name can be updated currently.

View Source

Last Updated: May. 7, 2021

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

product_setdict or google.cloud.vision_v1.types.ProductSet(Required) The ProductSet resource which replaces the one on the server. If a dict is provided, it must be of the same form as the protobuf message ProductSet.
locationstr(Optional) The region where the ProductSet is located. Valid regions (as of 2019-02-05) are: us-east1, us-west1, europe-west1, asia-east1
product_set_idstr(Optional) The resource id of this ProductSet.
project_idstr(Optional) The project in which the ProductSet should be created. If set to None or missing, the default project_id from the Google Cloud connection is used.
update_maskdict or google.cloud.vision_v1.types.FieldMask(Optional) The FieldMask that specifies which fields to update. If update_mask isn’t specified, all mutable fields are to be updated. Valid mask path is display_name. If a dict is provided, it must be of the same form as the protobuf message FieldMask.
retrygoogle.api_core.retry.Retry(Optional) A retry object used to retry requests. If None is specified, requests will not be retried.
timeoutfloat(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.
metadatasequence[tuple[str, str]](Optional) Additional metadata that is provided to the method.
gcp_conn_idstr(Optional) The connection ID used to connect to Google Cloud.
impersonation_chainUnion[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 (templated).

Documentation

Makes changes to a ProductSet resource. Only display_name can be updated currently.

Note

To locate the ProductSet resource, its name in the form projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID is necessary.

You can provide the name directly as an attribute of the product_set object. However, you can leave it blank and provide location and product_set_id instead (and optionally project_id - if not present, the connection default will be used) and the name will be created by the operator itself.

This mechanism exists for your convenience, to allow leaving the project_id empty and having Airflow use the connection default project_id.

See also

For more information on how to use this operator, take a look at the guide: CloudVisionUpdateProductSetOperator

Was this page helpful?