cloudtrace

package
v2.3.0-rc.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 21, 2016 License: BSD-3-Clause, Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package cloudtrace provides access to the Google Cloud Trace API.

See https://cloud.google.com/tools/cloud-trace

Usage example: 

import "google.golang.org/api/cloudtrace/v1"
...
cloudtraceService, err := cloudtrace.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

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); } The JSON representation for `Empty` is empty JSON object `{}`.

type ListTracesResponse 

type ListTracesResponse struct {
	// NextPageToken: If defined, indicates that there are more topics that
	// match the request, and this value should be passed to the next
	// ListTopicsRequest to continue.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Traces: The list of trace records returned.
	Traces []*Trace `json:"traces,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ListTracesResponse: The response message for the ListTraces method.

func (*ListTracesResponse) MarshalJSON 

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

type ProjectsPatchTracesCall 

type ProjectsPatchTracesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchTracesCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPatchTracesCall) Do 

func (c *ProjectsPatchTracesCall) Do() (*Empty, error)

Do executes the "cloudtrace.projects.patchTraces" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsPatchTracesCall) Fields 

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

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsService 

type ProjectsService struct {
	Traces *ProjectsTracesService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) PatchTraces 

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

PatchTraces: Updates the existing traces specified by PatchTracesRequest and inserts the new traces. Any existing trace or span fields included in an update are overwritten by the update, and any additional fields in an update are merged with the existing trace data.

type ProjectsTracesGetCall 

type ProjectsTracesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsTracesGetCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsTracesGetCall) Do 

func (c *ProjectsTracesGetCall) Do() (*Trace, error)

Do executes the "cloudtrace.projects.traces.get" call. Exactly one of *Trace or error will be non-nil. 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 (*ProjectsTracesGetCall) Fields 

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

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsTracesGetCall) IfNoneMatch 

func (c *ProjectsTracesGetCall) IfNoneMatch(entityTag string) *ProjectsTracesGetCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsTracesListCall 

type ProjectsTracesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsTracesListCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsTracesListCall) Do 

func (c *ProjectsTracesListCall) Do() (*ListTracesResponse, error)

Do executes the "cloudtrace.projects.traces.list" call. Exactly one of *ListTracesResponse or error will be non-nil. 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 (*ProjectsTracesListCall) EndTime 

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

EndTime sets the optional parameter "endTime": Start of the time interval (exclusive).

func (*ProjectsTracesListCall) Fields 

func (c *ProjectsTracesListCall) Fields(s ...googleapi.Field) *ProjectsTracesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsTracesListCall) Filter 

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

Filter sets the optional parameter "filter": An optional filter for the request.

func (*ProjectsTracesListCall) IfNoneMatch 

func (c *ProjectsTracesListCall) IfNoneMatch(entityTag string) *ProjectsTracesListCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsTracesListCall) OrderBy 

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

OrderBy sets the optional parameter "orderBy": The trace field used to establish the order of traces returned by the ListTraces method. Possible options are: trace_id name (name field of root span) duration (different between end_time and start_time fields of root span) start (start_time field of root span) Descending order can be specified by appending "desc" to the sort field: name desc Only one sort field is permitted, though this may change in the future.

func (*ProjectsTracesListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Maximum number of topics to return. If not specified or <= 0, the implementation will select a reasonable value. The implemenation may always return fewer than the requested page_size.

func (*ProjectsTracesListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The token identifying the page of results to return from the ListTraces method. If present, this value is should be taken from the next_page_token field of a previous ListTracesResponse.

func (*ProjectsTracesListCall) StartTime 

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

StartTime sets the optional parameter "startTime": End of the time interval (inclusive).

func (*ProjectsTracesListCall) View 

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

View sets the optional parameter "view": ViewType specifies the projection of the result.

Possible values: 

"VIEW_TYPE_UNSPECIFIED"
"MINIMAL"
"ROOTSPAN"
"COMPLETE"

type ProjectsTracesService 

type ProjectsTracesService struct {
	// contains filtered or unexported fields
}

func NewProjectsTracesService 

func NewProjectsTracesService(s *Service) *ProjectsTracesService

func (*ProjectsTracesService) Get 

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

Get: Gets one trace by id.

func (*ProjectsTracesService) List 

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

List: List traces matching the filter expression.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService

	V1 *V1Service
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

type Trace 

type Trace struct {
	// ProjectId: The Project ID of the Google Cloud project.
	ProjectId string `json:"projectId,omitempty"`

	// Spans: The collection of span records within this trace. Spans that
	// appear in calls to PatchTraces may be incomplete or partial.
	Spans []*TraceSpan `json:"spans,omitempty"`

	// TraceId: A 128-bit numeric value, formatted as a 32-byte hex string,
	// that represents a trace. Each trace should have an identifier that is
	// globally unique.
	TraceId string `json:"traceId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ProjectId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Trace: A Trace is a collection of spans describing the execution timings of a single operation.

func (*Trace) MarshalJSON 

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

type TraceSpan 

type TraceSpan struct {
	// EndTime: The end time of the span in nanoseconds from the UNIX epoch.
	EndTime string `json:"endTime,omitempty"`

	// Kind: SpanKind distinguishes spans generated in a particular context.
	// For example, two spans with the same name, one with the kind
	// RPC_CLIENT, and the other with RPC_SERVER can indicate the queueing
	// latency associated with the span.
	//
	// Possible values:
	//   "SPAN_KIND_UNSPECIFIED"
	//   "RPC_SERVER"
	//   "RPC_CLIENT"
	Kind string `json:"kind,omitempty"`

	// Labels: Annotations via labels.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: The name of the trace. This is sanitized and displayed on the
	// UI. This may be a method name or some other per-callsite name. For
	// the same binary and the same call point, it is a good practice to
	// choose a consistent name in order to correlate cross-trace spans.
	Name string `json:"name,omitempty"`

	// ParentSpanId: Identifies the parent of the current span. May be
	// missing. Serialized bytes representation of SpanId.
	ParentSpanId uint64 `json:"parentSpanId,omitempty,string"`

	// SpanId: Identifier of the span within the trace. Each span should
	// have an identifier that is unique per trace.
	SpanId uint64 `json:"spanId,omitempty,string"`

	// StartTime: The start time of the span in nanoseconds from the UNIX
	// epoch.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

TraceSpan: A span is the data recorded with a single span.

func (*TraceSpan) MarshalJSON 

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

type Traces 

type Traces struct {
	// Traces: A list of traces.
	Traces []*Trace `json:"traces,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Traces") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Traces: A list of traces for the PatchTraces method.

func (*Traces) MarshalJSON 

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

type V1GetDiscoveryCall 

type V1GetDiscoveryCall struct {
	// contains filtered or unexported fields
}

func (*V1GetDiscoveryCall) Args 

func (c *V1GetDiscoveryCall) Args(args string) *V1GetDiscoveryCall

Args sets the optional parameter "args": Any additional arguments.

func (*V1GetDiscoveryCall) Context 

func (c *V1GetDiscoveryCall) Context(ctx context.Context) *V1GetDiscoveryCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1GetDiscoveryCall) Do 

func (c *V1GetDiscoveryCall) Do() error

Do executes the "cloudtrace.getDiscovery" call.

func (*V1GetDiscoveryCall) Fields 

func (c *V1GetDiscoveryCall) Fields(s ...googleapi.Field) *V1GetDiscoveryCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1GetDiscoveryCall) Format 

func (c *V1GetDiscoveryCall) Format(format string) *V1GetDiscoveryCall

Format sets the optional parameter "format": The format requested for discovery.

func (*V1GetDiscoveryCall) IfNoneMatch 

func (c *V1GetDiscoveryCall) IfNoneMatch(entityTag string) *V1GetDiscoveryCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*V1GetDiscoveryCall) Labels 

func (c *V1GetDiscoveryCall) Labels(labels string) *V1GetDiscoveryCall

Labels sets the optional parameter "labels": A list of labels (like visibility) influencing the scope of the requested doc.

func (*V1GetDiscoveryCall) Version 

func (c *V1GetDiscoveryCall) Version(version string) *V1GetDiscoveryCall

Version sets the optional parameter "version": The API version of the requested discovery doc.

type V1Service 

type V1Service struct {
	// contains filtered or unexported fields
}

func NewV1Service 

func NewV1Service(s *Service) *V1Service

func (*V1Service) GetDiscovery 

func (r *V1Service) GetDiscovery() *V1GetDiscoveryCall

GetDiscovery: Returns a discovery document in the specified `format`. The typeurl in the returned google.protobuf.Any value depends on the requested format.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.