// Copyright 2026 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Code generated file. DO NOT EDIT.

// Package developerknowledge provides access to the Developer Knowledge API.
//
// For product documentation, see: https://developers.google.com/knowledge
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
//	import "google.golang.org/api/developerknowledge/v1"
//	...
//	ctx := context.Background()
//	developerknowledgeService, err := developerknowledge.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
//	developerknowledgeService, err := developerknowledge.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
//	config := &oauth2.Config{...}
//	// ...
//	token, err := config.Exchange(ctx, ...)
//	developerknowledgeService, err := developerknowledge.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package developerknowledge // import "google.golang.org/api/developerknowledge/v1"

import (
	"bytes"
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log/slog"
	"net/http"
	"net/url"
	"strconv"
	"strings"

	"github.com/googleapis/gax-go/v2/internallog"
	googleapi "google.golang.org/api/googleapi"
	internal "google.golang.org/api/internal"
	gensupport "google.golang.org/api/internal/gensupport"
	option "google.golang.org/api/option"
	internaloption "google.golang.org/api/option/internaloption"
	htransport "google.golang.org/api/transport/http"
)

// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
var _ = internallog.New

const apiId = "developerknowledge:v1"
const apiName = "developerknowledge"
const apiVersion = "v1"
const basePath = "https://developerknowledge.googleapis.com/"
const basePathTemplate = "https://developerknowledge.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://developerknowledge.mtls.googleapis.com/"

// OAuth2 scopes used by this API.
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
	scopesOption := internaloption.WithDefaultScopes(
		"https://www.googleapis.com/auth/cloud-platform",
	)
	// NOTE: prepend, so we don't override user-specified scopes.
	opts = append([]option.ClientOption{scopesOption}, opts...)
	opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
	opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
	opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
	opts = append(opts, internaloption.EnableNewAuthLibrary())
	client, endpoint, err := htransport.NewClient(ctx, opts...)
	if err != nil {
		return nil, err
	}
	s := &Service{client: client, BasePath: basePath, logger: internaloption.GetLogger(opts)}
	s.Documents = NewDocumentsService(s)
	if endpoint != "" {
		s.BasePath = endpoint
	}
	return s, nil
}

// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
	if client == nil {
		return nil, errors.New("client is nil")
	}
	return NewService(context.TODO(), option.WithHTTPClient(client))
}

type Service struct {
	client    *http.Client
	logger    *slog.Logger
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Documents *DocumentsService
}

func (s *Service) userAgent() string {
	if s.UserAgent == "" {
		return googleapi.UserAgent
	}
	return googleapi.UserAgent + " " + s.UserAgent
}

func NewDocumentsService(s *Service) *DocumentsService {
	rs := &DocumentsService{s: s}
	return rs
}

type DocumentsService struct {
	s *Service
}

// BatchGetDocumentsResponse: Response message for
// DeveloperKnowledge.BatchGetDocuments.
type BatchGetDocumentsResponse struct {
	// Documents: Contains the documents requested.
	Documents []*Document `json:"documents,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Documents") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Documents") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (s BatchGetDocumentsResponse) MarshalJSON() ([]byte, error) {
	type NoMethod BatchGetDocumentsResponse
	return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}

// Document: A Document represents a piece of content from the Developer
// Knowledge corpus.
type Document struct {
	// Content: Output only. Contains the full content of the document in Markdown
	// format.
	Content string `json:"content,omitempty"`
	// ContentLengthBytes: Output only. The length of the `content` field in bytes.
	ContentLengthBytes int64 `json:"contentLengthBytes,omitempty"`
	// DataSource: Output only. Specifies the data source of the document. Example
	// data source: `firebase.google.com`
	DataSource string `json:"dataSource,omitempty"`
	// Description: Output only. Provides a description of the document.
	Description string `json:"description,omitempty"`
	// Name: Identifier. Contains the resource name of the document. Format:
	// `documents/{uri_without_scheme}` Example:
	// `documents/docs.cloud.google.com/storage/docs/creating-buckets`
	Name string `json:"name,omitempty"`
	// Title: Output only. Provides the title of the document.
	Title string `json:"title,omitempty"`
	// UpdateTime: Output only. Represents the timestamp when the content or
	// metadata of the document was last updated.
	UpdateTime string `json:"updateTime,omitempty"`
	// Uri: Output only. Provides the URI of the content, such as
	// `docs.cloud.google.com/storage/docs/creating-buckets`.
	Uri string `json:"uri,omitempty"`
	// View: Output only. Specifies the DocumentView of the document.
	//
	// Possible values:
	//   "DOCUMENT_VIEW_UNSPECIFIED" - The default / unset value. See each API
	// method for its default value if DocumentView is not specified.
	//   "DOCUMENT_VIEW_BASIC" - Includes only the basic metadata fields: - `name`
	// - `uri` - `data_source` - `title` - `description` - `update_time` - `view` -
	// `content_length_bytes` This is the default of view for
	// DeveloperKnowledge.SearchDocumentChunks.
	//   "DOCUMENT_VIEW_FULL" - Includes all Document fields.
	//   "DOCUMENT_VIEW_CONTENT" - Includes the `DOCUMENT_VIEW_BASIC` fields and
	// the `content` field. This is the default of view for
	// DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments.
	View string `json:"view,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Content") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Content") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (s Document) MarshalJSON() ([]byte, error) {
	type NoMethod Document
	return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}

