// Copyright 2024 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 cloudtrace provides access to the Cloud Trace API.

//

// For product documentation, see: https://cloud.google.com/trace

//

// # 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/cloudtrace/v1"

// ...

// ctx := context.Background()

// cloudtraceService, err := cloudtrace.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

//

// By default, all available scopes (see "Constants") are used to authenticate.

// To restrict scopes, use [google.golang.org/api/option.WithScopes]:

//

// cloudtraceService, err := cloudtrace.NewService(ctx, option.WithScopes(cloudtrace.TraceReadonlyScope))

//

// To use an API key for authentication (note: some APIs do not support API

// keys), use [google.golang.org/api/option.WithAPIKey]:

//

// cloudtraceService, err := cloudtrace.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, ...)

// cloudtraceService, err := cloudtrace.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

//

// See [google.golang.org/api/option.ClientOption] for details on options.

package cloudtrace // import "google.golang.org/api/cloudtrace/v1"

import (

"bytes"

"context"

"encoding/json"

"errors"

"fmt"

"io"

"net/http"

"net/url"

"strconv"

"strings"

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

const apiId = "cloudtrace:v1"

const apiName = "cloudtrace"

const apiVersion = "v1"

const basePath = "https://cloudtrace.googleapis.com/"

const basePathTemplate = "https://cloudtrace.UNIVERSE_DOMAIN/"

const mtlsBasePath = "https://cloudtrace.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"

// Write Trace data for a project or application

TraceAppendScope = "https://www.googleapis.com/auth/trace.append"

// Read Trace data for a project or application

TraceReadonlyScope = "https://www.googleapis.com/auth/trace.readonly"

)

// NewService creates a new Service.

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {

}

// 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) {

}

type Service struct {

}

func (s *Service) userAgent() string {

}

func NewProjectsService(s *Service) *ProjectsService {

}

type ProjectsService struct {

}

func NewProjectsTracesService(s *Service) *ProjectsTracesService {

rs := &ProjectsTracesService{s: s}

return rs

}

type ProjectsTracesService struct {

s *Service

}

// Empty: A generic empty message that you can re-use to avoid defining

// duplicated empty messages in your APIs. A typical example is to use it as

// the request or the response type of an API method. For instance: service Foo

// { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type Empty struct {

// ServerResponse contains the HTTP response code and headers from the server.

googleapi.ServerResponse `json:"-"`

}

// ListTracesResponse: The response message for the `ListTraces` method.

type ListTracesResponse struct {

}

func (s *ListTracesResponse) MarshalJSON() ([]byte, error) {

type NoMethod ListTracesResponse

return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)

}

// Trace: A trace describes how long it takes for an application to perform an

// operation. It consists of a set of spans, each of which represent a single

// timed event within the operation.

type Trace struct {

}

func (s *Trace) MarshalJSON() ([]byte, error) {

type NoMethod Trace

return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)

}

// TraceSpan: A span represents a single timed event within a trace. Spans can

// be nested and form a trace tree. Often, a trace contains a root span that

// describes the end-to-end latency of an operation and, optionally, one or

// more subspans for its suboperations. Spans do not need to be contiguous.

// There may be gaps between spans in a trace.

type TraceSpan struct {

}

func (s *TraceSpan) MarshalJSON() ([]byte, error) {

type NoMethod TraceSpan

return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)

}

// Traces: List of new or updated traces.

type Traces struct {

}

func (s *Traces) MarshalJSON() ([]byte, error) {

type NoMethod Traces

return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)

}

type ProjectsPatchTracesCall struct {

}

// PatchTraces: Sends new traces to Cloud Trace or updates existing traces. If

// the ID of a trace that you send matches that of an existing trace, any

// fields in the existing trace and its spans are overwritten by the provided

// values, and any new fields provided are merged with the existing trace data.

// If the ID does not match, a new trace is created.

//

// - projectId: ID of the Cloud project where the trace data is stored.

func (r *ProjectsService) PatchTraces(projectId string, traces *Traces) *ProjectsPatchTracesCall {

}

// Fields allows partial responses to be retrieved. See

// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more

// details.

func (c *ProjectsPatchTracesCall) Fields(s ...googleapi.Field) *ProjectsPatchTracesCall {

c.urlParams_.Set("fields", googleapi.CombineFields(s))

return c

}

// Context sets the context to be used in this call's Do method.

func (c *ProjectsPatchTracesCall) Context(ctx context.Context) *ProjectsPatchTracesCall {

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 *ProjectsPatchTracesCall) Header() http.Header {

}

func (c *ProjectsPatchTracesCall) doRequest(alt string) (*http.Response, error) {

}

// Do executes the "cloudtrace.projects.patchTraces" call.

// Any non-2xx status code is an error. Response headers are in either

// *Empty.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 *ProjectsPatchTracesCall) Do(opts ...googleapi.CallOption) (*Empty, error) {

}

type ProjectsTracesGetCall struct {

}

// Get: Gets a single trace by its ID.

//

// - projectId: ID of the Cloud project where the trace data is stored.

// - traceId: ID of the trace to return.

func (r *ProjectsTracesService) Get(projectId string, traceId string) *ProjectsTracesGetCall {

}

// Fields allows partial responses to be retrieved. See

// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more

// details.

func (c *ProjectsTracesGetCall) Fields(s ...googleapi.Field) *ProjectsTracesGetCall {

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 *ProjectsTracesGetCall) IfNoneMatch(entityTag string) *ProjectsTracesGetCall {

c.ifNoneMatch_ = entityTag

return c

}

// Context sets the context to be used in this call's Do method.

