Package com.google.cloud.channel.v1

Interface FetchReportResultsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    FetchReportResultsRequest, FetchReportResultsRequest.Builder
    public interface FetchReportResultsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getReportJob

        String getReportJob()
         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}
        string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The reportJob.

      • getReportJobBytes

        com.google.protobuf.ByteString getReportJobBytes()
         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}
        string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for reportJob.

      • getPageSize

        int getPageSize()
         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.
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         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.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         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.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for pageToken.

      • getPartitionKeysList

        List<String> getPartitionKeysList()
         Optional. List of keys specifying which report partitions to return.
 If empty, returns all partitions.
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the partitionKeys.

      • getPartitionKeysCount

        int getPartitionKeysCount()
         Optional. List of keys specifying which report partitions to return.
 If empty, returns all partitions.
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of partitionKeys.

      • getPartitionKeys

        String getPartitionKeys​(int index)
         Optional. List of keys specifying which report partitions to return.
 If empty, returns all partitions.
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The partitionKeys at the given index.

      • getPartitionKeysBytes

        com.google.protobuf.ByteString getPartitionKeysBytes​(int index)
         Optional. List of keys specifying which report partitions to return.
 If empty, returns all partitions.
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the partitionKeys at the given index.