blob: c2a4e6f2ad0095b8bf6e8551eceeb9742f7268ad [file] [log] [blame]
// Copyright 2020 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by protoc-gen-go_gapic. DO NOT EDIT.
package vision
import (
gax ""
gtransport ""
visionpb ""
var newImageAnnotatorClientHook clientHook
// ImageAnnotatorCallOptions contains the retry settings for each method of ImageAnnotatorClient.
type ImageAnnotatorCallOptions struct {
BatchAnnotateImages []gax.CallOption
func defaultImageAnnotatorClientOptions() []option.ClientOption {
return []option.ClientOption{
func defaultImageAnnotatorCallOptions() *ImageAnnotatorCallOptions {
return &ImageAnnotatorCallOptions{
BatchAnnotateImages: []gax.CallOption{
gax.WithRetry(func() gax.Retryer {
return gax.OnCodes([]codes.Code{
}, gax.Backoff{
Initial: 100 * time.Millisecond,
Max: 60000 * time.Millisecond,
Multiplier: 1.30,
// ImageAnnotatorClient is a client for interacting with Cloud Vision API.
// Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
type ImageAnnotatorClient struct {
// Connection pool of gRPC connections to the service.
connPool gtransport.ConnPool
// flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE
disableDeadlines bool
// The gRPC API client.
imageAnnotatorClient visionpb.ImageAnnotatorClient
// The call options for this service.
CallOptions *ImageAnnotatorCallOptions
// The x-goog-* metadata to be sent with each request.
xGoogMetadata metadata.MD
// NewImageAnnotatorClient creates a new image annotator client.
// Service that performs Google Cloud Vision API detection tasks over client
// images, such as face, landmark, logo, label, and text detection. The
// ImageAnnotator service returns detected entities from the images.
func NewImageAnnotatorClient(ctx context.Context, opts ...option.ClientOption) (*ImageAnnotatorClient, error) {
clientOpts := defaultImageAnnotatorClientOptions()
if newImageAnnotatorClientHook != nil {
hookOpts, err := newImageAnnotatorClientHook(ctx, clientHookParams{})
if err != nil {
return nil, err
clientOpts = append(clientOpts, hookOpts...)
disableDeadlines, err := checkDisableDeadlines()
if err != nil {
return nil, err
connPool, err := gtransport.DialPool(ctx, append(clientOpts, opts...)...)
if err != nil {
return nil, err
c := &ImageAnnotatorClient{
connPool: connPool,
disableDeadlines: disableDeadlines,
CallOptions: defaultImageAnnotatorCallOptions(),
imageAnnotatorClient: visionpb.NewImageAnnotatorClient(connPool),
return c, nil
// Connection returns a connection to the API service.
// Deprecated.
func (c *ImageAnnotatorClient) Connection() *grpc.ClientConn {
return c.connPool.Conn()
// Close closes the connection to the API service. The user should invoke this when
// the client is no longer required.
func (c *ImageAnnotatorClient) Close() error {
return c.connPool.Close()
// setGoogleClientInfo sets the name and version of the application in
// the `x-goog-api-client` header passed on each request. Intended for
// use by Google-written clients.
func (c *ImageAnnotatorClient) setGoogleClientInfo(keyval ...string) {
kv := append([]string{"gl-go", versionGo()}, keyval...)
kv = append(kv, "gapic", versionClient, "gax", gax.Version, "grpc", grpc.Version)
c.xGoogMetadata = metadata.Pairs("x-goog-api-client", gax.XGoogHeader(kv...))
// BatchAnnotateImages run image detection and annotation for a batch of images.
func (c *ImageAnnotatorClient) BatchAnnotateImages(ctx context.Context, req *visionpb.BatchAnnotateImagesRequest, opts ...gax.CallOption) (*visionpb.BatchAnnotateImagesResponse, error) {
if _, ok := ctx.Deadline(); !ok && !c.disableDeadlines {
cctx, cancel := context.WithTimeout(ctx, 600000*time.Millisecond)
defer cancel()
ctx = cctx
ctx = insertMetadata(ctx, c.xGoogMetadata)
opts = append(c.CallOptions.BatchAnnotateImages[0:len(c.CallOptions.BatchAnnotateImages):len(c.CallOptions.BatchAnnotateImages)], opts...)
var resp *visionpb.BatchAnnotateImagesResponse
err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
var err error
resp, err = c.imageAnnotatorClient.BatchAnnotateImages(ctx, req, settings.GRPC...)
return err
}, opts...)
if err != nil {
return nil, err
return resp, nil