Interface FetchReportResultsRequestOrBuilder (3.34.0)

public interface FetchReportResultsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract 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
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for pageToken.

getPartitionKeys(int index)

public abstract 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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The partitionKeys at the given index.

getPartitionKeysBytes(int index)

public abstract 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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the partitionKeys at the given index.

getPartitionKeysCount()

public abstract 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
TypeDescription
int

The count of partitionKeys.

getPartitionKeysList()

public abstract 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
TypeDescription
List<String>

A list containing the partitionKeys.

getReportJob()

public abstract String getReportJob()

Required. The report job created by 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
TypeDescription
String

The reportJob.

getReportJobBytes()

public abstract ByteString getReportJobBytes()

Required. The report job created by 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
TypeDescription
ByteString

The bytes for reportJob.