Class: Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::ServiceStub Deprecated

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb

Overview

Deprecated.

This service is deprecated and may be removed in the next major version update.

REST service stub for the CloudChannelReportsService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Instance Method Summary collapse

Constructor Details

#initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) ⇒ ServiceStub

Returns a new instance of ServiceStub.



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb', line 34

def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
  # These require statements are intentionally placed here to initialize
  # the REST modules only when it's required.
  require "gapic/rest"

  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
                                               endpoint_template: endpoint_template,
                                               universe_domain: universe_domain,
                                               credentials: credentials,
                                               numeric_enums: true,
                                               raise_faraday_errors: false
end

Instance Method Details

#endpoint ⇒ String

The effective endpoint

Returns:

  • (String) 


61
62
63
 
# File 'lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb', line 61

def endpoint
  @client_stub.endpoint
end

#fetch_report_results(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Channel::V1::FetchReportResultsResponse

Baseline implementation for the fetch_report_results REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb', line 117

def fetch_report_results request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_fetch_report_results_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Channel::V1::FetchReportResultsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_reports(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Channel::V1::ListReportsResponse

Baseline implementation for the list_reports REST call

Parameters:

  • request_pb (::Google::Cloud::Channel::V1::ListReportsRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb', line 155

def list_reports request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_reports_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Channel::V1::ListReportsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#run_report_job(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the run_report_job REST call

Parameters:

  • request_pb (::Google::Cloud::Channel::V1::RunReportJobRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb', line 79

def run_report_job request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_run_report_job_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


52
53
54
 
# File 'lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb', line 52

def universe_domain
  @client_stub.universe_domain
end