CloudChannelReportsServiceClient

CloudChannelReportsServiceClient

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

Deprecated: This service is being deprecated. Please use Export Channel Services data to BigQuery instead.

Constructor

new CloudChannelReportsServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of CloudChannelReportsServiceClient.

Deprecated: CloudChannelReportsService is deprecated and may be removed in a future version.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.

fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new CloudChannelReportsServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

billingAccountPath(account, billing_account) → {string}

Return a fully-qualified billingAccount resource name string.

Parameters:
Name Type Description
account string
billing_account string
Returns:
Type Description
string

Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

channelPartnerLinkPath(account, channel_partner_link) → {string}

Return a fully-qualified channelPartnerLink resource name string.

Parameters:
Name Type Description
account string
channel_partner_link string
Returns:
Type Description
string

Resource name string.

channelPartnerRepricingConfigPath(account, channel_partner, channel_partner_repricing_config) → {string}

Return a fully-qualified channelPartnerRepricingConfig resource name string.

Parameters:
Name Type Description
account string
channel_partner string
channel_partner_repricing_config string
Returns:
Type Description
string

Resource name string.

(async) checkRunReportJobProgress(name) → {Promise}

Check the status of the long running operation returned by runReportJob().

Deprecated: RunReportJob is deprecated and may be removed in a future version.

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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}
   */
  // const name = 'abc123'
  /**
   *  Optional. The range of usage or invoice dates to include in the result.
   */
  // const dateRange = {}
  /**
   *  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`
   */
  // const filter = 'abc123'
  /**
   *  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".
   */
  // const languageCode = 'abc123'

  // Imports the Channel library
  const {CloudChannelReportsServiceClient} = require('@google-cloud/channel').v1;

  // Instantiates a client
  const channelClient = new CloudChannelReportsServiceClient();

  async function callRunReportJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await channelClient.runReportJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunReportJob();

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

customerPath(account, customer) → {string}

Return a fully-qualified customer resource name string.

Parameters:
Name Type Description
account string
customer string
Returns:
Type Description
string

Resource name string.

customerRepricingConfigPath(account, customer, customer_repricing_config) → {string}

Return a fully-qualified customerRepricingConfig resource name string.

Parameters:
Name Type Description
account string
customer string
customer_repricing_config string
Returns:
Type Description
string

Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

entitlementPath(account, customer, entitlement) → {string}

Return a fully-qualified entitlement resource name string.

Parameters:
Name Type Description
account string
customer string
entitlement string
Returns:
Type Description
string

Resource name string.

fetchReportResultsAsync(request, optionsopt) → {Object}

Equivalent to fetchReportResults, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Deprecated: FetchReportResults is deprecated and may be removed in a future version.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
reportJob string

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

pageSize number <optional>

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.

pageToken string <optional>

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.

partitionKeys Array.<string> <optional>

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Row. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The report job created by
   *  CloudChannelReportsService.RunReportJob google.cloud.channel.v1.CloudChannelReportsService.RunReportJob.
   *  Report_job uses the format:
   *  accounts/{account_id}/reportJobs/{report_job_id}
   */
  // const reportJob = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token that specifies a page of results beyond the first page.
   *  Obtained through
   *  FetchReportResultsResponse.next_page_token google.cloud.channel.v1.FetchReportResultsResponse.next_page_token 
   *  of the previous
   *  CloudChannelReportsService.FetchReportResults google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. List of keys specifying which report partitions to return.
   *  If empty, returns all partitions.
   */
  // const partitionKeys = ['abc','def']

  // Imports the Channel library
  const {CloudChannelReportsServiceClient} = require('@google-cloud/channel').v1;

  // Instantiates a client
  const channelClient = new CloudChannelReportsServiceClient();

  async function callFetchReportResults() {
    // Construct request
    const request = {
      reportJob,
    };

    // Run request
    const iterable = await channelClient.fetchReportResultsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callFetchReportResults();

fetchReportResultsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Deprecated: FetchReportResults is deprecated and may be removed in a future version.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
reportJob string

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

pageSize number <optional>

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.

pageToken string <optional>

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.

partitionKeys Array.<string> <optional>

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing Row on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using fetchReportResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.

filter string

The standard list filter.

pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.

Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

listReportsAsync(request, optionsopt) → {Object}

Equivalent to listReports, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Deprecated: ListReports is deprecated and may be removed in a future version.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}

