Class: Google::Apis::CloudlatencytestV2::CloudlatencytestService

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

Overview

Google Cloud Network Performance Monitoring API

Reports latency data.

Examples:

require 'google/apis/cloudlatencytest_v2'

Cloudlatencytest = Google::Apis::CloudlatencytestV2 # Alias the module
service = Cloudlatencytest::CloudlatencytestService.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

#initializeCloudlatencytestService

Returns a new instance of CloudlatencytestService.


51
52
53
# File 'generated/google/apis/cloudlatencytest_v2/service.rb', line 51

def initialize
  super('https://cloudlatencytest-pa.googleapis.com/', 'v2/statscollection/')
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.


38
39
40
# File 'generated/google/apis/cloudlatencytest_v2/service.rb', line 38

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

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


44
45
46
# File 'generated/google/apis/cloudlatencytest_v2/service.rb', line 44

def quota_user
  @quota_user
end

#user_ipString

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

Returns:

  • (String)

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


49
50
51
# File 'generated/google/apis/cloudlatencytest_v2/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#update_aggregated_stats(aggregated_stats_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudlatencytestV2::AggregatedStatsReply

RPC to update the new TCP stats.

Parameters:

  • aggregated_stats_object (Google::Apis::CloudlatencytestV2::AggregatedStats) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


78
79
80
81
82
83
84
85
86
87
88
# 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) {|result, err| ... } ⇒ Google::Apis::CloudlatencytestV2::StatsReply

RPC to update the new TCP stats.

Parameters:

  • stats_object (Google::Apis::CloudlatencytestV2::Stats) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


113
114
115
116
117
118
119
120
121
122
123
# 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