discoveryengine/apiv1beta/rank_client.go - gocloud - Git at Google

 // Copyright 2024 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
 //
 //     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // 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 discoveryengine

 import (
 	"bytes"
 	"context"
 	"fmt"
 	"io"
 	"math"
 	"net/http"
 	"net/url"
 	"time"

 	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb"
 	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
 	gax "github.com/googleapis/gax-go/v2"
 	"google.golang.org/api/googleapi"
 	"google.golang.org/api/iterator"
 	"google.golang.org/api/option"
 	"google.golang.org/api/option/internaloption"
 	gtransport "google.golang.org/api/transport/grpc"
 	httptransport "google.golang.org/api/transport/http"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/protobuf/encoding/protojson"
 	"google.golang.org/protobuf/proto"
 )

 var newRankClientHook clientHook

 // RankCallOptions contains the retry settings for each method of RankClient.
 type RankCallOptions struct {
 	Rank           []gax.CallOption
 	GetOperation   []gax.CallOption
 	ListOperations []gax.CallOption
 }

 func defaultRankGRPCClientOptions() []option.ClientOption {
 	return []option.ClientOption{
 		internaloption.WithDefaultEndpoint("discoveryengine.googleapis.com:443"),
 		internaloption.WithDefaultEndpointTemplate("discoveryengine.UNIVERSE_DOMAIN:443"),
 		internaloption.WithDefaultMTLSEndpoint("discoveryengine.mtls.googleapis.com:443"),
 		internaloption.WithDefaultUniverseDomain("googleapis.com"),
 		internaloption.WithDefaultAudience("https://discoveryengine.googleapis.com/"),
 		internaloption.WithDefaultScopes(DefaultAuthScopes()...),
 		internaloption.EnableJwtWithScope(),
 		option.WithGRPCDialOption(grpc.WithDefaultCallOptions(
 			grpc.MaxCallRecvMsgSize(math.MaxInt32))),
 	}
 }

 func defaultRankCallOptions() *RankCallOptions {
 	return &RankCallOptions{
 		Rank: []gax.CallOption{
 			gax.WithTimeout(30000 * time.Millisecond),
 			gax.WithRetry(func() gax.Retryer {
 				return gax.OnCodes([]codes.Code{
 					codes.Unavailable,
 				}, gax.Backoff{
 					Initial:    1000 * time.Millisecond,
 					Max:        10000 * time.Millisecond,
 					Multiplier: 1.30,
 				})
 			}),
 		},
 		GetOperation: []gax.CallOption{
 			gax.WithTimeout(30000 * time.Millisecond),
 			gax.WithRetry(func() gax.Retryer {
 				return gax.OnCodes([]codes.Code{
 					codes.Unavailable,
 				}, gax.Backoff{
 					Initial:    1000 * time.Millisecond,
 					Max:        10000 * time.Millisecond,
 					Multiplier: 1.30,
 				})
 			}),
 		},
 		ListOperations: []gax.CallOption{
 			gax.WithTimeout(300000 * time.Millisecond),
 			gax.WithRetry(func() gax.Retryer {
 				return gax.OnCodes([]codes.Code{
 					codes.Unavailable,
 				}, gax.Backoff{
 					Initial:    1000 * time.Millisecond,
 					Max:        30000 * time.Millisecond,
 					Multiplier: 1.30,
 				})
 			}),
 		},
 	}
 }

 func defaultRankRESTCallOptions() *RankCallOptions {
 	return &RankCallOptions{
 		Rank: []gax.CallOption{
 			gax.WithTimeout(30000 * time.Millisecond),
 			gax.WithRetry(func() gax.Retryer {
 				return gax.OnHTTPCodes(gax.Backoff{
 					Initial:    1000 * time.Millisecond,
 					Max:        10000 * time.Millisecond,
 					Multiplier: 1.30,
 				},
 					http.StatusServiceUnavailable)
 			}),
 		},
 		GetOperation: []gax.CallOption{
 			gax.WithTimeout(30000 * time.Millisecond),
 			gax.WithRetry(func() gax.Retryer {
 				return gax.OnHTTPCodes(gax.Backoff{
 					Initial:    1000 * time.Millisecond,
 					Max:        10000 * time.Millisecond,
 					Multiplier: 1.30,
 				},
 					http.StatusServiceUnavailable)
 			}),
 		},
 		ListOperations: []gax.CallOption{
 			gax.WithTimeout(300000 * time.Millisecond),
 			gax.WithRetry(func() gax.Retryer {
 				return gax.OnHTTPCodes(gax.Backoff{
 					Initial:    1000 * time.Millisecond,
 					Max:        30000 * time.Millisecond,
 					Multiplier: 1.30,
 				},
 					http.StatusServiceUnavailable)
 			}),
 		},
 	}
 }

 // internalRankClient is an interface that defines the methods available from Discovery Engine API.
 type internalRankClient interface {
 	Close() error
 	setGoogleClientInfo(...string)
 	Connection() *grpc.ClientConn
 	Rank(context.Context, *discoveryenginepb.RankRequest, ...gax.CallOption) (*discoveryenginepb.RankResponse, error)
 	GetOperation(context.Context, *longrunningpb.GetOperationRequest, ...gax.CallOption) (*longrunningpb.Operation, error)
 	ListOperations(context.Context, *longrunningpb.ListOperationsRequest, ...gax.CallOption) *OperationIterator
 }

 // RankClient is a client for interacting with Discovery Engine API.
 // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
 //
 // Service for ranking text records.
 type RankClient struct {
 	// The internal transport-dependent client.
 	internalClient internalRankClient

 	// The call options for this service.
 	CallOptions *RankCallOptions
 }

 // Wrapper methods routed to the internal client.

 // Close closes the connection to the API service. The user should invoke this when
 // the client is no longer required.
 func (c *RankClient) Close() error {
 	return c.internalClient.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 *RankClient) setGoogleClientInfo(keyval ...string) {
 	c.internalClient.setGoogleClientInfo(keyval...)
 }

 // Connection returns a connection to the API service.
 //
 // Deprecated: Connections are now pooled so this method does not always
 // return the same resource.
 func (c *RankClient) Connection() *grpc.ClientConn {
 	return c.internalClient.Connection()
 }

 // Rank ranks a list of text records based on the given input query.
 func (c *RankClient) Rank(ctx context.Context, req *discoveryenginepb.RankRequest, opts ...gax.CallOption) (*discoveryenginepb.RankResponse, error) {
 	return c.internalClient.Rank(ctx, req, opts...)
 }

 // GetOperation is a utility method from google.longrunning.Operations.
 func (c *RankClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) {
 	return c.internalClient.GetOperation(ctx, req, opts...)
 }

 // ListOperations is a utility method from google.longrunning.Operations.
 func (c *RankClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator {
 	return c.internalClient.ListOperations(ctx, req, opts...)
 }

 // rankGRPCClient is a client for interacting with Discovery Engine API over gRPC transport.
 //
 // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
 type rankGRPCClient struct {
 	// Connection pool of gRPC connections to the service.
 	connPool gtransport.ConnPool

 	// Points back to the CallOptions field of the containing RankClient
 	CallOptions **RankCallOptions

 	// The gRPC API client.
 	rankClient discoveryenginepb.RankServiceClient

 	operationsClient longrunningpb.OperationsClient

 	// The x-goog-* metadata to be sent with each request.
 	xGoogHeaders []string
 }

 // NewRankClient creates a new rank service client based on gRPC.
 // The returned client must be Closed when it is done being used to clean up its underlying connections.
 //
 // Service for ranking text records.
 func NewRankClient(ctx context.Context, opts ...option.ClientOption) (*RankClient, error) {
 	clientOpts := defaultRankGRPCClientOptions()
 	if newRankClientHook != nil {
 		hookOpts, err := newRankClientHook(ctx, clientHookParams{})
 		if err != nil {
 			return nil, err
 		}
 		clientOpts = append(clientOpts, hookOpts...)
 	}

 	connPool, err := gtransport.DialPool(ctx, append(clientOpts, opts...)...)
 	if err != nil {
 		return nil, err
 	}
 	client := RankClient{CallOptions: defaultRankCallOptions()}

 	c := &rankGRPCClient{
 		connPool:         connPool,
 		rankClient:       discoveryenginepb.NewRankServiceClient(connPool),
 		CallOptions:      &client.CallOptions,
 		operationsClient: longrunningpb.NewOperationsClient(connPool),
 	}
 	c.setGoogleClientInfo()

 	client.internalClient = c

 	return &client, nil
 }

 // Connection returns a connection to the API service.
 //
 // Deprecated: Connections are now pooled so this method does not always
 // return the same resource.
 func (c *rankGRPCClient) Connection() *grpc.ClientConn {
 	return c.connPool.Conn()
 }

 // 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 *rankGRPCClient) setGoogleClientInfo(keyval ...string) {
 	kv := append([]string{"gl-go", gax.GoVersion}, keyval...)
 	kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "grpc", grpc.Version)
 	c.xGoogHeaders = []string{"x-goog-api-client", gax.XGoogHeader(kv...)}
 }

 // Close closes the connection to the API service. The user should invoke this when
 // the client is no longer required.
 func (c *rankGRPCClient) Close() error {
 	return c.connPool.Close()
 }

 // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
 type rankRESTClient struct {
 	// The http endpoint to connect to.
 	endpoint string

 	// The http client.
 	httpClient *http.Client

 	// The x-goog-* headers to be sent with each request.
 	xGoogHeaders []string

 	// Points back to the CallOptions field of the containing RankClient
 	CallOptions **RankCallOptions
 }

 // NewRankRESTClient creates a new rank service rest client.
 //
 // Service for ranking text records.
 func NewRankRESTClient(ctx context.Context, opts ...option.ClientOption) (*RankClient, error) {
 	clientOpts := append(defaultRankRESTClientOptions(), opts...)
 	httpClient, endpoint, err := httptransport.NewClient(ctx, clientOpts...)
 	if err != nil {
 		return nil, err
 	}

 	callOpts := defaultRankRESTCallOptions()
 	c := &rankRESTClient{
 		endpoint:    endpoint,
 		httpClient:  httpClient,
 		CallOptions: &callOpts,
 	}
 	c.setGoogleClientInfo()

 	return &RankClient{internalClient: c, CallOptions: callOpts}, nil
 }

 func defaultRankRESTClientOptions() []option.ClientOption {
 	return []option.ClientOption{
 		internaloption.WithDefaultEndpoint("https://discoveryengine.googleapis.com"),
 		internaloption.WithDefaultEndpointTemplate("https://discoveryengine.UNIVERSE_DOMAIN"),
 		internaloption.WithDefaultMTLSEndpoint("https://discoveryengine.mtls.googleapis.com"),
 		internaloption.WithDefaultUniverseDomain("googleapis.com"),
 		internaloption.WithDefaultAudience("https://discoveryengine.googleapis.com/"),
 		internaloption.WithDefaultScopes(DefaultAuthScopes()...),
 	}
 }

 // 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 *rankRESTClient) setGoogleClientInfo(keyval ...string) {
 	kv := append([]string{"gl-go", gax.GoVersion}, keyval...)
 	kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "rest", "UNKNOWN")
 	c.xGoogHeaders = []string{"x-goog-api-client", gax.XGoogHeader(kv...)}
 }

 // Close closes the connection to the API service. The user should invoke this when
 // the client is no longer required.
 func (c *rankRESTClient) Close() error {
 	// Replace httpClient with nil to force cleanup.
 	c.httpClient = nil
 	return nil
 }

 // Connection returns a connection to the API service.
 //
 // Deprecated: This method always returns nil.
 func (c *rankRESTClient) Connection() *grpc.ClientConn {
 	return nil
 }
 func (c *rankGRPCClient) Rank(ctx context.Context, req *discoveryenginepb.RankRequest, opts ...gax.CallOption) (*discoveryenginepb.RankResponse, error) {
 	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "ranking_config", url.QueryEscape(req.GetRankingConfig()))}

 	hds = append(c.xGoogHeaders, hds...)
 	ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...)
 	opts = append((*c.CallOptions).Rank[0:len((*c.CallOptions).Rank):len((*c.CallOptions).Rank)], opts...)
 	var resp *discoveryenginepb.RankResponse
 	err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
 		var err error
 		resp, err = c.rankClient.Rank(ctx, req, settings.GRPC...)
 		return err
 	}, opts...)
 	if err != nil {
 		return nil, err
 	}
 	return resp, nil
 }

 func (c *rankGRPCClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) {
 	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))}

 	hds = append(c.xGoogHeaders, hds...)
 	ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...)
 	opts = append((*c.CallOptions).GetOperation[0:len((*c.CallOptions).GetOperation):len((*c.CallOptions).GetOperation)], opts...)
 	var resp *longrunningpb.Operation
 	err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
 		var err error
 		resp, err = c.operationsClient.GetOperation(ctx, req, settings.GRPC...)
 		return err
 	}, opts...)
 	if err != nil {
 		return nil, err
 	}
 	return resp, nil
 }

 func (c *rankGRPCClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator {
 	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))}

 	hds = append(c.xGoogHeaders, hds...)
 	ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...)
 	opts = append((*c.CallOptions).ListOperations[0:len((*c.CallOptions).ListOperations):len((*c.CallOptions).ListOperations)], opts...)
 	it := &OperationIterator{}
 	req = proto.Clone(req).(*longrunningpb.ListOperationsRequest)
 	it.InternalFetch = func(pageSize int, pageToken string) ([]*longrunningpb.Operation, string, error) {
 		resp := &longrunningpb.ListOperationsResponse{}
 		if pageToken != "" {
 			req.PageToken = pageToken
 		}
 		if pageSize > math.MaxInt32 {
 			req.PageSize = math.MaxInt32
 		} else if pageSize != 0 {
 			req.PageSize = int32(pageSize)
 		}
 		err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
 			var err error
 			resp, err = c.operationsClient.ListOperations(ctx, req, settings.GRPC...)
 			return err
 		}, opts...)
 		if err != nil {
 			return nil, "", err
 		}

 		it.Response = resp
 		return resp.GetOperations(), resp.GetNextPageToken(), nil
 	}
 	fetch := func(pageSize int, pageToken string) (string, error) {
 		items, nextPageToken, err := it.InternalFetch(pageSize, pageToken)
 		if err != nil {
 			return "", err
 		}
 		it.items = append(it.items, items...)
 		return nextPageToken, nil
 	}

 	it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf)
 	it.pageInfo.MaxSize = int(req.GetPageSize())
 	it.pageInfo.Token = req.GetPageToken()

 	return it
 }

 // Rank ranks a list of text records based on the given input query.
 func (c *rankRESTClient) Rank(ctx context.Context, req *discoveryenginepb.RankRequest, opts ...gax.CallOption) (*discoveryenginepb.RankResponse, error) {
 	m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true}
 	jsonReq, err := m.Marshal(req)
 	if err != nil {
 		return nil, err
 	}

 	baseUrl, err := url.Parse(c.endpoint)
 	if err != nil {
 		return nil, err
 	}
 	baseUrl.Path += fmt.Sprintf("/v1beta/%v:rank", req.GetRankingConfig())

 	params := url.Values{}
 	params.Add("$alt", "json;enum-encoding=int")

 	baseUrl.RawQuery = params.Encode()

 	// Build HTTP headers from client and context metadata.
 	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "ranking_config", url.QueryEscape(req.GetRankingConfig()))}

 	hds = append(c.xGoogHeaders, hds...)
 	hds = append(hds, "Content-Type", "application/json")
 	headers := gax.BuildHeaders(ctx, hds...)
 	opts = append((*c.CallOptions).Rank[0:len((*c.CallOptions).Rank):len((*c.CallOptions).Rank)], opts...)
 	unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true}
 	resp := &discoveryenginepb.RankResponse{}
 	e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
 		if settings.Path != "" {
 			baseUrl.Path = settings.Path
 		}
 		httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq))
 		if err != nil {
 			return err
 		}
 		httpReq = httpReq.WithContext(ctx)
 		httpReq.Header = headers

 		httpRsp, err := c.httpClient.Do(httpReq)
 		if err != nil {
 			return err
 		}
 		defer httpRsp.Body.Close()

 		if err = googleapi.CheckResponse(httpRsp); err != nil {
 			return err
 		}

 		buf, err := io.ReadAll(httpRsp.Body)
 		if err != nil {
 			return err
 		}

 		if err := unm.Unmarshal(buf, resp); err != nil {
 			return err
 		}

 		return nil
 	}, opts...)
 	if e != nil {
 		return nil, e
 	}
 	return resp, nil
 }

 // GetOperation is a utility method from google.longrunning.Operations.
 func (c *rankRESTClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) {
 	baseUrl, err := url.Parse(c.endpoint)
 	if err != nil {
 		return nil, err
 	}
 	baseUrl.Path += fmt.Sprintf("/v1beta/%v", req.GetName())

 	params := url.Values{}
 	params.Add("$alt", "json;enum-encoding=int")

 	baseUrl.RawQuery = params.Encode()

 	// Build HTTP headers from client and context metadata.
 	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))}

 	hds = append(c.xGoogHeaders, hds...)
 	hds = append(hds, "Content-Type", "application/json")
 	headers := gax.BuildHeaders(ctx, hds...)
 	opts = append((*c.CallOptions).GetOperation[0:len((*c.CallOptions).GetOperation):len((*c.CallOptions).GetOperation)], opts...)
 	unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true}
 	resp := &longrunningpb.Operation{}
 	e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
 		if settings.Path != "" {
 			baseUrl.Path = settings.Path
 		}
 		httpReq, err := http.NewRequest("GET", baseUrl.String(), nil)
 		if err != nil {
 			return err
 		}
 		httpReq = httpReq.WithContext(ctx)
 		httpReq.Header = headers

 		httpRsp, err := c.httpClient.Do(httpReq)
 		if err != nil {
 			return err
 		}
 		defer httpRsp.Body.Close()

 		if err = googleapi.CheckResponse(httpRsp); err != nil {
 			return err
 		}

 		buf, err := io.ReadAll(httpRsp.Body)
 		if err != nil {
 			return err
 		}

 		if err := unm.Unmarshal(buf, resp); err != nil {
 			return err
 		}

 		return nil
 	}, opts...)
 	if e != nil {
 		return nil, e
 	}
 	return resp, nil
 }

 // ListOperations is a utility method from google.longrunning.Operations.
 func (c *rankRESTClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator {
 	it := &OperationIterator{}
 	req = proto.Clone(req).(*longrunningpb.ListOperationsRequest)
 	unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true}
 	it.InternalFetch = func(pageSize int, pageToken string) ([]*longrunningpb.Operation, string, error) {
 		resp := &longrunningpb.ListOperationsResponse{}
 		if pageToken != "" {
 			req.PageToken = pageToken
 		}
 		if pageSize > math.MaxInt32 {
 			req.PageSize = math.MaxInt32
 		} else if pageSize != 0 {
 			req.PageSize = int32(pageSize)
 		}
 		baseUrl, err := url.Parse(c.endpoint)
 		if err != nil {
 			return nil, "", err
 		}
 		baseUrl.Path += fmt.Sprintf("/v1beta/%v/operations", req.GetName())

 		params := url.Values{}
 		params.Add("$alt", "json;enum-encoding=int")
 		if req.GetFilter() != "" {
 			params.Add("filter", fmt.Sprintf("%v", req.GetFilter()))
 		}
 		if req.GetPageSize() != 0 {
 			params.Add("pageSize", fmt.Sprintf("%v", req.GetPageSize()))
 		}
 		if req.GetPageToken() != "" {
 			params.Add("pageToken", fmt.Sprintf("%v", req.GetPageToken()))
 		}

 		baseUrl.RawQuery = params.Encode()

 		// Build HTTP headers from client and context metadata.
 		hds := append(c.xGoogHeaders, "Content-Type", "application/json")
 		headers := gax.BuildHeaders(ctx, hds...)
 		e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
 			if settings.Path != "" {
 				baseUrl.Path = settings.Path
 			}
 			httpReq, err := http.NewRequest("GET", baseUrl.String(), nil)
 			if err != nil {
 				return err
 			}
 			httpReq.Header = headers

 			httpRsp, err := c.httpClient.Do(httpReq)
 			if err != nil {
 				return err
 			}
 			defer httpRsp.Body.Close()

 			if err = googleapi.CheckResponse(httpRsp); err != nil {
 				return err
 			}

 			buf, err := io.ReadAll(httpRsp.Body)
 			if err != nil {
 				return err
 			}

 			if err := unm.Unmarshal(buf, resp); err != nil {
 				return err
 			}

 			return nil
 		}, opts...)
 		if e != nil {
 			return nil, "", e
 		}
 		it.Response = resp
 		return resp.GetOperations(), resp.GetNextPageToken(), nil
 	}

 	fetch := func(pageSize int, pageToken string) (string, error) {
 		items, nextPageToken, err := it.InternalFetch(pageSize, pageToken)
 		if err != nil {
 			return "", err
 		}
 		it.items = append(it.items, items...)
 		return nextPageToken, nil
 	}

 	it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf)
 	it.pageInfo.MaxSize = int(req.GetPageSize())
 	it.pageInfo.Token = req.GetPageToken()

 	return it
 }
	// Copyright 2024 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
	//
	// https://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// 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 discoveryengine

	import (
	"bytes"
	"context"
	"fmt"
	"io"
	"math"
	"net/http"
	"net/url"
	"time"

	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb"
	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	gax "github.com/googleapis/gax-go/v2"
	"google.golang.org/api/googleapi"
	"google.golang.org/api/iterator"
	"google.golang.org/api/option"
	"google.golang.org/api/option/internaloption"
	gtransport "google.golang.org/api/transport/grpc"
	httptransport "google.golang.org/api/transport/http"
	"google.golang.org/grpc"
	"google.golang.org/grpc/codes"
	"google.golang.org/protobuf/encoding/protojson"
	"google.golang.org/protobuf/proto"
	)

	var newRankClientHook clientHook

	// RankCallOptions contains the retry settings for each method of RankClient.
	type RankCallOptions struct {
	Rank []gax.CallOption
	GetOperation []gax.CallOption
	ListOperations []gax.CallOption
	}

	func defaultRankGRPCClientOptions() []option.ClientOption {
	return []option.ClientOption{
	internaloption.WithDefaultEndpoint("discoveryengine.googleapis.com:443"),
	internaloption.WithDefaultEndpointTemplate("discoveryengine.UNIVERSE_DOMAIN:443"),
	internaloption.WithDefaultMTLSEndpoint("discoveryengine.mtls.googleapis.com:443"),
	internaloption.WithDefaultUniverseDomain("googleapis.com"),
	internaloption.WithDefaultAudience("https://discoveryengine.googleapis.com/"),
	internaloption.WithDefaultScopes(DefaultAuthScopes()...),
	internaloption.EnableJwtWithScope(),
	option.WithGRPCDialOption(grpc.WithDefaultCallOptions(
	grpc.MaxCallRecvMsgSize(math.MaxInt32))),
	}
	}

	func defaultRankCallOptions() *RankCallOptions {
	return &RankCallOptions{
	Rank: []gax.CallOption{
	gax.WithTimeout(30000 * time.Millisecond),
	gax.WithRetry(func() gax.Retryer {
	return gax.OnCodes([]codes.Code{
	codes.Unavailable,
	}, gax.Backoff{
	Initial: 1000 * time.Millisecond,
	Max: 10000 * time.Millisecond,
	Multiplier: 1.30,
	})
	}),
	},
	GetOperation: []gax.CallOption{
	gax.WithTimeout(30000 * time.Millisecond),
	gax.WithRetry(func() gax.Retryer {
	return gax.OnCodes([]codes.Code{
	codes.Unavailable,
	}, gax.Backoff{
	Initial: 1000 * time.Millisecond,
	Max: 10000 * time.Millisecond,
	Multiplier: 1.30,
	})
	}),
	},
	ListOperations: []gax.CallOption{
	gax.WithTimeout(300000 * time.Millisecond),
	gax.WithRetry(func() gax.Retryer {
	return gax.OnCodes([]codes.Code{
	codes.Unavailable,
	}, gax.Backoff{
	Initial: 1000 * time.Millisecond,
	Max: 30000 * time.Millisecond,
	Multiplier: 1.30,
	})
	}),
	},
	}
	}

	func defaultRankRESTCallOptions() *RankCallOptions {
	return &RankCallOptions{
	Rank: []gax.CallOption{
	gax.WithTimeout(30000 * time.Millisecond),
	gax.WithRetry(func() gax.Retryer {
	return gax.OnHTTPCodes(gax.Backoff{
	Initial: 1000 * time.Millisecond,
	Max: 10000 * time.Millisecond,
	Multiplier: 1.30,
	},
	http.StatusServiceUnavailable)
	}),
	},
	GetOperation: []gax.CallOption{
	gax.WithTimeout(30000 * time.Millisecond),
	gax.WithRetry(func() gax.Retryer {
	return gax.OnHTTPCodes(gax.Backoff{
	Initial: 1000 * time.Millisecond,
	Max: 10000 * time.Millisecond,
	Multiplier: 1.30,
	},
	http.StatusServiceUnavailable)
	}),
	},
	ListOperations: []gax.CallOption{
	gax.WithTimeout(300000 * time.Millisecond),
	gax.WithRetry(func() gax.Retryer {
	return gax.OnHTTPCodes(gax.Backoff{
	Initial: 1000 * time.Millisecond,
	Max: 30000 * time.Millisecond,
	Multiplier: 1.30,
	},
	http.StatusServiceUnavailable)
	}),
	},
	}
	}

	// internalRankClient is an interface that defines the methods available from Discovery Engine API.
	type internalRankClient interface {
	Close() error
	setGoogleClientInfo(...string)
	Connection() *grpc.ClientConn
	Rank(context.Context, discoveryenginepb.RankRequest, ...gax.CallOption) (discoveryenginepb.RankResponse, error)
	GetOperation(context.Context, longrunningpb.GetOperationRequest, ...gax.CallOption) (longrunningpb.Operation, error)
	ListOperations(context.Context, longrunningpb.ListOperationsRequest, ...gax.CallOption) OperationIterator
	}

	// RankClient is a client for interacting with Discovery Engine API.
	// Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
	//
	// Service for ranking text records.
	type RankClient struct {
	// The internal transport-dependent client.
	internalClient internalRankClient

	// The call options for this service.
	CallOptions *RankCallOptions
	}

	// Wrapper methods routed to the internal client.

	// Close closes the connection to the API service. The user should invoke this when
	// the client is no longer required.
	func (c *RankClient) Close() error {
	return c.internalClient.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 *RankClient) setGoogleClientInfo(keyval ...string) {
	c.internalClient.setGoogleClientInfo(keyval...)
	}

	// Connection returns a connection to the API service.
	//
	// Deprecated: Connections are now pooled so this method does not always
	// return the same resource.
	func (c RankClient) Connection() grpc.ClientConn {
	return c.internalClient.Connection()
	}

	// Rank ranks a list of text records based on the given input query.
	func (c RankClient) Rank(ctx context.Context, req discoveryenginepb.RankRequest, opts ...gax.CallOption) (*discoveryenginepb.RankResponse, error) {
	return c.internalClient.Rank(ctx, req, opts...)
	}

	// GetOperation is a utility method from google.longrunning.Operations.
	func (c RankClient) GetOperation(ctx context.Context, req longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) {
	return c.internalClient.GetOperation(ctx, req, opts...)
	}

	// ListOperations is a utility method from google.longrunning.Operations.
	func (c RankClient) ListOperations(ctx context.Context, req longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator {
	return c.internalClient.ListOperations(ctx, req, opts...)
	}

	// rankGRPCClient is a client for interacting with Discovery Engine API over gRPC transport.
	//
	// Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
	type rankGRPCClient struct {
	// Connection pool of gRPC connections to the service.
	connPool gtransport.ConnPool

	// Points back to the CallOptions field of the containing RankClient
	CallOptions **RankCallOptions

	// The gRPC API client.
	rankClient discoveryenginepb.RankServiceClient

	operationsClient longrunningpb.OperationsClient

	// The x-goog-* metadata to be sent with each request.
	xGoogHeaders []string
	}

	// NewRankClient creates a new rank service client based on gRPC.
	// The returned client must be Closed when it is done being used to clean up its underlying connections.
	//
	// Service for ranking text records.
	func NewRankClient(ctx context.Context, opts ...option.ClientOption) (*RankClient, error) {
	clientOpts := defaultRankGRPCClientOptions()
	if newRankClientHook != nil {
	hookOpts, err := newRankClientHook(ctx, clientHookParams{})
	if err != nil {
	return nil, err
	}
	clientOpts = append(clientOpts, hookOpts...)
	}

	connPool, err := gtransport.DialPool(ctx, append(clientOpts, opts...)...)
	if err != nil {
	return nil, err
	}
	client := RankClient{CallOptions: defaultRankCallOptions()}

	c := &rankGRPCClient{
	connPool: connPool,
	rankClient: discoveryenginepb.NewRankServiceClient(connPool),
	CallOptions: &client.CallOptions,
	operationsClient: longrunningpb.NewOperationsClient(connPool),
	}
	c.setGoogleClientInfo()

	client.internalClient = c

	return &client, nil
	}

	// Connection returns a connection to the API service.
	//
	// Deprecated: Connections are now pooled so this method does not always
	// return the same resource.
	func (c rankGRPCClient) Connection() grpc.ClientConn {
	return c.connPool.Conn()
	}

	// 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 *rankGRPCClient) setGoogleClientInfo(keyval ...string) {
	kv := append([]string{"gl-go", gax.GoVersion}, keyval...)
	kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "grpc", grpc.Version)
	c.xGoogHeaders = []string{"x-goog-api-client", gax.XGoogHeader(kv...)}
	}

	// Close closes the connection to the API service. The user should invoke this when
	// the client is no longer required.
	func (c *rankGRPCClient) Close() error {
	return c.connPool.Close()
	}

	// Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
	type rankRESTClient struct {
	// The http endpoint to connect to.
	endpoint string

	// The http client.
	httpClient *http.Client

	// The x-goog-* headers to be sent with each request.
	xGoogHeaders []string

	// Points back to the CallOptions field of the containing RankClient
	CallOptions **RankCallOptions
	}

	// NewRankRESTClient creates a new rank service rest client.
	//
	// Service for ranking text records.
	func NewRankRESTClient(ctx context.Context, opts ...option.ClientOption) (*RankClient, error) {
	clientOpts := append(defaultRankRESTClientOptions(), opts...)
	httpClient, endpoint, err := httptransport.NewClient(ctx, clientOpts...)
	if err != nil {
	return nil, err
	}

	callOpts := defaultRankRESTCallOptions()
	c := &rankRESTClient{
	endpoint: endpoint,
	httpClient: httpClient,
	CallOptions: &callOpts,
	}
	c.setGoogleClientInfo()

	return &RankClient{internalClient: c, CallOptions: callOpts}, nil
	}

	func defaultRankRESTClientOptions() []option.ClientOption {
	return []option.ClientOption{
	internaloption.WithDefaultEndpoint("https://discoveryengine.googleapis.com"),
	internaloption.WithDefaultEndpointTemplate("https://discoveryengine.UNIVERSE_DOMAIN"),
	internaloption.WithDefaultMTLSEndpoint("https://discoveryengine.mtls.googleapis.com"),
	internaloption.WithDefaultUniverseDomain("googleapis.com"),
	internaloption.WithDefaultAudience("https://discoveryengine.googleapis.com/"),
	internaloption.WithDefaultScopes(DefaultAuthScopes()...),
	}
	}

	// 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 *rankRESTClient) setGoogleClientInfo(keyval ...string) {
	kv := append([]string{"gl-go", gax.GoVersion}, keyval...)
	kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "rest", "UNKNOWN")
	c.xGoogHeaders = []string{"x-goog-api-client", gax.XGoogHeader(kv...)}
	}

	// Close closes the connection to the API service. The user should invoke this when
	// the client is no longer required.
	func (c *rankRESTClient) Close() error {
	// Replace httpClient with nil to force cleanup.
	c.httpClient = nil
	return nil
	}

	// Connection returns a connection to the API service.
	//
	// Deprecated: This method always returns nil.
	func (c rankRESTClient) Connection() grpc.ClientConn {
	return nil
	}
	func (c rankGRPCClient) Rank(ctx context.Context, req discoveryenginepb.RankRequest, opts ...gax.CallOption) (*discoveryenginepb.RankResponse, error) {
	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "ranking_config", url.QueryEscape(req.GetRankingConfig()))}

	hds = append(c.xGoogHeaders, hds...)
	ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...)
	opts = append((c.CallOptions).Rank[0:len((c.CallOptions).Rank):len((*c.CallOptions).Rank)], opts...)
	var resp *discoveryenginepb.RankResponse
	err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
	var err error
	resp, err = c.rankClient.Rank(ctx, req, settings.GRPC...)
	return err
	}, opts...)
	if err != nil {
	return nil, err
	}
	return resp, nil
	}

	func (c rankGRPCClient) GetOperation(ctx context.Context, req longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) {
	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))}

	hds = append(c.xGoogHeaders, hds...)
	ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...)
	opts = append((c.CallOptions).GetOperation[0:len((c.CallOptions).GetOperation):len((*c.CallOptions).GetOperation)], opts...)
	var resp *longrunningpb.Operation
	err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
	var err error
	resp, err = c.operationsClient.GetOperation(ctx, req, settings.GRPC...)
	return err
	}, opts...)
	if err != nil {
	return nil, err
	}
	return resp, nil
	}

	func (c rankGRPCClient) ListOperations(ctx context.Context, req longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator {
	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))}

	hds = append(c.xGoogHeaders, hds...)
	ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...)
	opts = append((c.CallOptions).ListOperations[0:len((c.CallOptions).ListOperations):len((*c.CallOptions).ListOperations)], opts...)
	it := &OperationIterator{}
	req = proto.Clone(req).(*longrunningpb.ListOperationsRequest)
	it.InternalFetch = func(pageSize int, pageToken string) ([]*longrunningpb.Operation, string, error) {
	resp := &longrunningpb.ListOperationsResponse{}
	if pageToken != "" {
	req.PageToken = pageToken
	}
	if pageSize > math.MaxInt32 {
	req.PageSize = math.MaxInt32
	} else if pageSize != 0 {
	req.PageSize = int32(pageSize)
	}
	err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
	var err error
	resp, err = c.operationsClient.ListOperations(ctx, req, settings.GRPC...)
	return err
	}, opts...)
	if err != nil {
	return nil, "", err
	}

	it.Response = resp
	return resp.GetOperations(), resp.GetNextPageToken(), nil
	}
	fetch := func(pageSize int, pageToken string) (string, error) {
	items, nextPageToken, err := it.InternalFetch(pageSize, pageToken)
	if err != nil {
	return "", err
	}
	it.items = append(it.items, items...)
	return nextPageToken, nil
	}

	it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf)
	it.pageInfo.MaxSize = int(req.GetPageSize())
	it.pageInfo.Token = req.GetPageToken()

	return it
	}

	// Rank ranks a list of text records based on the given input query.
	func (c rankRESTClient) Rank(ctx context.Context, req discoveryenginepb.RankRequest, opts ...gax.CallOption) (*discoveryenginepb.RankResponse, error) {
	m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true}
	jsonReq, err := m.Marshal(req)
	if err != nil {
	return nil, err
	}

	baseUrl, err := url.Parse(c.endpoint)
	if err != nil {
	return nil, err
	}
	baseUrl.Path += fmt.Sprintf("/v1beta/%v:rank", req.GetRankingConfig())

	params := url.Values{}
	params.Add("$alt", "json;enum-encoding=int")

	baseUrl.RawQuery = params.Encode()

	// Build HTTP headers from client and context metadata.
	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "ranking_config", url.QueryEscape(req.GetRankingConfig()))}

	hds = append(c.xGoogHeaders, hds...)
	hds = append(hds, "Content-Type", "application/json")
	headers := gax.BuildHeaders(ctx, hds...)
	opts = append((c.CallOptions).Rank[0:len((c.CallOptions).Rank):len((*c.CallOptions).Rank)], opts...)
	unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true}
	resp := &discoveryenginepb.RankResponse{}
	e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
	if settings.Path != "" {
	baseUrl.Path = settings.Path
	}
	httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq))
	if err != nil {
	return err
	}
	httpReq = httpReq.WithContext(ctx)
	httpReq.Header = headers

	httpRsp, err := c.httpClient.Do(httpReq)
	if err != nil {
	return err
	}
	defer httpRsp.Body.Close()

	if err = googleapi.CheckResponse(httpRsp); err != nil {
	return err
	}

	buf, err := io.ReadAll(httpRsp.Body)
	if err != nil {
	return err
	}

	if err := unm.Unmarshal(buf, resp); err != nil {
	return err
	}

	return nil
	}, opts...)
	if e != nil {
	return nil, e
	}
	return resp, nil
	}

	// GetOperation is a utility method from google.longrunning.Operations.
	func (c rankRESTClient) GetOperation(ctx context.Context, req longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error) {
	baseUrl, err := url.Parse(c.endpoint)
	if err != nil {
	return nil, err
	}
	baseUrl.Path += fmt.Sprintf("/v1beta/%v", req.GetName())

	params := url.Values{}
	params.Add("$alt", "json;enum-encoding=int")

	baseUrl.RawQuery = params.Encode()

	// Build HTTP headers from client and context metadata.
	hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))}

	hds = append(c.xGoogHeaders, hds...)
	hds = append(hds, "Content-Type", "application/json")
	headers := gax.BuildHeaders(ctx, hds...)
	opts = append((c.CallOptions).GetOperation[0:len((c.CallOptions).GetOperation):len((*c.CallOptions).GetOperation)], opts...)
	unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true}
	resp := &longrunningpb.Operation{}
	e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
	if settings.Path != "" {
	baseUrl.Path = settings.Path
	}
	httpReq, err := http.NewRequest("GET", baseUrl.String(), nil)
	if err != nil {
	return err
	}
	httpReq = httpReq.WithContext(ctx)
	httpReq.Header = headers

	httpRsp, err := c.httpClient.Do(httpReq)
	if err != nil {
	return err
	}
	defer httpRsp.Body.Close()

	if err = googleapi.CheckResponse(httpRsp); err != nil {
	return err
	}

	buf, err := io.ReadAll(httpRsp.Body)
	if err != nil {
	return err
	}

	if err := unm.Unmarshal(buf, resp); err != nil {
	return err
	}

	return nil
	}, opts...)
	if e != nil {
	return nil, e
	}
	return resp, nil
	}

	// ListOperations is a utility method from google.longrunning.Operations.
	func (c rankRESTClient) ListOperations(ctx context.Context, req longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator {
	it := &OperationIterator{}
	req = proto.Clone(req).(*longrunningpb.ListOperationsRequest)
	unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true}
	it.InternalFetch = func(pageSize int, pageToken string) ([]*longrunningpb.Operation, string, error) {
	resp := &longrunningpb.ListOperationsResponse{}
	if pageToken != "" {
	req.PageToken = pageToken
	}
	if pageSize > math.MaxInt32 {
	req.PageSize = math.MaxInt32
	} else if pageSize != 0 {
	req.PageSize = int32(pageSize)
	}
	baseUrl, err := url.Parse(c.endpoint)
	if err != nil {
	return nil, "", err
	}
	baseUrl.Path += fmt.Sprintf("/v1beta/%v/operations", req.GetName())

	params := url.Values{}
	params.Add("$alt", "json;enum-encoding=int")
	if req.GetFilter() != "" {
	params.Add("filter", fmt.Sprintf("%v", req.GetFilter()))
	}
	if req.GetPageSize() != 0 {
	params.Add("pageSize", fmt.Sprintf("%v", req.GetPageSize()))
	}
	if req.GetPageToken() != "" {
	params.Add("pageToken", fmt.Sprintf("%v", req.GetPageToken()))
	}

	baseUrl.RawQuery = params.Encode()

	// Build HTTP headers from client and context metadata.
	hds := append(c.xGoogHeaders, "Content-Type", "application/json")
	headers := gax.BuildHeaders(ctx, hds...)
	e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
	if settings.Path != "" {
	baseUrl.Path = settings.Path
	}
	httpReq, err := http.NewRequest("GET", baseUrl.String(), nil)
	if err != nil {
	return err
	}
	httpReq.Header = headers

	httpRsp, err := c.httpClient.Do(httpReq)
	if err != nil {
	return err
	}
	defer httpRsp.Body.Close()

	if err = googleapi.CheckResponse(httpRsp); err != nil {
	return err
	}

	buf, err := io.ReadAll(httpRsp.Body)
	if err != nil {
	return err
	}

	if err := unm.Unmarshal(buf, resp); err != nil {
	return err
	}

	return nil
	}, opts...)
	if e != nil {
	return nil, "", e
	}
	it.Response = resp
	return resp.GetOperations(), resp.GetNextPageToken(), nil
	}

	fetch := func(pageSize int, pageToken string) (string, error) {
	items, nextPageToken, err := it.InternalFetch(pageSize, pageToken)
	if err != nil {
	return "", err
	}
	it.items = append(it.items, items...)
	return nextPageToken, nil
	}

	it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf)
	it.pageInfo.MaxSize = int(req.GetPageSize())
	it.pageInfo.Token = req.GetPageToken()

	return it
	}