// DocumentChunk: A DocumentChunk represents a piece of content from a Document
// in the DeveloperKnowledge corpus. To fetch the entire document content, pass
// the `parent` to DeveloperKnowledge.GetDocument or
// DeveloperKnowledge.BatchGetDocuments.
type DocumentChunk struct {
	// Content: Output only. Contains the content of the document chunk.
	Content string `json:"content,omitempty"`
	// Document: Output only. Represents metadata about the Document this chunk is
	// from. The DocumentView of this Document message will be set to
	// `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients
	// do not need to call DeveloperKnowledge.GetDocument or
	// DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields.
	// Otherwise, clients should use DeveloperKnowledge.GetDocument or
	// DeveloperKnowledge.BatchGetDocuments to fetch the full document content.
	Document *Document `json:"document,omitempty"`
	// Id: Output only. Specifies the ID of this chunk within the document. The
	// chunk ID is unique within a document, but not globally unique across
	// documents. The chunk ID is not stable and may change over time.
	Id string `json:"id,omitempty"`
	// Parent: Output only. Contains the resource name of the document this chunk
	// is from. Format: `documents/{uri_without_scheme}` Example:
	// `documents/docs.cloud.google.com/storage/docs/creating-buckets`
	Parent string `json:"parent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Content") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Content") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (s DocumentChunk) MarshalJSON() ([]byte, error) {
	type NoMethod DocumentChunk
	return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}

// SearchDocumentChunksResponse: Response message for
// DeveloperKnowledge.SearchDocumentChunks.
type SearchDocumentChunksResponse struct {
	// NextPageToken: Optional. Provides a token that can be sent as `page_token`
	// to retrieve the next page. If this field is omitted, there are no subsequent
	// pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Results: Contains the search results for the given query. Each DocumentChunk
	// in this list contains a snippet of content relevant to the search query. Use
	// the DocumentChunk.parent field of each result with
	// DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to
	// retrieve the full document content.
	Results []*DocumentChunk `json:"results,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (s SearchDocumentChunksResponse) MarshalJSON() ([]byte, error) {
	type NoMethod SearchDocumentChunksResponse
	return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}

type DocumentsBatchGetCall struct {
	s            *Service
	urlParams_   gensupport.URLParams
	ifNoneMatch_ string
	ctx_         context.Context
	header_      http.Header
}

// BatchGet: Retrieves multiple documents, each with its full Markdown content.
func (r *DocumentsService) BatchGet() *DocumentsBatchGetCall {
	c := &DocumentsBatchGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
	return c
}

// Names sets the optional parameter "names": Required. Specifies the names of
// the documents to retrieve. A maximum of 20 documents can be retrieved in a
// batch. The documents are returned in the same order as the `names` in the
// request. Format: `documents/{uri_without_scheme}` Example:
// `documents/docs.cloud.google.com/storage/docs/creating-buckets`
func (c *DocumentsBatchGetCall) Names(names ...string) *DocumentsBatchGetCall {
	c.urlParams_.SetMulti("names", append([]string{}, names...))
	return c
}

