Package com.google.analytics.data.v1alpha

Interface QueryReportTaskRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
QueryReportTaskRequest, QueryReportTaskRequest.Builder
@Generated public interface QueryReportTaskRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getLimit()
    Optional.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    long
    getOffset()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       Required. The report source name.
 Format: `properties/{property}/reportTasks/{report}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The report source name.
 Format: `properties/{property}/reportTasks/{report}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for name.

    • getOffset

      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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The offset.

    • getLimit

      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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The limit.