pageSize number <optional>

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.

pageToken string <optional>

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.

languageCode string <optional>

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".

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Report. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the partner account to list available
   *  reports for. Parent uses the format: accounts/{account_id}
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token that specifies a page of results beyond the first page.
   *  Obtained through
   *  ListReportsResponse.next_page_token google.cloud.channel.v1.ListReportsResponse.next_page_token 
   *  of the previous
   *  CloudChannelReportsService.ListReports google.cloud.channel.v1.CloudChannelReportsService.ListReports 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  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".
   */
  // const languageCode = 'abc123'

  // Imports the Channel library
  const {CloudChannelReportsServiceClient} = require('@google-cloud/channel').v1;

  // Instantiates a client
  const channelClient = new CloudChannelReportsServiceClient();

  async function callListReports() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await channelClient.listReportsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListReports();

listReportsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Deprecated: ListReports is deprecated and may be removed in a future version.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}

pageSize number <optional>

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.

pageToken string <optional>

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.

languageCode string <optional>

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".

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing Report on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listReportsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAccountFromBillingAccountName(billingAccountName) → {string}

Parse the account from BillingAccount resource.

Parameters:
Name Type Description
billingAccountName string

A fully-qualified path representing BillingAccount resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromChannelPartnerLinkName(channelPartnerLinkName) → {string}

Parse the account from ChannelPartnerLink resource.

Parameters:
Name Type Description
channelPartnerLinkName string

A fully-qualified path representing ChannelPartnerLink resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName) → {string}

Parse the account from ChannelPartnerRepricingConfig resource.

Parameters:
Name Type Description
channelPartnerRepricingConfigName string

A fully-qualified path representing ChannelPartnerRepricingConfig resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromCustomerName(customerName) → {string}

Parse the account from Customer resource.

Parameters:
Name Type Description
customerName string

A fully-qualified path representing Customer resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromCustomerRepricingConfigName(customerRepricingConfigName) → {string}

Parse the account from CustomerRepricingConfig resource.

Parameters:
Name Type Description
customerRepricingConfigName string

A fully-qualified path representing CustomerRepricingConfig resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromEntitlementName(entitlementName) → {string}

Parse the account from Entitlement resource.

Parameters:
Name Type Description
entitlementName string

A fully-qualified path representing Entitlement resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromOfferName(offerName) → {string}

Parse the account from Offer resource.

Parameters:
Name Type Description
offerName string

A fully-qualified path representing Offer resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromReportJobName(reportJobName) → {string}

Parse the account from ReportJob resource.

Parameters:
Name Type Description
reportJobName string

A fully-qualified path representing ReportJob resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromReportName(reportName) → {string}

Parse the account from Report resource.

Parameters:
Name Type Description
reportName string

A fully-qualified path representing Report resource.

Returns:
Type Description
string

A string representing the account.

matchAccountFromSkuGroupName(skuGroupName) → {string}

Parse the account from SkuGroup resource.

Parameters:
Name Type Description
skuGroupName string

A fully-qualified path representing SkuGroup resource.

Returns:
Type Description
string

A string representing the account.

matchBillingAccountFromBillingAccountName(billingAccountName) → {string}

Parse the billing_account from BillingAccount resource.

Parameters:
Name Type Description
billingAccountName string

A fully-qualified path representing BillingAccount resource.

Returns:
Type Description
string

A string representing the billing_account.

matchChannelPartnerFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName) → {string}

Parse the channel_partner from ChannelPartnerRepricingConfig resource.

Parameters:
Name Type Description
channelPartnerRepricingConfigName string

A fully-qualified path representing ChannelPartnerRepricingConfig resource.

Returns:
Type Description
string

A string representing the channel_partner.

matchChannelPartnerLinkFromChannelPartnerLinkName(channelPartnerLinkName) → {string}

Parse the channel_partner_link from ChannelPartnerLink resource.

Parameters:
Name Type Description
channelPartnerLinkName string

A fully-qualified path representing ChannelPartnerLink resource.

Returns:
Type Description
string

A string representing the channel_partner_link.

matchChannelPartnerRepricingConfigFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName) → {string}

Parse the channel_partner_repricing_config from ChannelPartnerRepricingConfig resource.

Parameters:
Name Type Description
channelPartnerRepricingConfigName string