// View sets the optional parameter "view": Specifies the DocumentView of the
// document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to
// `DOCUMENT_VIEW_CONTENT`.
//
// Possible values:
//
//	"DOCUMENT_VIEW_UNSPECIFIED" - The default / unset value. See each API
//
// method for its default value if DocumentView is not specified.
//
//	"DOCUMENT_VIEW_BASIC" - Includes only the basic metadata fields: - `name`
//
// - `uri` - `data_source` - `title` - `description` - `update_time` - `view` -
// `content_length_bytes` This is the default of view for
// DeveloperKnowledge.SearchDocumentChunks.
//
//	"DOCUMENT_VIEW_FULL" - Includes all Document fields.
//	"DOCUMENT_VIEW_CONTENT" - Includes the `DOCUMENT_VIEW_BASIC` fields and
//
// the `content` field. This is the default of view for
// DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments.
func (c *DocumentsBatchGetCall) View(view string) *DocumentsBatchGetCall {
	c.urlParams_.Set("view", view)
	return c
}

// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *DocumentsBatchGetCall) Fields(s ...googleapi.Field) *DocumentsBatchGetCall {
	c.urlParams_.Set("fields", googleapi.CombineFields(s))
	return c
}

// IfNoneMatch sets an optional parameter which makes the operation fail if the
// object's ETag matches the given value. This is useful for getting updates
// only after the object has changed since the last request.
func (c *DocumentsBatchGetCall) IfNoneMatch(entityTag string) *DocumentsBatchGetCall {
	c.ifNoneMatch_ = entityTag
	return c
}

// Context sets the context to be used in this call's Do method.
func (c *DocumentsBatchGetCall) Context(ctx context.Context) *DocumentsBatchGetCall {
	c.ctx_ = ctx
	return c
}

// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *DocumentsBatchGetCall) Header() http.Header {
	if c.header_ == nil {
		c.header_ = make(http.Header)
	}
	return c.header_
}

func (c *DocumentsBatchGetCall) doRequest(alt string) (*http.Response, error) {
	reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
	if c.ifNoneMatch_ != "" {
		reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
	}
	c.urlParams_.Set("alt", alt)
	c.urlParams_.Set("prettyPrint", "false")
	urls := googleapi.ResolveRelative(c.s.BasePath, "v1/documents:batchGet")
	urls += "?" + c.urlParams_.Encode()
	req, err := http.NewRequest("GET", urls, nil)
	if err != nil {
		return nil, err
	}
	req.Header = reqHeaders
	c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "developerknowledge.documents.batchGet", "request", internallog.HTTPRequest(req, nil))
	return gensupport.SendRequest(c.ctx_, c.s.client, req)
}

// Do executes the "developerknowledge.documents.batchGet" call.
// Any non-2xx status code is an error. Response headers are in either
// *BatchGetDocumentsResponse.ServerResponse.Header or (if a response was
// returned at all) in error.(*googleapi.Error).Header. Use
// googleapi.IsNotModified to check whether the returned error was because
// http.StatusNotModified was returned.
func (c *DocumentsBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetDocumentsResponse, error) {
	gensupport.SetOptions(c.urlParams_, opts...)
	res, err := c.doRequest("json")
	if res != nil && res.StatusCode == http.StatusNotModified {
		if res.Body != nil {
			res.Body.Close()
		}
		return nil, gensupport.WrapError(&googleapi.Error{
			Code:   res.StatusCode,
			Header: res.Header,
		})
	}
	if err != nil {
		return nil, err
	}
	defer googleapi.CloseBody(res)
	if err := googleapi.CheckResponse(res); err != nil {
		return nil, gensupport.WrapError(err)
	}
	ret := &BatchGetDocumentsResponse{
		ServerResponse: googleapi.ServerResponse{
			Header:         res.Header,
			HTTPStatusCode: res.StatusCode,
		},
	}
	target := &ret
	b, err := gensupport.DecodeResponseBytes(target, res)
	if err != nil {
		return nil, err
	}
	c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "developerknowledge.documents.batchGet", "response", internallog.HTTPResponse(res, b))
	return ret, nil
}

