google_api_vision v0.21.0 GoogleApi.Vision.V1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.
Run asynchronous image detection and annotation for a list of generic
files, such as PDF files, which may contain multiple pages and multiple
images per page. Progress and results can be retrieved through the
google.longrunning.Operations
interface.
Operation.metadata
contains OperationMetadata
(metadata).
Operation.response
contains AsyncBatchAnnotateFilesResponse
(results).
Run image detection and annotation for a batch of images.
Run asynchronous image detection and annotation for a list of images.
Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.
Run asynchronous image detection and annotation for a list of generic
files, such as PDF files, which may contain multiple pages and multiple
images per page. Progress and results can be retrieved through the
google.longrunning.Operations
interface.
Operation.metadata
contains OperationMetadata
(metadata).
Operation.response
contains AsyncBatchAnnotateFilesResponse
(results).
Run image detection and annotation for a batch of images.
Run asynchronous image detection and annotation for a list of images.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Adds a Product to the specified ProductSet. If the Product is already present, no change is made.
Creates and returns a new ProductSet resource.
Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.
Gets information associated with a ProductSet.
Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
Lists ProductSets in an unspecified order.
Makes changes to a ProductSet resource. Only display_name can be updated currently.
Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty.
Removes a Product from the specified ProductSet.
Creates and returns a new product resource.
Permanently deletes a product and its reference images.
Gets information associated with a Product.
Lists products in an unspecified order.
Makes changes to a Product resource.
Only the display_name
, description
, and labels
fields can be updated
right now.
Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
Creates and returns a new ReferenceImage resource.
Permanently deletes a reference image.
Gets information associated with a ReferenceImage.
Lists reference images.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Link to this section Functions
vision_projects_files_annotate(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_files_annotate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.BatchAnnotateFilesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Optional. Target project and location to make a call.Format:
projects/{project-id}/locations/{location-id}
.If no parent is specified, a region will be chosen automatically.
Supported location-ids:
`us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union.
Example:
projects/project-A/locations/eu
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.BatchAnnotateFilesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.BatchAnnotateFilesResponse{}}
on success{:error, info}
on failure
vision_projects_files_async_batch_annotate(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_files_async_batch_annotate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Run asynchronous image detection and annotation for a list of generic
files, such as PDF files, which may contain multiple pages and multiple
images per page. Progress and results can be retrieved through the
google.longrunning.Operations
interface.
Operation.metadata
contains OperationMetadata
(metadata).
Operation.response
contains AsyncBatchAnnotateFilesResponse
(results).
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Optional. Target project and location to make a call.Format:
projects/{project-id}/locations/{location-id}
.If no parent is specified, a region will be chosen automatically.
Supported location-ids:
`us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union.
Example:
projects/project-A/locations/eu
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.AsyncBatchAnnotateFilesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Operation{}}
on success{:error, info}
on failure
vision_projects_images_annotate(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_images_annotate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.BatchAnnotateImagesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Run image detection and annotation for a batch of images.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Optional. Target project and location to make a call.Format:
projects/{project-id}/locations/{location-id}
.If no parent is specified, a region will be chosen automatically.
Supported location-ids:
`us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union.
Example:
projects/project-A/locations/eu
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.BatchAnnotateImagesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.BatchAnnotateImagesResponse{}}
on success{:error, info}
on failure
vision_projects_images_async_batch_annotate(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_images_async_batch_annotate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Run asynchronous image detection and annotation for a list of images.
Progress and results can be retrieved through the
google.longrunning.Operations
interface.
Operation.metadata
contains OperationMetadata
(metadata).
Operation.response
contains AsyncBatchAnnotateImagesResponse
(results).
This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Optional. Target project and location to make a call.Format:
projects/{project-id}/locations/{location-id}
.If no parent is specified, a region will be chosen automatically.
Supported location-ids:
`us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union.
Example:
projects/project-A/locations/eu
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.AsyncBatchAnnotateImagesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Operation{}}
on success{:error, info}
on failure
vision_projects_locations_files_annotate(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_files_annotate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.BatchAnnotateFilesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Optional. Target project and location to make a call.Format:
projects/{project-id}/locations/{location-id}
.If no parent is specified, a region will be chosen automatically.
Supported location-ids:
`us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union.
Example:
projects/project-A/locations/eu
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.BatchAnnotateFilesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.BatchAnnotateFilesResponse{}}
on success{:error, info}
on failure
vision_projects_locations_files_async_batch_annotate(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_files_async_batch_annotate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Run asynchronous image detection and annotation for a list of generic
files, such as PDF files, which may contain multiple pages and multiple
images per page. Progress and results can be retrieved through the
google.longrunning.Operations
interface.
Operation.metadata
contains OperationMetadata
(metadata).
Operation.response
contains AsyncBatchAnnotateFilesResponse
(results).
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Optional. Target project and location to make a call.Format:
projects/{project-id}/locations/{location-id}
.If no parent is specified, a region will be chosen automatically.
Supported location-ids:
`us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union.
Example:
projects/project-A/locations/eu
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.AsyncBatchAnnotateFilesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Operation{}}
on success{:error, info}
on failure
vision_projects_locations_images_annotate(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_images_annotate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.BatchAnnotateImagesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Run image detection and annotation for a batch of images.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Optional. Target project and location to make a call.Format:
projects/{project-id}/locations/{location-id}
.If no parent is specified, a region will be chosen automatically.
Supported location-ids:
`us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union.
Example:
projects/project-A/locations/eu
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.BatchAnnotateImagesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.BatchAnnotateImagesResponse{}}
on success{:error, info}
on failure
vision_projects_locations_images_async_batch_annotate(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_images_async_batch_annotate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Run asynchronous image detection and annotation for a list of images.
Progress and results can be retrieved through the
google.longrunning.Operations
interface.
Operation.metadata
contains OperationMetadata
(metadata).
Operation.response
contains AsyncBatchAnnotateImagesResponse
(results).
This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Optional. Target project and location to make a call.Format:
projects/{project-id}/locations/{location-id}
.If no parent is specified, a region will be chosen automatically.
Supported location-ids:
`us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union.
Example:
projects/project-A/locations/eu
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.AsyncBatchAnnotateImagesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Operation{}}
on success{:error, info}
on failure
vision_projects_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - The name of the operation resource.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Operation{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_add_product(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_add_product( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Adds a Product to the specified ProductSet. If the Product is already present, no change is made.
One Product can be added to at most 100 ProductSets.
Possible errors:
- Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The resource name for the ProductSet to modify.Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.AddProductToProductSetRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Empty{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ProductSet.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates and returns a new ProductSet resource.
Possible errors:
- Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The project in which the ProductSet should be created.Format is
projects/PROJECT_ID/locations/LOC_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:productSetId
(type:String.t
) - A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character/
.:body
(type:GoogleApi.Vision.V1.Model.ProductSet.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ProductSet{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud Storage.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Resource name of the ProductSet to delete.Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Empty{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ProductSet.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets information associated with a ProductSet.
Possible errors:
- Returns NOT_FOUND if the ProductSet does not exist.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Resource name of the ProductSet to get.Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ProductSet{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_import(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_import( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
The google.longrunning.Operation API can be used to keep track of the
progress and results of the request.
Operation.metadata
contains BatchOperationMetadata
. (progress)
Operation.response
contains ImportProductSetsResponse
. (results)
The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see ImportProductSetsGcsSource.csv_file_uri.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The project in which the ProductSets should be imported.Format is
projects/PROJECT_ID/locations/LOC_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.ImportProductSetsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Operation{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ListProductSetsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists ProductSets in an unspecified order.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The project from which ProductSets should be listed.Format is
projects/PROJECT_ID/locations/LOC_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of items to return. Default 10, maximum 100.:pageToken
(type:String.t
) - The next_page_token returned from a previous List request, if any.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ListProductSetsResponse{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_patch(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ProductSet.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Makes changes to a ProductSet resource. Only display_name can be updated currently.
Possible errors:
- Returns NOT_FOUND if the ProductSet does not exist.
- Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - The resource name of the ProductSet.Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
.This field is ignored when creating a ProductSet.
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path isdisplay_name
.:body
(type:GoogleApi.Vision.V1.Model.ProductSet.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ProductSet{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_products_list(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_products_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ListProductsInProductSetResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The ProductSet resource for which to retrieve Products.Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of items to return. Default 10, maximum 100.:pageToken
(type:String.t
) - The next_page_token returned from a previous List request, if any.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ListProductsInProductSetResponse{}}
on success{:error, info}
on failure
vision_projects_locations_product_sets_remove_product(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_product_sets_remove_product( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Removes a Product from the specified ProductSet.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The resource name for the ProductSet to modify.Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.RemoveProductFromProductSetRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Empty{}}
on success{:error, info}
on failure
vision_projects_locations_products_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Product.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates and returns a new product resource.
Possible errors:
- Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters.
- Returns INVALID_ARGUMENT if description is longer than 4096 characters.
- Returns INVALID_ARGUMENT if product_category is missing or invalid.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The project in which the Product should be created.Format is
projects/PROJECT_ID/locations/LOC_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:productId
(type:String.t
) - A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character/
.:body
(type:GoogleApi.Vision.V1.Model.Product.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Product{}}
on success{:error, info}
on failure
vision_projects_locations_products_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Permanently deletes a product and its reference images.
Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Resource name of product to delete.Format is:
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Empty{}}
on success{:error, info}
on failure
vision_projects_locations_products_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Product.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets information associated with a Product.
Possible errors:
- Returns NOT_FOUND if the Product does not exist.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Resource name of the Product to get.Format is:
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Product{}}
on success{:error, info}
on failure
vision_projects_locations_products_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ListProductsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists products in an unspecified order.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The project OR ProductSet from which Products should be listed.Format:
projects/PROJECT_ID/locations/LOC_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of items to return. Default 10, maximum 100.:pageToken
(type:String.t
) - The next_page_token returned from a previous List request, if any.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ListProductsResponse{}}
on success{:error, info}
on failure
vision_projects_locations_products_patch(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Product.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Makes changes to a Product resource.
Only the display_name
, description
, and labels
fields can be updated
right now.
If labels are updated, the change will not be reflected in queries until the next index time.
Possible errors:
- Returns NOT_FOUND if the Product does not exist.
- Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters.
- Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters.
- Returns INVALID_ARGUMENT if product_category is present in update_mask.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - The resource name of the product.Format is:
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID
.This field is ignored when creating a product.
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths includeproduct_labels
,display_name
, anddescription
.:body
(type:GoogleApi.Vision.V1.Model.Product.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Product{}}
on success{:error, info}
on failure
vision_projects_locations_products_purge(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_purge( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted.
It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted.
It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion.
If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet.
The google.longrunning.Operation API can be used to keep track of the
progress and results of the request.
Operation.metadata
contains BatchOperationMetadata
. (progress)
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The project and location in which the Products should be deleted.Format is
projects/PROJECT_ID/locations/LOC_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.Vision.V1.Model.PurgeProductsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Operation{}}
on success{:error, info}
on failure
vision_projects_locations_products_reference_images_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_reference_images_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ReferenceImage.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates and returns a new ReferenceImage resource.
The bounding_poly
field is optional. If bounding_poly
is not specified,
the system will try to detect regions of interest in the image that are
compatible with the product_category on the parent product. If it is
specified, detection is ALWAYS skipped. The system converts polygons into
non-rotated rectangles.
Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP).
Possible errors:
- Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters.
- Returns INVALID_ARGUMENT if the product does not exist.
- Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected.
- Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Resource name of the product in which to create the reference image.Format is
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:referenceImageId
(type:String.t
) - A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character/
.:body
(type:GoogleApi.Vision.V1.Model.ReferenceImage.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ReferenceImage{}}
on success{:error, info}
on failure
vision_projects_locations_products_reference_images_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_reference_images_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Permanently deletes a reference image.
The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.
The actual image files are not deleted from Google Cloud Storage.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The resource name of the reference image to delete.Format is:
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Empty{}}
on success{:error, info}
on failure
vision_projects_locations_products_reference_images_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_reference_images_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ReferenceImage.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets information associated with a ReferenceImage.
Possible errors:
- Returns NOT_FOUND if the specified image does not exist.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The resource name of the ReferenceImage to get.Format is:
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ReferenceImage{}}
on success{:error, info}
on failure
vision_projects_locations_products_reference_images_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourcevision_projects_locations_products_reference_images_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.ListReferenceImagesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists reference images.
Possible errors:
- Returns NOT_FOUND if the parent product does not exist.
- Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. Resource name of the product containing the reference images.Format is
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of items to return. Default 10, maximum 100.:pageToken
(type:String.t
) - A token identifying a page of results to be returned. This is the value ofnextPageToken
returned in a previous reference image list request.Defaults to the first page if not specified.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.ListReferenceImagesResponse{}}
on success{:error, info}
on failure
vision_projects_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcevision_projects_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Vision.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
connection
(type:GoogleApi.Vision.V1.Connection.t
) - Connection to servername
(type:String.t
) - The name of the operation resource.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Vision.V1.Model.Operation{}}
on success{:error, info}
on failure