Class: Google::Apis::CloudtraceV1::CloudTraceService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudtrace_v1/service.rb

Overview

Google Cloud Trace API

Send and retrieve trace data from Google Cloud Trace. Data is generated and available by default for all App Engine applications. Data from other applications can be written to Cloud Trace for display, reporting, and analysis.

Examples:

require 'google/apis/cloudtrace_v1'

Cloudtrace = Google::Apis::CloudtraceV1 # Alias the module
service = Cloudtrace::CloudTraceService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeCloudTraceService

Returns a new instance of CloudTraceService.


48
49
50
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 48

def initialize
  super('https://cloudtrace.googleapis.com/', '')
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


41
42
43
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 41

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


46
47
48
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#get_project_trace(project_id, trace_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV1::Trace

Gets a single trace by its ID.

Parameters:

  • project_id (String)

    ID of the Cloud project where the trace data is stored.

  • trace_id (String)

    ID of the trace to return.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


172
173
174
175
176
177
178
179
180
181
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 172

def get_project_trace(project_id, trace_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/traces/{traceId}', options)
  command.response_representation = Google::Apis::CloudtraceV1::Trace::Representation
  command.response_class = Google::Apis::CloudtraceV1::Trace
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['traceId'] = trace_id unless trace_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_traces(project_id, view: nil, page_size: nil, page_token: nil, start_time: nil, end_time: nil, filter: nil, order_by: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV1::ListTracesResponse

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

Parameters:

  • project_id (String)

    ID of the Cloud project where the trace data is stored.

  • view (String) (defaults to: nil)

    Type of data returned for traces in the list. Optional. Default is MINIMAL.

  • page_size (Fixnum) (defaults to: nil)

    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. Optional.

  • page_token (String) (defaults to: nil)

    Token identifying the page of results to return. If provided, use the value of the next_page_token field from a previous request. Optional.

  • start_time (String) (defaults to: nil)

    End of the time interval (inclusive) during which the trace data was collected from the application.

  • end_time (String) (defaults to: nil)

    Start of the time interval (inclusive) during which the trace data was collected from the application.

  • filter (String) (defaults to: nil)

    An optional filter for the request.

  • order_by (String) (defaults to: nil)

    Field used to sort the returned traces. Optional. 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.
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 133

def list_project_traces(project_id, view: nil, page_size: nil, page_token: nil, start_time: nil, end_time: nil, filter: nil, order_by: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}/traces', options)
  command.response_representation = Google::Apis::CloudtraceV1::ListTracesResponse::Representation
  command.response_class = Google::Apis::CloudtraceV1::ListTracesResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['view'] = view unless view.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startTime'] = start_time unless start_time.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_traces(project_id, traces_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV1::Empty

Sends new traces to Stackdriver 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.

Parameters:

  • project_id (String)

    ID of the Cloud project where the trace data is stored.

  • traces_object (Google::Apis::CloudtraceV1::Traces) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


77
78
79
80
81
82
83
84
85
86
87
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 77

def patch_project_traces(project_id, traces_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/projects/{projectId}/traces', options)
  command.request_representation = Google::Apis::CloudtraceV1::Traces::Representation
  command.request_object = traces_object
  command.response_representation = Google::Apis::CloudtraceV1::Empty::Representation
  command.response_class = Google::Apis::CloudtraceV1::Empty
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end