type DocumentsGetCall struct {
	s            *Service
	name         string
	urlParams_   gensupport.URLParams
	ifNoneMatch_ string
	ctx_         context.Context
	header_      http.Header
}

// Get: Retrieves a single document with its full Markdown content.
//
//   - name: Specifies the name of the document to retrieve. Format:
//     `documents/{uri_without_scheme}` Example:
//     `documents/docs.cloud.google.com/storage/docs/creating-buckets`.
func (r *DocumentsService) Get(name string) *DocumentsGetCall {
	c := &DocumentsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
	c.name = name
	return c
}

// View sets the optional parameter "view": Specifies the DocumentView of the
// document. If unspecified, DeveloperKnowledge.GetDocument defaults to
// `DOCUMENT_VIEW_CONTENT`.
//
// Possible values:
//
//	"DOCUMENT_VIEW_UNSPECIFIED" - The default / unset value. See each API
//
// method for its default value if DocumentView is not specified.
//
//	"DOCUMENT_VIEW_BASIC" - Includes only the basic metadata fields: - `name`
//
// - `uri` - `data_source` - `title` - `description` - `update_time` - `view` -
// `content_length_bytes` This is the default of view for
// DeveloperKnowledge.SearchDocumentChunks.
//
//	"DOCUMENT_VIEW_FULL" - Includes all Document fields.
//	"DOCUMENT_VIEW_CONTENT" - Includes the `DOCUMENT_VIEW_BASIC` fields and
//
// the `content` field. This is the default of view for
// DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments.
func (c *DocumentsGetCall) View(view string) *DocumentsGetCall {
	c.urlParams_.Set("view", view)
	return c
}

// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *DocumentsGetCall) Fields(s ...googleapi.Field) *DocumentsGetCall {
	c.urlParams_.Set("fields", googleapi.CombineFields(s))
	return c
}

// IfNoneMatch sets an optional parameter which makes the operation fail if the
// object's ETag matches the given value. This is useful for getting updates
// only after the object has changed since the last request.
func (c *DocumentsGetCall) IfNoneMatch(entityTag string) *DocumentsGetCall {
	c.ifNoneMatch_ = entityTag
	return c
}

// Context sets the context to be used in this call's Do method.
func (c *DocumentsGetCall) Context(ctx context.Context) *DocumentsGetCall {
	c.ctx_ = ctx
	return c
}

// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *DocumentsGetCall) Header() http.Header {
	if c.header_ == nil {
		c.header_ = make(http.Header)
	}
	return c.header_
}

func (c *DocumentsGetCall) doRequest(alt string) (*http.Response, error) {
	reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
	if c.ifNoneMatch_ != "" {
		reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
	}
	c.urlParams_.Set("alt", alt)
	c.urlParams_.Set("prettyPrint", "false")
	urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}")
	urls += "?" + c.urlParams_.Encode()
	req, err := http.NewRequest("GET", urls, nil)
	if err != nil {
		return nil, err
	}
	req.Header = reqHeaders
	googleapi.Expand(req.URL, map[string]string{
		"name": c.name,
	})
	c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "developerknowledge.documents.get", "request", internallog.HTTPRequest(req, nil))
	return gensupport.SendRequest(c.ctx_, c.s.client, req)
}

// Do executes the "developerknowledge.documents.get" call.
// Any non-2xx status code is an error. Response headers are in either
// *Document.ServerResponse.Header or (if a response was returned at all) in
// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
// whether the returned error was because http.StatusNotModified was returned.
func (c *DocumentsGetCall) Do(opts ...googleapi.CallOption) (*Document, error) {
	gensupport.SetOptions(c.urlParams_, opts...)
	res, err := c.doRequest("json")
	if res != nil && res.StatusCode == http.StatusNotModified {
		if res.Body != nil {
			res.Body.Close()
		}
		return nil, gensupport.WrapError(&googleapi.Error{
			Code:   res.StatusCode,
			Header: res.Header,
		})
	}
	if err != nil {
		return nil, err
	}
	defer googleapi.CloseBody(res)
	if err := googleapi.CheckResponse(res); err != nil {
		return nil, gensupport.WrapError(err)
	}
	ret := &Document{
		ServerResponse: googleapi.ServerResponse{
			Header:         res.Header,
			HTTPStatusCode: res.StatusCode,
		},
	}
	target := &ret
	b, err := gensupport.DecodeResponseBytes(target, res)
	if err != nil {
		return nil, err
	}
	c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "developerknowledge.documents.get", "response", internallog.HTTPResponse(res, b))
	return ret, nil
}

