Cloud Channel V1 API - Class Google::Cloud::Channel::V1::CloudChannelReportsService::Client (v0.16.0)

Reference documentation and code samples for the Cloud Channel V1 API class Google::Cloud::Channel::V1::CloudChannelReportsService::Client.

Client for the CloudChannelReportsService service.

CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud Platform (GCP), Google Voice, and Google Workspace.)

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the CloudChannelReportsService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all CloudChannelReportsService clients
::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the CloudChannelReportsService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#fetch_report_results

def fetch_report_results(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Row>
def fetch_report_results(report_job: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Row>

Retrieves data generated by CloudChannelReportsService.RunReportJob.

Overloads 
def fetch_report_results(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Row>
Pass arguments to fetch_report_results via a request object, either of type FetchReportResultsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Channel::V1::FetchReportResultsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def fetch_report_results(report_job: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Row>
Pass arguments to fetch_report_results via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • report_job (::String) — Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
  • page_size (::Integer) — Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time).

    The maximum value is 30,000; the server will change larger values to 30,000.

  • page_token (::String) — Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/channel/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Channel::V1::FetchReportResultsRequest.new

# Call the fetch_report_results method.
result = client.fetch_report_results request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Channel::V1::Row.
  p item
end

#initialize

def initialize() { |config| ... } -> Client

Create a new CloudChannelReportsService client object.

Yields
  • (config) — Configure the CloudChannelReportsService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new do |config|
  config.timeout = 10.0
end

#list_reports

def list_reports(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Report>
def list_reports(parent: nil, page_size: nil, page_token: nil, language_code: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Report>

Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result.

Overloads 
def list_reports(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Report>
Pass arguments to list_reports via a request object, either of type ListReportsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Channel::V1::ListReportsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_reports(parent: nil, page_size: nil, page_token: nil, language_code: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Report>
Pass arguments to list_reports via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}
  • page_size (::Integer) — Optional. Requested page size of the report. The server might return fewer results than requested. If unspecified, returns 20 reports. The maximum value is 100.
  • page_token (::String) — Optional. A token that specifies a page of results beyond the first page. Obtained through ListReportsResponse.next_page_token of the previous CloudChannelReportsService.ListReports call.
  • language_code (::String) — Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/channel/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Channel::V1::ListReportsRequest.new

# Call the list_reports method.
result = client.list_reports request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Channel::V1::Report.
  p item
end

#operations_client

def operations_client() -> ::Google::Cloud::Channel::V1::CloudChannelReportsService::Operations

Get the associated client for long-running operations.

Returns

#run_report_job

def run_report_job(request, options = nil) -> ::Gapic::Operation
def run_report_job(name: nil, date_range: nil, filter: nil, language_code: nil) -> ::Gapic::Operation

Begins generation of data for a given report. The report identifier is a UID (for example, 613bf59q).

Possible error codes:

  • PERMISSION_DENIED: The user doesn't have access to this report.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • NOT_FOUND: The report identifier was not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.

To get the results of report generation, call CloudChannelReportsService.FetchReportResults with the RunReportJobResponse.report_job.

Overloads 
def run_report_job(request, options = nil) -> ::Gapic::Operation
Pass arguments to run_report_job via a request object, either of type RunReportJobRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Channel::V1::RunReportJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def run_report_job(name: nil, date_range: nil, filter: nil, language_code: nil) -> ::Gapic::Operation
Pass arguments to run_report_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}
  • date_range (::Google::Cloud::Channel::V1::DateRange, ::Hash) — Optional. The range of usage or invoice dates to include in the result.
  • filter (::String) — Optional. A structured string that defines conditions on dimension columns to restrict the report output.

    Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys.

    For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

  • language_code (::String) — Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/channel/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Channel::V1::RunReportJobRequest.new

# Call the run_report_job method.
result = client.run_report_job request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end