func (c *ProjectsTracesGetCall) Context(ctx context.Context) *ProjectsTracesGetCall {

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 *ProjectsTracesGetCall) Header() http.Header {

}

func (c *ProjectsTracesGetCall) doRequest(alt string) (*http.Response, error) {

}

// Do executes the "cloudtrace.projects.traces.get" call.

// Any non-2xx status code is an error. Response headers are in either

// *Trace.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 *ProjectsTracesGetCall) Do(opts ...googleapi.CallOption) (*Trace, error) {

}

type ProjectsTracesListCall struct {

}

// List: Returns a list of traces that match the specified filter conditions.

//

// - projectId: ID of the Cloud project where the trace data is stored.

func (r *ProjectsTracesService) List(projectId string) *ProjectsTracesListCall {

}

// EndTime sets the optional parameter "endTime": End of the time interval

// (inclusive) during which the trace data was collected from the application.

func (c *ProjectsTracesListCall) EndTime(endTime string) *ProjectsTracesListCall {

c.urlParams_.Set("endTime", endTime)

return c

}

// Filter sets the optional parameter "filter": A filter against labels for the

// request. By default, searches use prefix matching. To specify exact match,

// prepend a plus symbol (`+`) to the search term. Multiple terms are ANDed.

// Syntax: * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root

// span starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces

// where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: Return

// traces where any span starts with `NAME_PREFIX`. * `+span:NAME`: Return

// traces where any span's name is exactly `NAME`. * `latency:DURATION`: Return

// traces whose overall latency is greater or equal to than `DURATION`.

// Accepted units are nanoseconds (`ns`), milliseconds (`ms`), and seconds

// (`s`). Default is `ms`. For example, `latency:24ms` returns traces whose

// overall latency is greater than or equal to 24 milliseconds. *

// `label:LABEL_KEY`: Return all traces containing the specified label key

// (exact match, case-sensitive) regardless of the key:value pair's value

// (including empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces

// containing the specified label key (exact match, case-sensitive) whose value

// starts with `VALUE_PREFIX`. Both a key and a value must be specified. *

// `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly

// matching the specified text. Both a key and a value must be specified. *

// `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`:

// Equivalent to `/http/url:VALUE`.

func (c *ProjectsTracesListCall) Filter(filter string) *ProjectsTracesListCall {

c.urlParams_.Set("filter", filter)

return c

}

// OrderBy sets the optional parameter "orderBy": Field used to sort the

// returned traces. Can be one of the following: * `trace_id` * `name` (`name`

// field of root span in the trace) * `duration` (difference between `end_time`

// and `start_time` fields of the root span) * `start` (`start_time` field of

// the root span) Descending order can be specified by appending `desc` to the

// sort field (for example, `name desc`). Only one sort field is permitted.

func (c *ProjectsTracesListCall) OrderBy(orderBy string) *ProjectsTracesListCall {

c.urlParams_.Set("orderBy", orderBy)

return c

}

// PageSize sets the optional parameter "pageSize": Maximum number of traces to

// return. If not specified or <= 0, the implementation selects a reasonable

// value. The implementation may return fewer traces than the requested page

// size.

func (c *ProjectsTracesListCall) PageSize(pageSize int64) *ProjectsTracesListCall {

c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))

return c

}

// PageToken sets the optional parameter "pageToken": Token identifying the

// page of results to return. If provided, use the value of the

// `next_page_token` field from a previous request.

func (c *ProjectsTracesListCall) PageToken(pageToken string) *ProjectsTracesListCall {

c.urlParams_.Set("pageToken", pageToken)

return c

}

// StartTime sets the optional parameter "startTime": Start of the time

// interval (inclusive) during which the trace data was collected from the

// application.

func (c *ProjectsTracesListCall) StartTime(startTime string) *ProjectsTracesListCall {

c.urlParams_.Set("startTime", startTime)

return c

}

// View sets the optional parameter "view": Type of data returned for traces in

// the list. Default is `MINIMAL`.

//

// Possible values:

//

// "VIEW_TYPE_UNSPECIFIED" - Default is `MINIMAL` if unspecified.

// "MINIMAL" - Minimal view of the trace record that contains only the

//

// project and trace IDs.

//

// "ROOTSPAN" - Root span view of the trace record that returns the root

//

// spans along with the minimal trace data.

//

// "COMPLETE" - Complete view of the trace record that contains the actual

//

// trace data. This is equivalent to calling the REST `get` or RPC `GetTrace`

// method using the ID of each listed trace.

func (c *ProjectsTracesListCall) View(view string) *ProjectsTracesListCall {

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 *ProjectsTracesListCall) Fields(s ...googleapi.Field) *ProjectsTracesListCall {

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 *ProjectsTracesListCall) IfNoneMatch(entityTag string) *ProjectsTracesListCall {

c.ifNoneMatch_ = entityTag

return c

}

// Context sets the context to be used in this call's Do method.

func (c *ProjectsTracesListCall) Context(ctx context.Context) *ProjectsTracesListCall {

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 *ProjectsTracesListCall) Header() http.Header {

}

func (c *ProjectsTracesListCall) doRequest(alt string) (*http.Response, error) {

}

// Do executes the "cloudtrace.projects.traces.list" call.

// Any non-2xx status code is an error. Response headers are in either

// *ListTracesResponse.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 *ProjectsTracesListCall) Do(opts ...googleapi.CallOption) (*ListTracesResponse, error) {

}

// 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 *ProjectsTracesListCall) Pages(ctx context.Context, f func(*ListTracesResponse) error) error {

}