google-cloud-vision-v1 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -16,6 +16,48 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/vision/v1/product_search/client"
20
- require "google/cloud/vision/v1/product_search/operations"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/vision/v1/version"
24
+
21
25
  require "google/cloud/vision/v1/product_search/credentials"
26
+ require "google/cloud/vision/v1/product_search/paths"
27
+ require "google/cloud/vision/v1/product_search/operations"
28
+ require "google/cloud/vision/v1/product_search/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module Vision
33
+ module V1
34
+ ##
35
+ # Manages Products and ProductSets of reference images for use in product
36
+ # search. It uses the following resource model:
37
+ #
38
+ # - The API has a collection of {Google::Cloud::Vision::V1::ProductSet ProductSet} resources, named
39
+ # `projects/*/locations/*/productSets/*`, which acts as a way to put different
40
+ # products into groups to limit identification.
41
+ #
42
+ # In parallel,
43
+ #
44
+ # - The API has a collection of {Google::Cloud::Vision::V1::Product Product} resources, named
45
+ # `projects/*/locations/*/products/*`
46
+ #
47
+ # - Each {Google::Cloud::Vision::V1::Product Product} has a collection of {Google::Cloud::Vision::V1::ReferenceImage ReferenceImage} resources, named
48
+ # `projects/*/locations/*/products/*/referenceImages/*`
49
+ #
50
+ # To load this service and instantiate a client:
51
+ #
52
+ # require "google/cloud/vision/v1/product_search"
53
+ # client = Google::Cloud::Vision::V1::ProductSearch::Client.new
54
+ #
55
+ module ProductSearch
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+
62
+ helper_path = ::File.join __dir__, "product_search", "helpers.rb"
63
+ require "google/cloud/vision/v1/product_search/helpers" if ::File.file? helper_path
@@ -16,16 +16,8 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
- require "gapic/config"
21
- require "gapic/config/method"
22
-
23
19
  require "google/cloud/errors"
24
- require "google/cloud/vision/v1/version"
25
20
  require "google/cloud/vision/v1/product_search_service_pb"
26
- require "google/cloud/vision/v1/product_search/credentials"
27
- require "google/cloud/vision/v1/product_search/paths"
28
- require "google/cloud/vision/v1/product_search/operations"
29
21
 
30
22
  module Google
31
23
  module Cloud
@@ -329,22 +321,25 @@ module Google
329
321
  # 4096 characters.
330
322
  #
331
323
  # @overload create_product_set(request, options = nil)
332
- # @param request [Google::Cloud::Vision::V1::CreateProductSetRequest | Hash]
333
- # Creates and returns a new ProductSet resource.
334
- #
335
- # Possible errors:
324
+ # Pass arguments to `create_product_set` via a request object, either of type
325
+ # {Google::Cloud::Vision::V1::CreateProductSetRequest} or an equivalent Hash.
336
326
  #
337
- # * Returns INVALID_ARGUMENT if display_name is missing, or is longer than
338
- # 4096 characters.
327
+ # @param request [Google::Cloud::Vision::V1::CreateProductSetRequest, Hash]
328
+ # A request object representing the call parameters. Required. To specify no
329
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
339
330
  # @param options [Gapic::CallOptions, Hash]
340
331
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
341
332
  #
342
333
  # @overload create_product_set(parent: nil, product_set: nil, product_set_id: nil)
334
+ # Pass arguments to `create_product_set` via keyword arguments. Note that at
335
+ # least one keyword argument is required. To specify no parameters, or to keep all
336
+ # the default parameter values, pass an empty Hash as a request object (see above).
337
+ #
343
338
  # @param parent [String]
344
339
  # Required. The project in which the ProductSet should be created.
345
340
  #
346
341
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
347
- # @param product_set [Google::Cloud::Vision::V1::ProductSet | Hash]
342
+ # @param product_set [Google::Cloud::Vision::V1::ProductSet, Hash]
348
343
  # Required. The ProductSet to create.
349
344
  # @param product_set_id [String]
350
345
  # A user-supplied resource id for this ProductSet. If set, the server will
@@ -352,7 +347,6 @@ module Google
352
347
  # error is returned with code ALREADY_EXISTS. Must be at most 128 characters
353
348
  # long. It cannot contain the character `/`.
354
349
  #
355
- #
356
350
  # @yield [response, operation] Access the result along with the RPC operation
357
351
  # @yieldparam response [Google::Cloud::Vision::V1::ProductSet]
358
352
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -407,17 +401,20 @@ module Google
407
401
  # than 1.
408
402
  #
409
403
  # @overload list_product_sets(request, options = nil)
410
- # @param request [Google::Cloud::Vision::V1::ListProductSetsRequest | Hash]
411
- # Lists ProductSets in an unspecified order.
404
+ # Pass arguments to `list_product_sets` via a request object, either of type
405
+ # {Google::Cloud::Vision::V1::ListProductSetsRequest} or an equivalent Hash.
412
406
  #
