Interface QueryReportTaskRequestOrBuilder (0.57.0)

public interface QueryReportTaskRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getLimit()

public abstract long getLimit()

Optional. The number of rows to return from the report. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. The number of rows available to a QueryReportTaskRequest is further limited by the limit of the associated ReportTask. A query can retrieve at most ReportTask.limit rows. For example, if the ReportTask has a limit of 1,000, then a QueryReportTask request with offset=900 and limit=500 will return at most 100 rows.

To learn more about this pagination parameter, see Pagination.

int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The limit.

getName()

public abstract String getName()

Required. The report source name. Format: properties/{property}/reportTasks/{report}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The report source name. Format: properties/{property}/reportTasks/{report}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getOffset()

public abstract long getOffset()

Optional. The row count of the start row in the report. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

To learn more about this pagination parameter, see Pagination.

int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The offset.