type DocumentsSearchDocumentChunksCall struct {
	s            *Service
	urlParams_   gensupport.URLParams
	ifNoneMatch_ string
	ctx_         context.Context
	header_      http.Header
}

// SearchDocumentChunks: Searches for developer knowledge across Google's
// developer documentation. Returns DocumentChunks based on the user's query.
// There may be many chunks from the same Document. To retrieve full documents,
// use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments
// with the DocumentChunk.parent returned in the
// SearchDocumentChunksResponse.results.
func (r *DocumentsService) SearchDocumentChunks() *DocumentsSearchDocumentChunksCall {
	c := &DocumentsSearchDocumentChunksCall{s: r.s, urlParams_: make(gensupport.URLParams)}
	return c
}

// Filter sets the optional parameter "filter": Applies a strict filter to the
// search results. The expression supports a subset of the syntax described at
// https://google.aip.dev/160. While `SearchDocumentChunks` returns
// DocumentChunks, the filter is applied to `DocumentChunk.document` fields.
// Supported fields for filtering: * `content_length_bytes` (INTEGER): The
// length of the `Document.content` field in bytes. * `data_source` (STRING):
// The source of the document, e.g. `docs.cloud.google.com`. See
// https://developers.google.com/knowledge/reference/corpus-reference for the
// complete list of data sources in the corpus. * `update_time` (TIMESTAMP):
// The timestamp of when the document was last meaningfully updated. A
// meaningful update is one that changes document's markdown content or
// metadata. * `uri` (STRING): The document URI, e.g.
// `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support
// `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals)
// and `!=` (not equals) operators for **exact match** on the whole string.
// Partial match, prefix match, and regexp match are not supported. TIMESTAMP
// fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be
// in RFC-3339 format, e.g., "2025-01-01T00:00:00Z". You can combine
// expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR`
// has higher precedence than `AND`. Use parentheses for explicit precedence
// grouping. Examples: * Filter by `Document.content_length_bytes`:
// `content_length_bytes < 50000` * `data_source = "docs.cloud.google.com" OR
// data_source = "firebase.google.com" * `data_source !=
// "firebase.google.com" * `update_time < "2024-01-01T00:00:00Z" *
// `update_time >= "2025-01-22T00:00:00Z" AND (data_source =
// "developer.chrome.com" OR data_source = "web.dev")` * `uri =
// "https://docs.cloud.google.com/release-notes" The `filter` string must not
// exceed 500 characters; values longer than 500 characters will result in an
// `INVALID_ARGUMENT` error.
func (c *DocumentsSearchDocumentChunksCall) Filter(filter string) *DocumentsSearchDocumentChunksCall {
	c.urlParams_.Set("filter", filter)
	return c
}

// PageSize sets the optional parameter "pageSize": Specifies the maximum
// number of results to return. The service may return fewer than this value.
// If unspecified, at most 5 results will be returned. The maximum value is
// 100; values above 100 will be coerced to 100.
func (c *DocumentsSearchDocumentChunksCall) PageSize(pageSize int64) *DocumentsSearchDocumentChunksCall {
	c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
	return c
}

// PageToken sets the optional parameter "pageToken": Contains a page token,
// received from a previous `SearchDocumentChunks` call. Provide this to
// retrieve the subsequent page.
func (c *DocumentsSearchDocumentChunksCall) PageToken(pageToken string) *DocumentsSearchDocumentChunksCall {
	c.urlParams_.Set("pageToken", pageToken)
	return c
}