A fully-qualified path representing ChannelPartnerRepricingConfig resource.

Returns:
Type Description
string

A string representing the channel_partner_repricing_config.

matchCustomerFromCustomerName(customerName) → {string}

Parse the customer from Customer resource.

Parameters:
Name Type Description
customerName string

A fully-qualified path representing Customer resource.

Returns:
Type Description
string

A string representing the customer.

matchCustomerFromCustomerRepricingConfigName(customerRepricingConfigName) → {string}

Parse the customer from CustomerRepricingConfig resource.

Parameters:
Name Type Description
customerRepricingConfigName string

A fully-qualified path representing CustomerRepricingConfig resource.

Returns:
Type Description
string

A string representing the customer.

matchCustomerFromEntitlementName(entitlementName) → {string}

Parse the customer from Entitlement resource.

Parameters:
Name Type Description
entitlementName string

A fully-qualified path representing Entitlement resource.

Returns:
Type Description
string

A string representing the customer.

matchCustomerRepricingConfigFromCustomerRepricingConfigName(customerRepricingConfigName) → {string}

Parse the customer_repricing_config from CustomerRepricingConfig resource.

Parameters:
Name Type Description
customerRepricingConfigName string

A fully-qualified path representing CustomerRepricingConfig resource.

Returns:
Type Description
string

A string representing the customer_repricing_config.

matchEntitlementFromEntitlementName(entitlementName) → {string}

Parse the entitlement from Entitlement resource.

Parameters:
Name Type Description
entitlementName string

A fully-qualified path representing Entitlement resource.

Returns:
Type Description
string

A string representing the entitlement.

matchOfferFromOfferName(offerName) → {string}

Parse the offer from Offer resource.

Parameters:
Name Type Description
offerName string

A fully-qualified path representing Offer resource.

Returns:
Type Description
string

A string representing the offer.

matchProductFromProductName(productName) → {string}

Parse the product from Product resource.

Parameters:
Name Type Description
productName string

A fully-qualified path representing Product resource.

Returns:
Type Description
string

A string representing the product.

matchProductFromSkuName(skuName) → {string}

Parse the product from Sku resource.

Parameters:
Name Type Description
skuName string

A fully-qualified path representing Sku resource.

Returns:
Type Description
string

A string representing the product.

matchReportFromReportName(reportName) → {string}

Parse the report from Report resource.

Parameters:
Name Type Description
reportName string

A fully-qualified path representing Report resource.

Returns:
Type Description
string

A string representing the report.

matchReportJobFromReportJobName(reportJobName) → {string}

Parse the report_job from ReportJob resource.

Parameters:
Name Type Description
reportJobName string

A fully-qualified path representing ReportJob resource.

Returns:
Type Description
string

A string representing the report_job.

matchSkuFromSkuName(skuName) → {string}

Parse the sku from Sku resource.

Parameters:
Name Type Description
skuName string

A fully-qualified path representing Sku resource.

Returns:
Type Description
string

A string representing the sku.

matchSkuGroupFromSkuGroupName(skuGroupName) → {string}

Parse the sku_group from SkuGroup resource.

Parameters:
Name Type Description
skuGroupName string

A fully-qualified path representing SkuGroup resource.

Returns:
Type Description
string

A string representing the sku_group.

offerPath(account, offer) → {string}

Return a fully-qualified offer resource name string.

Parameters:
Name Type Description
account string
offer string
Returns:
Type Description
string

Resource name string.

productPath(product) → {string}

Return a fully-qualified product resource name string.

Parameters:
Name Type Description
product string
Returns:
Type Description
string

Resource name string.

reportJobPath(account, report_job) → {string}

Return a fully-qualified reportJob resource name string.

Parameters:
Name Type Description
account string
report_job string
Returns:
Type Description
string

Resource name string.

reportPath(account, report) → {string}

Return a fully-qualified report resource name string.

Parameters:
Name Type Description
account string
report string
Returns:
Type Description
string

Resource name string.

skuGroupPath(account, sku_group) → {string}

Return a fully-qualified skuGroup resource name string.

Parameters:
Name Type Description
account string
sku_group string
Returns:
Type Description
string

Resource name string.

skuPath(product, sku) → {string}

Return a fully-qualified sku resource name string.

Parameters:
Name Type Description
product string
sku string
Returns:
Type Description
string

Resource name string.