Class: Google::Apis::CloudtraceV2beta1::CloudTraceService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/cloudtrace_v2beta1/service.rb

Overview

Cloud Trace API

Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry.

Examples:

require 'google/apis/cloudtrace_v2beta1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://cloudtrace.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudTraceService

Returns a new instance of CloudTraceService.



51
52
53
54
55
56
 
# File 'lib/google/apis/cloudtrace_v2beta1/service.rb', line 51

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-cloudtrace_v2beta1',
        client_version: Google::Apis::CloudtraceV2beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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.



44
45
46
 
# File 'lib/google/apis/cloudtrace_v2beta1/service.rb', line 44

def key
  @key
end

#quota_user ⇒ String

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.



49
50
51
 
# File 'lib/google/apis/cloudtrace_v2beta1/service.rb', line 49

def quota_user
  @quota_user
end

Instance Method Details

#create_project_trace_sink(parent, trace_sink_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::TraceSink

Creates a sink that exports trace spans to a destination. The export of newly- ingested traces begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export traces only from the resource owning the sink (the 'parent').

Parameters:

  • parent (String) —

    Required. The resource in which to create the sink (currently only project sinks are supported): "projects/[PROJECT_ID]" Examples: "projects/my-trace- project", "projects/123456789".

  • trace_sink_object (Google::Apis::CloudtraceV2beta1::TraceSink) (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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/google/apis/cloudtrace_v2beta1/service.rb', line 84

def create_project_trace_sink(parent, trace_sink_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/traceSinks', options)
  command.request_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.request_object = trace_sink_object
  command.response_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::TraceSink
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_trace_sink(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::Empty

Deletes a sink.

Parameters:

  • name (String) —

    Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_NUMBER]/traceSinks/[ SINK_ID]" Example: "projects/12345/traceSinks/my-sink-id".

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



118
119
120
121
122
123
124
125
126
 
# File 'lib/google/apis/cloudtrace_v2beta1/service.rb', line 118

def delete_project_trace_sink(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudtraceV2beta1::Empty::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_trace_sink(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::TraceSink

Get a trace sink by name under the parent resource (GCP project).

Parameters:

  • name (String) —

    Required. The resource name of the sink: "projects/[PROJECT_NUMBER]/traceSinks/ [SINK_ID]" Example: "projects/12345/traceSinks/my-sink-id".

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



149
150
151
152
153
154
155
156
157
 
# File 'lib/google/apis/cloudtrace_v2beta1/service.rb', line 149

def get_project_trace_sink(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::TraceSink
  command.params['name'] = name unless name.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_trace_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::ListTraceSinksResponse

List all sinks for the parent resource (GCP project).

Parameters:

  • parent (String) —

    Required. The parent resource whose sinks are to be listed (currently only project parent resources are supported): "projects/[PROJECT_ID]"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of results to return from this request. Non- positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.

  • page_token (String) (defaults to: nil) —

    Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/google/apis/cloudtrace_v2beta1/service.rb', line 189

def list_project_trace_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+parent}/traceSinks', options)
  command.response_representation = Google::Apis::CloudtraceV2beta1::ListTraceSinksResponse::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::ListTraceSinksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.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_trace_sink(name, trace_sink_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::TraceSink

Updates a sink. This method updates fields in the existing sink according to the provided update mask. The sink's name cannot be changed nor any output- only fields (e.g. the writer_identity).

Parameters:

  • name (String) —

    Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_NUMBER]/traceSinks/[ SINK_ID]" Example: "projects/12345/traceSinks/my-sink-id".

  • trace_sink_object (Google::Apis::CloudtraceV2beta1::TraceSink) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. Field mask that specifies the fields in trace_sink that are to be updated. A sink field is overwritten if, and only if, it is in the update mask. name and writer_identity fields cannot be updated. An empty update_mask is considered an error. For a detailed FieldMask definition, see https:// developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask Example: updateMask=output_config.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/google/apis/cloudtrace_v2beta1/service.rb', line 233

def patch_project_trace_sink(name, trace_sink_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.request_object = trace_sink_object
  command.response_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::TraceSink
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end