// Query sets the optional parameter "query": Required. Provides the raw query
// string provided by the user, such as "How to create a Cloud Storage
// bucket?".
func (c *DocumentsSearchDocumentChunksCall) Query(query string) *DocumentsSearchDocumentChunksCall {
	c.urlParams_.Set("query", query)
	return c
}

// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *DocumentsSearchDocumentChunksCall) Fields(s ...googleapi.Field) *DocumentsSearchDocumentChunksCall {
	c.urlParams_.Set("fields", googleapi.CombineFields(s))
	return c
}

// IfNoneMatch sets an optional parameter which makes the operation fail if the
// object's ETag matches the given value. This is useful for getting updates
// only after the object has changed since the last request.
func (c *DocumentsSearchDocumentChunksCall) IfNoneMatch(entityTag string) *DocumentsSearchDocumentChunksCall {
	c.ifNoneMatch_ = entityTag
	return c
}

// Context sets the context to be used in this call's Do method.
func (c *DocumentsSearchDocumentChunksCall) Context(ctx context.Context) *DocumentsSearchDocumentChunksCall {
	c.ctx_ = ctx
	return c
}

// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *DocumentsSearchDocumentChunksCall) Header() http.Header {
	if c.header_ == nil {
		c.header_ = make(http.Header)
	}
	return c.header_
}

func (c *DocumentsSearchDocumentChunksCall) doRequest(alt string) (*http.Response, error) {
	reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
	if c.ifNoneMatch_ != "" {
		reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
	}
	c.urlParams_.Set("alt", alt)
	c.urlParams_.Set("prettyPrint", "false")
	urls := googleapi.ResolveRelative(c.s.BasePath, "v1/documents:searchDocumentChunks")
	urls += "?" + c.urlParams_.Encode()
	req, err := http.NewRequest("GET", urls, nil)
	if err != nil {
		return nil, err
	}
	req.Header = reqHeaders
	c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "developerknowledge.documents.searchDocumentChunks", "request", internallog.HTTPRequest(req, nil))
	return gensupport.SendRequest(c.ctx_, c.s.client, req)
}

// Do executes the "developerknowledge.documents.searchDocumentChunks" call.
// Any non-2xx status code is an error. Response headers are in either
// *SearchDocumentChunksResponse.ServerResponse.Header or (if a response was
// returned at all) in error.(*googleapi.Error).Header. Use
// googleapi.IsNotModified to check whether the returned error was because
// http.StatusNotModified was returned.
func (c *DocumentsSearchDocumentChunksCall) Do(opts ...googleapi.CallOption) (*SearchDocumentChunksResponse, error) {
	gensupport.SetOptions(c.urlParams_, opts...)
	res, err := c.doRequest("json")
	if res != nil && res.StatusCode == http.StatusNotModified {
		if res.Body != nil {
			res.Body.Close()
		}
		return nil, gensupport.WrapError(&googleapi.Error{
			Code:   res.StatusCode,
			Header: res.Header,
		})
	}
	if err != nil {
		return nil, err
	}
	defer googleapi.CloseBody(res)
	if err := googleapi.CheckResponse(res); err != nil {
		return nil, gensupport.WrapError(err)
	}
	ret := &SearchDocumentChunksResponse{
		ServerResponse: googleapi.ServerResponse{
			Header:         res.Header,
			HTTPStatusCode: res.StatusCode,
		},
	}
	target := &ret
	b, err := gensupport.DecodeResponseBytes(target, res)
	if err != nil {
		return nil, err
	}
	c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "developerknowledge.documents.searchDocumentChunks", "response", internallog.HTTPResponse(res, b))
	return ret, nil
}

// Pages invokes f for each page of results.
// A non-nil error returned from f will halt the iteration.
// The provided context supersedes any context provided to the Context method.
func (c *DocumentsSearchDocumentChunksCall) Pages(ctx context.Context, f func(*SearchDocumentChunksResponse) error) error {
	c.ctx_ = ctx
	defer c.PageToken(c.urlParams_.Get("pageToken"))
	for {
		x, err := c.Do()
		if err != nil {
			return err
		}
		if err := f(x); err != nil {
			return err
		}
		if x.NextPageToken == "" {
			return nil
		}
		c.PageToken(x.NextPageToken)
	}
}