413
- # Possible errors:
414
- #
415
- # * Returns INVALID_ARGUMENT if page_size is greater than 100, or less
416
- # than 1.
407
+ # @param request [Google::Cloud::Vision::V1::ListProductSetsRequest, Hash]
408
+ # A request object representing the call parameters. Required. To specify no
409
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
417
410
  # @param options [Gapic::CallOptions, Hash]
418
411
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
419
412
  #
420
413
  # @overload list_product_sets(parent: nil, page_size: nil, page_token: nil)
414
+ # Pass arguments to `list_product_sets` via keyword arguments. Note that at
415
+ # least one keyword argument is required. To specify no parameters, or to keep all
416
+ # the default parameter values, pass an empty Hash as a request object (see above).
417
+ #
421
418
  # @param parent [String]
422
419
  # Required. The project from which ProductSets should be listed.
423
420
  #
@@ -427,7 +424,6 @@ module Google
427
424
  # @param page_token [String]
428
425
  # The next_page_token returned from a previous List request, if any.
429
426
  #
430
- #
431
427
  # @yield [response, operation] Access the result along with the RPC operation
432
428
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Vision::V1::ProductSet>]
433
429
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -482,23 +478,26 @@ module Google
482
478
  # * Returns NOT_FOUND if the ProductSet does not exist.
483
479
  #
484
480
  # @overload get_product_set(request, options = nil)
485
- # @param request [Google::Cloud::Vision::V1::GetProductSetRequest | Hash]
486
- # Gets information associated with a ProductSet.
487
- #
488
- # Possible errors:
481
+ # Pass arguments to `get_product_set` via a request object, either of type
482
+ # {Google::Cloud::Vision::V1::GetProductSetRequest} or an equivalent Hash.
489
483
  #
490
- # * Returns NOT_FOUND if the ProductSet does not exist.
484
+ # @param request [Google::Cloud::Vision::V1::GetProductSetRequest, Hash]
485
+ # A request object representing the call parameters. Required. To specify no
486
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
491
487
  # @param options [Gapic::CallOptions, Hash]
492
488
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
493
489
  #
494
490
  # @overload get_product_set(name: nil)
491
+ # Pass arguments to `get_product_set` via keyword arguments. Note that at
492
+ # least one keyword argument is required. To specify no parameters, or to keep all
493
+ # the default parameter values, pass an empty Hash as a request object (see above).
494
+ #
495
495
  # @param name [String]
496
496
  # Required. Resource name of the ProductSet to get.
497
497
  #
498
498
  # Format is:
499
499
  # `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID`
500
500
  #
501
- #
502
501
  # @yield [response, operation] Access the result along with the RPC operation
503
502
  # @yieldparam response [Google::Cloud::Vision::V1::ProductSet]
504
503
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -555,28 +554,28 @@ module Google
555
554
  # missing from the request or longer than 4096 characters.
556
555
  #
557
556
  # @overload update_product_set(request, options = nil)
558
- # @param request [Google::Cloud::Vision::V1::UpdateProductSetRequest | Hash]
559
- # Makes changes to a ProductSet resource.
560
- # Only display_name can be updated currently.
557
+ # Pass arguments to `update_product_set` via a request object, either of type
558
+ # {Google::Cloud::Vision::V1::UpdateProductSetRequest} or an equivalent Hash.
561
559
  #
562
- # Possible errors:
563
- #
564
- # * Returns NOT_FOUND if the ProductSet does not exist.
565
- # * Returns INVALID_ARGUMENT if display_name is present in update_mask but
566
- # missing from the request or longer than 4096 characters.
560
+ # @param request [Google::Cloud::Vision::V1::UpdateProductSetRequest, Hash]
561
+ # A request object representing the call parameters. Required. To specify no
562
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
567
563
  # @param options [Gapic::CallOptions, Hash]
568
564
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
569
565
  #
570
566
  # @overload update_product_set(product_set: nil, update_mask: nil)
571
- # @param product_set [Google::Cloud::Vision::V1::ProductSet | Hash]
567
+ # Pass arguments to `update_product_set` via keyword arguments. Note that at
568
+ # least one keyword argument is required. To specify no parameters, or to keep all
569
+ # the default parameter values, pass an empty Hash as a request object (see above).
570
+ #
571
+ # @param product_set [Google::Cloud::Vision::V1::ProductSet, Hash]
572
572
  # Required. The ProductSet resource which replaces the one on the server.
573
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
573
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
574
574
  # The {Google::Protobuf::FieldMask FieldMask} that specifies which fields to
575
575
  # update.
576
576
  # If update_mask isn't specified, all mutable fields are to be updated.
577
577
  # Valid mask path is `display_name`.
578
578
  #
579
- #
580
579
  # @yield [response, operation] Access the result along with the RPC operation
581
580
  # @yieldparam response [Google::Cloud::Vision::V1::ProductSet]
582
581
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -629,22 +628,26 @@ module Google
629
628
  # The actual image files are not deleted from Google Cloud Storage.
630
629
  #
631
630
  # @overload delete_product_set(request, options = nil)
