class Google::Apis::CloudlatencytestV2::CloudlatencytestService

Google Cloud Network Performance Monitoring API

Reports latency data.

@example

require 'google/apis/cloudlatencytest_v2'

Cloudlatencytest = Google::Apis::CloudlatencytestV2 # Alias the module
service = Cloudlatencytest::CloudlatencytestService.new

@see

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.
Overrides userIp if both are provided.
user_ip[RW]

@return [String]

IP address of the site where the request originates. Use this if you want to
enforce per-user limits.

Public Class Methods

new() click to toggle source
Calls superclass method Google::Apis::Core::BaseService.new
# File generated/google/apis/cloudlatencytest_v2/service.rb, line 51
def initialize
  super('https://cloudlatencytest-pa.googleapis.com/', 'v2/statscollection/')
end

Public Instance Methods

update_aggregated_stats(aggregated_stats_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

RPC to update the new TCP stats. @param [Google::Apis::CloudlatencytestV2::AggregatedStats] aggregated_stats_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] #quota_user

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.
Overrides userIp if both are provided.

@param [String] #user_ip

IP address of the site where the request originates. Use this if you want to
enforce per-user limits.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudlatencytestV2::AggregatedStatsReply] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudlatencytestV2::AggregatedStatsReply]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File generated/google/apis/cloudlatencytest_v2/service.rb, line 78
def update_aggregated_stats(aggregated_stats_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'updateaggregatedstats', options)
  command.request_representation = Google::Apis::CloudlatencytestV2::AggregatedStats::Representation
  command.request_object = aggregated_stats_object
  command.response_representation = Google::Apis::CloudlatencytestV2::AggregatedStatsReply::Representation
  command.response_class = Google::Apis::CloudlatencytestV2::AggregatedStatsReply
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end
update_stats(stats_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

RPC to update the new TCP stats. @param [Google::Apis::CloudlatencytestV2::Stats] stats_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] #quota_user

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.
Overrides userIp if both are provided.

@param [String] #user_ip

IP address of the site where the request originates. Use this if you want to
enforce per-user limits.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::CloudlatencytestV2::StatsReply] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::CloudlatencytestV2::StatsReply]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File generated/google/apis/cloudlatencytest_v2/service.rb, line 113
def update_stats(stats_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'updatestats', options)
  command.request_representation = Google::Apis::CloudlatencytestV2::Stats::Representation
  command.request_object = stats_object
  command.response_representation = Google::Apis::CloudlatencytestV2::StatsReply::Representation
  command.response_class = Google::Apis::CloudlatencytestV2::StatsReply
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File generated/google/apis/cloudlatencytest_v2/service.rb, line 127
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
end