632
- # @param request [Google::Cloud::Vision::V1::DeleteProductSetRequest | Hash]
633
- # Permanently deletes a ProductSet. Products and ReferenceImages in the
634
- # ProductSet are not deleted.
631
+ # Pass arguments to `delete_product_set` via a request object, either of type
632
+ # {Google::Cloud::Vision::V1::DeleteProductSetRequest} or an equivalent Hash.
635
633
  #
636
- # The actual image files are not deleted from Google Cloud Storage.
634
+ # @param request [Google::Cloud::Vision::V1::DeleteProductSetRequest, Hash]
635
+ # A request object representing the call parameters. Required. To specify no
636
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
637
637
  # @param options [Gapic::CallOptions, Hash]
638
638
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
639
639
  #
640
640
  # @overload delete_product_set(name: nil)
641
+ # Pass arguments to `delete_product_set` via keyword arguments. Note that at
642
+ # least one keyword argument is required. To specify no parameters, or to keep all
643
+ # the default parameter values, pass an empty Hash as a request object (see above).
644
+ #
641
645
  # @param name [String]
642
646
  # Required. Resource name of the ProductSet to delete.
643
647
  #
644
648
  # Format is:
645
649
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
646
650
  #
647
- #
648
651
  # @yield [response, operation] Access the result along with the RPC operation
649
652
  # @yieldparam response [Google::Protobuf::Empty]
650
653
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -701,25 +704,26 @@ module Google
701
704
  # * Returns INVALID_ARGUMENT if product_category is missing or invalid.
702
705
  #
703
706
  # @overload create_product(request, options = nil)
704
- # @param request [Google::Cloud::Vision::V1::CreateProductRequest | Hash]
705
- # Creates and returns a new product resource.
706
- #
707
- # Possible errors:
707
+ # Pass arguments to `create_product` via a request object, either of type
708
+ # {Google::Cloud::Vision::V1::CreateProductRequest} or an equivalent Hash.
708
709
  #
709
- # * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096
710
- # characters.
711
- # * Returns INVALID_ARGUMENT if description is longer than 4096 characters.
712
- # * Returns INVALID_ARGUMENT if product_category is missing or invalid.
710
+ # @param request [Google::Cloud::Vision::V1::CreateProductRequest, Hash]
711
+ # A request object representing the call parameters. Required. To specify no
712
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
713
713
  # @param options [Gapic::CallOptions, Hash]
714
714
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
715
715
  #
716
716
  # @overload create_product(parent: nil, product: nil, product_id: nil)
717
+ # Pass arguments to `create_product` via keyword arguments. Note that at
718
+ # least one keyword argument is required. To specify no parameters, or to keep all
719
+ # the default parameter values, pass an empty Hash as a request object (see above).
720
+ #
717
721
  # @param parent [String]
718
722
  # Required. The project in which the Product should be created.
719
723
  #
720
724
  # Format is
721
725
  # `projects/PROJECT_ID/locations/LOC_ID`.
722
- # @param product [Google::Cloud::Vision::V1::Product | Hash]
726
+ # @param product [Google::Cloud::Vision::V1::Product, Hash]
723
727
  # Required. The product to create.
724
728
  # @param product_id [String]
725
729
  # A user-supplied resource id for this Product. If set, the server will
@@ -727,7 +731,6 @@ module Google
727
731
  # error is returned with code ALREADY_EXISTS. Must be at most 128 characters
728
732
  # long. It cannot contain the character `/`.
729
733
  #
730
- #
731
734
  # @yield [response, operation] Access the result along with the RPC operation
732
735
  # @yieldparam response [Google::Cloud::Vision::V1::Product]
733
736
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -781,16 +784,20 @@ module Google
781
784
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
782
785
  #
783
786
  # @overload list_products(request, options = nil)
784
- # @param request [Google::Cloud::Vision::V1::ListProductsRequest | Hash]
785
- # Lists products in an unspecified order.
787
+ # Pass arguments to `list_products` via a request object, either of type
788
+ # {Google::Cloud::Vision::V1::ListProductsRequest} or an equivalent Hash.
786
789
  #
787
- # Possible errors:
788
- #
789
- # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
790
+ # @param request [Google::Cloud::Vision::V1::ListProductsRequest, Hash]
791
+ # A request object representing the call parameters. Required. To specify no
792
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
790
793
  # @param options [Gapic::CallOptions, Hash]
791
794
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
792
795
  #
793
796
  # @overload list_products(parent: nil, page_size: nil, page_token: nil)
797
+ # Pass arguments to `list_products` via keyword arguments. Note that at
798
+ # least one keyword argument is required. To specify no parameters, or to keep all
799
+ # the default parameter values, pass an empty Hash as a request object (see above).
800
+ #
794
801
  # @param parent [String]
795
802
  # Required. The project OR ProductSet from which Products should be listed.
796
803
  #
@@ -801,7 +808,6 @@ module Google
801
808
  # @param page_token [String]
802
809
  # The next_page_token returned from a previous List request, if any.
803
810
  #
804
- #
805
811
  # @yield [response, operation] Access the result along with the RPC operation
806
812
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Vision::V1::Product>]
807
813
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -856,23 +862,26 @@ module Google
856
862
  # * Returns NOT_FOUND if the Product does not exist.
857
863
  #
858
864
  # @overload get_product(request, options = nil)
859
- # @param request [Google::Cloud::Vision::V1::GetProductRequest | Hash]
860
- # Gets information associated with a Product.
861
- #
862
- # Possible errors:
865
+ # Pass arguments to `get_product` via a request object, either of type
866
+ # {Google::Cloud::Vision::V1::GetProductRequest} or an equivalent Hash.
863
867
  #
864
- # * Returns NOT_FOUND if the Product does not exist.
868
+ # @param request [Google::Cloud::Vision::V1::GetProductRequest, Hash]
869
+ # A request object representing the call parameters. Required. To specify no
870
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
865
871
  # @param options [Gapic::CallOptions, Hash]
866
872
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
867
873
  #
868
874
  # @overload get_product(name: nil)
875
+ # Pass arguments to `get_product` via keyword arguments. Note that at
876
+ # least one keyword argument is required. To specify no parameters, or to keep all
877
+ # the default parameter values, pass an empty Hash as a request object (see above).
878
+ #
869
879
  # @param name [String]
870
880
  # Required. Resource name of the Product to get.
871
881
  #
872
882
  # Format is:
873
883
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
874
884
  #
875
- #
876
885
  # @yield [response, operation] Access the result along with the RPC operation
877
886
  # @yieldparam response [Google::Cloud::Vision::V1::Product]
878
887
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -936,37 +945,30 @@ module Google
936
945
  # * Returns INVALID_ARGUMENT if product_category is present in update_mask.
937
946
  #
938
947
  # @overload update_product(request, options = nil)
939
- # @param request [Google::Cloud::Vision::V1::UpdateProductRequest | Hash]
940
- # Makes changes to a Product resource.
941
- # Only the `display_name`, `description`, and `labels` fields can be updated
942
- # right now.
943
- #
944
- # If labels are updated, the change will not be reflected in queries until
945
- # the next index time.
946
- #
947
- # Possible errors:
948
- #
949
- # * Returns NOT_FOUND if the Product does not exist.
950
- # * Returns INVALID_ARGUMENT if display_name is present in update_mask but is
951
- # missing from the request or longer than 4096 characters.
952
- # * Returns INVALID_ARGUMENT if description is present in update_mask but is
953
- # longer than 4096 characters.
954
- # * Returns INVALID_ARGUMENT if product_category is present in update_mask.
948
+ # Pass arguments to `update_product` via a request object, either of type
949
+ # {Google::Cloud::Vision::V1::UpdateProductRequest} or an equivalent Hash.
950
+ #
951
+ # @param request [Google::Cloud::Vision::V1::UpdateProductRequest, Hash]
952
+ # A request object representing the call parameters. Required. To specify no
953
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
955
954
  # @param options [Gapic::CallOptions, Hash]
956
955
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
957
956
  #
958
957
  # @overload update_product(product: nil, update_mask: nil)
959
- # @param product [Google::Cloud::Vision::V1::Product | Hash]
958
+ # Pass arguments to `update_product` via keyword arguments. Note that at
959
+ # least one keyword argument is required. To specify no parameters, or to keep all
960
+ # the default parameter values, pass an empty Hash as a request object (see above).
961
+ #
962
+ # @param product [Google::Cloud::Vision::V1::Product, Hash]
960
963
  # Required. The Product resource which replaces the one on the server.
961
964
  # product.name is immutable.
962
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
965
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
963
966
  # The {Google::Protobuf::FieldMask FieldMask} that specifies which fields
964
967
  # to update.
965
968
  # If update_mask isn't specified, all mutable fields are to be updated.
966
969
  # Valid mask paths include `product_labels`, `display_name`, and
967
970
  # `description`.
968
971
  #
969
- #
970
972
  # @yield [response, operation] Access the result along with the RPC operation
971
973
  # @yieldparam response [Google::Cloud::Vision::V1::Product]
972
974
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1020,23 +1022,26 @@ module Google
1020
1022
  # until all related caches are refreshed.
1021
1023
  #
1022
1024
  # @overload delete_product(request, options = nil)
1023
- # @param request [Google::Cloud::Vision::V1::DeleteProductRequest | Hash]
1024
- # Permanently deletes a product and its reference images.
1025
+ # Pass arguments to `delete_product` via a request object, either of type
1026
+ # {Google::Cloud::Vision::V1::DeleteProductRequest} or an equivalent Hash.
1025
1027
  #
1026
- # Metadata of the product and all its images will be deleted right away, but
1027
- # search queries against ProductSets containing the product may still work
1028
- # until all related caches are refreshed.
1028
+ # @param request [Google::Cloud::Vision::V1::DeleteProductRequest, Hash]
1029
+ # A request object representing the call parameters. Required. To specify no
1030
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1029
1031
  # @param options [Gapic::CallOptions, Hash]
1030
1032
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1031
1033
  #
1032
1034
  # @overload delete_product(name: nil)
1035
+ # Pass arguments to `delete_product` via keyword arguments. Note that at
1036
+ # least one keyword argument is required. To specify no parameters, or to keep all
1037
+ # the default parameter values, pass an empty Hash as a request object (see above).
1038
+ #
1033
1039
  # @param name [String]
1034
1040
  # Required. Resource name of product to delete.
1035
1041
  #
1036
1042
  # Format is:
1037
1043
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
1038
1044
  #
1039
- #
1040
1045
  # @yield [response, operation] Access the result along with the RPC operation
1041
1046
  # @yieldparam response [Google::Protobuf::Empty]
1042
1047
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1104,36 +1109,26 @@ module Google
1104
1109
  # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
1105
1110
  #
1106
1111
  # @overload create_reference_image(request, options = nil)
1107
- # @param request [Google::Cloud::Vision::V1::CreateReferenceImageRequest | Hash]
1108
- # Creates and returns a new ReferenceImage resource.
1109
- #
1110
- # The `bounding_poly` field is optional. If `bounding_poly` is not specified,
1111
- # the system will try to detect regions of interest in the image that are
1112
- # compatible with the product_category on the parent product. If it is
1113
- # specified, detection is ALWAYS skipped. The system converts polygons into
1114
- # non-rotated rectangles.
1115
- #
1116
- # Note that the pipeline will resize the image if the image resolution is too
1117
- # large to process (above 50MP).
1118
- #
1119
- # Possible errors:
1120
- #
1121
- # * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096
1122
- # characters.
1123
- # * Returns INVALID_ARGUMENT if the product does not exist.
1124
- # * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
1125
- # compatible with the parent product's product_category is detected.
1126
- # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
1112
+ # Pass arguments to `create_reference_image` via a request object, either of type
1113
+ # {Google::Cloud::Vision::V1::CreateReferenceImageRequest} or an equivalent Hash.
1114
+ #
1115
+ # @param request [Google::Cloud::Vision::V1::CreateReferenceImageRequest, Hash]
1116
+ # A request object representing the call parameters. Required. To specify no
1117
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1127
1118
  # @param options [Gapic::CallOptions, Hash]
1128
1119
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1129
1120
  #
1130
1121
  # @overload create_reference_image(parent: nil, reference_image: nil, reference_image_id: nil)
1122
+ # Pass arguments to `create_reference_image` via keyword arguments. Note that at
1123
+ # least one keyword argument is required. To specify no parameters, or to keep all
1124
+ # the default parameter values, pass an empty Hash as a request object (see above).
1125
+ #
1131
1126
  # @param parent [String]
1132
1127
  # Required. Resource name of the product in which to create the reference image.
1133
1128
  #
1134
1129
  # Format is
1135
1130
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
1136
- # @param reference_image [Google::Cloud::Vision::V1::ReferenceImage | Hash]
1131
+ # @param reference_image [Google::Cloud::Vision::V1::ReferenceImage, Hash]
1137
1132
  # Required. The reference image to create.
1138
1133
  # If an image ID is specified, it is ignored.
1139
1134
  # @param reference_image_id [String]
@@ -1142,7 +1137,6 @@ module Google
1142
1137
  # already in use, an error is returned with code ALREADY_EXISTS. Must be at
1143
1138
  # most 128 characters long. It cannot contain the character `/`.
1144
1139
  #
1145
- #
1146
1140
  # @yield [response, operation] Access the result along with the RPC operation
1147
1141
  # @yieldparam response [Google::Cloud::Vision::V1::ReferenceImage]
1148
1142
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1198,18 +1192,20 @@ module Google
1198
1192
  # The actual image files are not deleted from Google Cloud Storage.
1199
1193
  #
1200
1194
  # @overload delete_reference_image(request, options = nil)
1201
- # @param request [Google::Cloud::Vision::V1::DeleteReferenceImageRequest | Hash]
1202
- # Permanently deletes a reference image.
1203
- #
1204
- # The image metadata will be deleted right away, but search queries
1205
- # against ProductSets containing the image may still work until all related
1206
- # caches are refreshed.
1195
+ # Pass arguments to `delete_reference_image` via a request object, either of type
1196
+ # {Google::Cloud::Vision::V1::DeleteReferenceImageRequest} or an equivalent Hash.
1207
1197
  #
1208
- # The actual image files are not deleted from Google Cloud Storage.
1198
+ # @param request [Google::Cloud::Vision::V1::DeleteReferenceImageRequest, Hash]
1199
+ # A request object representing the call parameters. Required. To specify no
1200
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1209
1201
  # @param options [Gapic::CallOptions, Hash]
1210
1202
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1211
1203
  #
1212
1204
  # @overload delete_reference_image(name: nil)
1205
+ # Pass arguments to `delete_reference_image` via keyword arguments. Note that at
1206
+ # least one keyword argument is required. To specify no parameters, or to keep all
1207
+ # the default parameter values, pass an empty Hash as a request object (see above).
1208
+ #
1213
1209
  # @param name [String]
1214
1210
  # Required. The resource name of the reference image to delete.
1215
1211
  #
@@ -1217,7 +1213,6 @@ module Google
1217
1213
  #
1218
1214
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`
1219
1215
  #
1220
- #
1221
1216
  # @yield [response, operation] Access the result along with the RPC operation
1222
1217
  # @yieldparam response [Google::Protobuf::Empty]
1223
1218
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1273,18 +1268,20 @@ module Google
1273
1268
  # than 1.
1274
1269
  #
1275
1270
  # @overload list_reference_images(request, options = nil)
1276
- # @param request [Google::Cloud::Vision::V1::ListReferenceImagesRequest | Hash]
1277
- # Lists reference images.
1271
+ # Pass arguments to `list_reference_images` via a request object, either of type
1272
+ # {Google::Cloud::Vision::V1::ListReferenceImagesRequest} or an equivalent Hash.
1278
1273
  #
1279
- # Possible errors:
1280
- #
1281
- # * Returns NOT_FOUND if the parent product does not exist.
1282
- # * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
1283
- # than 1.
1274
+ # @param request [Google::Cloud::Vision::V1::ListReferenceImagesRequest, Hash]
1275
+ # A request object representing the call parameters. Required. To specify no
1276
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1284
1277
  # @param options [Gapic::CallOptions, Hash]
1285
1278
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1286
1279
  #
1287
1280
  # @overload list_reference_images(parent: nil, page_size: nil, page_token: nil)
1281
+ # Pass arguments to `list_reference_images` via keyword arguments. Note that at
1282
+ # least one keyword argument is required. To specify no parameters, or to keep all
1283
+ # the default parameter values, pass an empty Hash as a request object (see above).
1284
+ #
1288
1285
  # @param parent [String]
1289
1286
  # Required. Resource name of the product containing the reference images.
1290
1287
  #
@@ -1298,7 +1295,6 @@ module Google
1298
1295
  #
1299
1296
  # Defaults to the first page if not specified.
1300
1297
  #
1301
- #
1302
1298
  # @yield [response, operation] Access the result along with the RPC operation
1303
1299
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Vision::V1::ReferenceImage>]
1304
1300
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1353,16 +1349,20 @@ module Google
1353
1349
  # * Returns NOT_FOUND if the specified image does not exist.
1354
1350
  #
1355
1351
  # @overload get_reference_image(request, options = nil)
1356
- # @param request [Google::Cloud::Vision::V1::GetReferenceImageRequest | Hash]
1357
- # Gets information associated with a ReferenceImage.
1358
- #
1359
- # Possible errors:
1352
+ # Pass arguments to `get_reference_image` via a request object, either of type
1353
+ # {Google::Cloud::Vision::V1::GetReferenceImageRequest} or an equivalent Hash.
1360
1354
  #
1361
- # * Returns NOT_FOUND if the specified image does not exist.
1355
+ # @param request [Google::Cloud::Vision::V1::GetReferenceImageRequest, Hash]
1356
+ # A request object representing the call parameters. Required. To specify no
1357
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1362
1358
  # @param options [Gapic::CallOptions, Hash]
1363
1359
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1364
1360
  #
1365
1361
  # @overload get_reference_image(name: nil)
1362
+ # Pass arguments to `get_reference_image` via keyword arguments. Note that at
1363
+ # least one keyword argument is required. To specify no parameters, or to keep all
1364
+ # the default parameter values, pass an empty Hash as a request object (see above).
1365
+ #
1366
1366
  # @param name [String]
1367
1367
  # Required. The resource name of the ReferenceImage to get.
1368
1368
  #
@@ -1370,7 +1370,6 @@ module Google
1370
1370
  #
1371
1371
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
1372
1372
  #
1373
- #
1374
1373
  # @yield [response, operation] Access the result along with the RPC operation
1375
1374
  # @yieldparam response [Google::Cloud::Vision::V1::ReferenceImage]
1376
1375
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1427,19 +1426,20 @@ module Google
1427
1426
  # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
1428
1427
  #
1429
1428
  # @overload add_product_to_product_set(request, options = nil)
1430
- # @param request [Google::Cloud::Vision::V1::AddProductToProductSetRequest | Hash]
1431
- # Adds a Product to the specified ProductSet. If the Product is already
1432
- # present, no change is made.
1433
- #
1434
- # One Product can be added to at most 100 ProductSets.
1435
- #
1436
- # Possible errors:
1429
+ # Pass arguments to `add_product_to_product_set` via a request object, either of type
1430
+ # {Google::Cloud::Vision::V1::AddProductToProductSetRequest} or an equivalent Hash.
1437
1431
  #
1438
- # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
1432
+ # @param request [Google::Cloud::Vision::V1::AddProductToProductSetRequest, Hash]
1433
+ # A request object representing the call parameters. Required. To specify no
1434
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1439
1435
  # @param options [Gapic::CallOptions, Hash]
1440
1436
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1441
1437
  #
1442
1438
  # @overload add_product_to_product_set(name: nil, product: nil)
1439
+ # Pass arguments to `add_product_to_product_set` via keyword arguments. Note that at
1440
+ # least one keyword argument is required. To specify no parameters, or to keep all
1441
+ # the default parameter values, pass an empty Hash as a request object (see above).
1442
+ #
1443
1443
  # @param name [String]
1444
1444
  # Required. The resource name for the ProductSet to modify.
1445
1445
  #
@@ -1451,7 +1451,6 @@ module Google
1451
1451
  # Format is:
1452
1452
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
1453
1453
  #
1454
- #
1455
1454
  # @yield [response, operation] Access the result along with the RPC operation
1456
1455
  # @yieldparam response [Google::Protobuf::Empty]
1457
1456
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1501,12 +1500,20 @@ module Google
1501
1500
  # Removes a Product from the specified ProductSet.
1502
1501
  #
1503
1502
  # @overload remove_product_from_product_set(request, options = nil)
1504
- # @param request [Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest | Hash]
1505
- # Removes a Product from the specified ProductSet.
1503
+ # Pass arguments to `remove_product_from_product_set` via a request object, either of type
1504
+ # {Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest} or an equivalent Hash.
1505
+ #
1506
+ # @param request [Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest, Hash]
1507
+ # A request object representing the call parameters. Required. To specify no
1508
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1506
1509
  # @param options [Gapic::CallOptions, Hash]
1507
1510
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1508
1511
  #
1509
1512
  # @overload remove_product_from_product_set(name: nil, product: nil)
1513
+ # Pass arguments to `remove_product_from_product_set` via keyword arguments. Note that at
1514
+ # least one keyword argument is required. To specify no parameters, or to keep all
1515
+ # the default parameter values, pass an empty Hash as a request object (see above).
1516
+ #
1510
1517
  # @param name [String]
1511
1518
  # Required. The resource name for the ProductSet to modify.
1512
1519
  #
@@ -1518,7 +1525,6 @@ module Google
1518
1525
  # Format is:
1519
1526
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
1520
1527
  #
1521
- #
1522
1528
  # @yield [response, operation] Access the result along with the RPC operation
1523
1529
  # @yieldparam response [Google::Protobuf::Empty]
1524
1530
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1574,18 +1580,20 @@ module Google
1574
1580
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
1575
1581
  #
1576
1582
  # @overload list_products_in_product_set(request, options = nil)
1577
- # @param request [Google::Cloud::Vision::V1::ListProductsInProductSetRequest | Hash]
1578
- # Lists the Products in a ProductSet, in an unspecified order. If the
1579
- # ProductSet does not exist, the products field of the response will be
1580
- # empty.
1583
+ # Pass arguments to `list_products_in_product_set` via a request object, either of type
1584
+ # {Google::Cloud::Vision::V1::ListProductsInProductSetRequest} or an equivalent Hash.
1581
1585
  #
1582
- # Possible errors:
1583
- #
1584
- # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
1586
+ # @param request [Google::Cloud::Vision::V1::ListProductsInProductSetRequest, Hash]
1587
+ # A request object representing the call parameters. Required. To specify no
1588
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1585
1589
  # @param options [Gapic::CallOptions, Hash]
1586
1590
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1587
1591
  #
1588
1592
  # @overload list_products_in_product_set(name: nil, page_size: nil, page_token: nil)
1593
+ # Pass arguments to `list_products_in_product_set` via keyword arguments. Note that at
1594
+ # least one keyword argument is required. To specify no parameters, or to keep all
1595
+ # the default parameter values, pass an empty Hash as a request object (see above).
1596
+ #
1589
1597
  # @param name [String]
1590
1598
  # Required. The ProductSet resource for which to retrieve Products.
1591
1599
  #
@@ -1596,7 +1604,6 @@ module Google
1596
1604
  # @param page_token [String]
1597
1605
  # The next_page_token returned from a previous List request, if any.
1598
1606
  #
1599
- #
1600
1607
  # @yield [response, operation] Access the result along with the RPC operation
1601
1608
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Vision::V1::Product>]
1602
1609
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1657,30 +1664,27 @@ module Google
1657
1664
  # {Google::Cloud::Vision::V1::ImportProductSetsGcsSource#csv_file_uri ImportProductSetsGcsSource.csv_file_uri}.
1658
1665
  #
1659
1666
  # @overload import_product_sets(request, options = nil)
1660
- # @param request [Google::Cloud::Vision::V1::ImportProductSetsRequest | Hash]
1661
- # Asynchronous API that imports a list of reference images to specified
1662
- # product sets based on a list of image information.
1663
- #
1664
- # The {Google::Longrunning::Operation google.longrunning.Operation} API can be used to keep track of the
1665
- # progress and results of the request.
1666
- # `Operation.metadata` contains `BatchOperationMetadata`. (progress)
1667
- # `Operation.response` contains `ImportProductSetsResponse`. (results)
1668
- #
1669
- # The input source of this method is a csv file on Google Cloud Storage.
1670
- # For the format of the csv file please see
1671
- # {Google::Cloud::Vision::V1::ImportProductSetsGcsSource#csv_file_uri ImportProductSetsGcsSource.csv_file_uri}.
1667
+ # Pass arguments to `import_product_sets` via a request object, either of type
1668
+ # {Google::Cloud::Vision::V1::ImportProductSetsRequest} or an equivalent Hash.
1669
+ #
1670
+ # @param request [Google::Cloud::Vision::V1::ImportProductSetsRequest, Hash]
1671
+ # A request object representing the call parameters. Required. To specify no
1672
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1672
1673
  # @param options [Gapic::CallOptions, Hash]
1673
1674
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1674
1675
  #
1675
1676
  # @overload import_product_sets(parent: nil, input_config: nil)
1677
+ # Pass arguments to `import_product_sets` via keyword arguments. Note that at
1678
+ # least one keyword argument is required. To specify no parameters, or to keep all
1679
+ # the default parameter values, pass an empty Hash as a request object (see above).
1680
+ #
1676
1681
  # @param parent [String]
1677
1682
  # Required. The project in which the ProductSets should be imported.
1678
1683
  #
1679
1684
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
1680
- # @param input_config [Google::Cloud::Vision::V1::ImportProductSetsInputConfig | Hash]
1685
+ # @param input_config [Google::Cloud::Vision::V1::ImportProductSetsInputConfig, Hash]
1681
1686
  # Required. The input content for the list of requests.
1682
1687
  #
1683
- #
1684
1688
  # @yield [response, operation] Access the result along with the RPC operation
1685
1689
  # @yieldparam response [Gapic::Operation]
1686
1690
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1754,36 +1758,21 @@ module Google
1754
1758
  # `Operation.metadata` contains `BatchOperationMetadata`. (progress)
1755
1759
  #
1756
1760
  # @overload purge_products(request, options = nil)
1757
- # @param request [Google::Cloud::Vision::V1::PurgeProductsRequest | Hash]
1758
- # Asynchronous API to delete all Products in a ProductSet or all Products
1759
- # that are in no ProductSet.
1760
- #
1761
- # If a Product is a member of the specified ProductSet in addition to other
1762
- # ProductSets, the Product will still be deleted.
1763
- #
1764
- # It is recommended to not delete the specified ProductSet until after this
1765
- # operation has completed. It is also recommended to not add any of the
1766
- # Products involved in the batch delete to a new ProductSet while this
1767
- # operation is running because those Products may still end up deleted.
1768
- #
1769
- # It's not possible to undo the PurgeProducts operation. Therefore, it is
1770
- # recommended to keep the csv files used in ImportProductSets (if that was
1771
- # how you originally built the Product Set) before starting PurgeProducts, in
1772
- # case you need to re-import the data after deletion.
1773
- #
1774
- # If the plan is to purge all of the Products from a ProductSet and then
1775
- # re-use the empty ProductSet to re-import new Products into the empty
1776
- # ProductSet, you must wait until the PurgeProducts operation has finished
1777
- # for that ProductSet.
1778
- #
1779
- # The {Google::Longrunning::Operation google.longrunning.Operation} API can be used to keep track of the
1780
- # progress and results of the request.
1781
- # `Operation.metadata` contains `BatchOperationMetadata`. (progress)
1761
+ # Pass arguments to `purge_products` via a request object, either of type
1762
+ # {Google::Cloud::Vision::V1::PurgeProductsRequest} or an equivalent Hash.
1763
+ #
1764
+ # @param request [Google::Cloud::Vision::V1::PurgeProductsRequest, Hash]
1765
+ # A request object representing the call parameters. Required. To specify no
1766
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1782
1767
  # @param options [Gapic::CallOptions, Hash]
1783
1768
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1784
1769
  #
1785
1770
  # @overload purge_products(product_set_purge_config: nil, delete_orphan_products: nil, parent: nil, force: nil)
1786
- # @param product_set_purge_config [Google::Cloud::Vision::V1::ProductSetPurgeConfig | Hash]
1771
+ # Pass arguments to `purge_products` via keyword arguments. Note that at
1772
+ # least one keyword argument is required. To specify no parameters, or to keep all
1773
+ # the default parameter values, pass an empty Hash as a request object (see above).
1774
+ #
1775
+ # @param product_set_purge_config [Google::Cloud::Vision::V1::ProductSetPurgeConfig, Hash]
1787
1776
  # Specify which ProductSet contains the Products to be deleted.
1788
1777
  # @param delete_orphan_products [Boolean]
1789
1778
  # If delete_orphan_products is true, all Products that are not in any
@@ -1796,7 +1785,6 @@ module Google
1796
1785
  # The default value is false. Override this value to true to actually perform
1797
1786
  # the purge.
1798
1787
  #
1799
- #
1800
1788
  # @yield [response, operation] Access the result along with the RPC operation
1801
1789
  # @yieldparam response [Gapic::Operation]
1802
1790
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -2122,13 +2110,3 @@ module Google
2122
2110
  end
2123
2111
  end
2124
2112
  end
2125
-
2126
- # rubocop:disable Lint/HandleExceptions
2127
-
2128
- # Once client is loaded, load helpers.rb if it exists.
2129
- begin
2130
- require "google/cloud/vision/v1/product_search/helpers"
2131
- rescue LoadError
2132
- end
2133
-
2134
- # rubocop:enable Lint/HandleExceptions