Package com.google.analytics.data.v1alpha

Interface ReportTask.ReportMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReportTask.ReportMetadata, ReportTask.ReportMetadata.Builder
Enclosing class:
ReportTask
public static interface ReportTask.ReportMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasState

      boolean hasState()
       Output only. The current state for this report task.
      optional .google.analytics.data.v1alpha.ReportTask.ReportMetadata.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the state field is set.

    • getStateValue

      int getStateValue()
       Output only. The current state for this report task.
      optional .google.analytics.data.v1alpha.ReportTask.ReportMetadata.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      ReportTask.ReportMetadata.State getState()
       Output only. The current state for this report task.
      optional .google.analytics.data.v1alpha.ReportTask.ReportMetadata.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • hasBeginCreatingTime

      boolean hasBeginCreatingTime()
       Output only. The time when `CreateReportTask` was called and the report
 began the `CREATING` state.
      optional .google.protobuf.Timestamp begin_creating_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the beginCreatingTime field is set.

    • getBeginCreatingTime

      com.google.protobuf.Timestamp getBeginCreatingTime()
       Output only. The time when `CreateReportTask` was called and the report
 began the `CREATING` state.
      optional .google.protobuf.Timestamp begin_creating_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The beginCreatingTime.

    • getBeginCreatingTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getBeginCreatingTimeOrBuilder()
       Output only. The time when `CreateReportTask` was called and the report
 began the `CREATING` state.
      optional .google.protobuf.Timestamp begin_creating_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreationQuotaTokensCharged

      int getCreationQuotaTokensCharged()
       Output only. The total quota tokens charged during creation of the
 report. Because this token count is based on activity from the `CREATING`
 state, this tokens charge will be fixed once a report task enters the
 `ACTIVE` or `FAILED` state.
      int32 creation_quota_tokens_charged = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The creationQuotaTokensCharged.

    • hasTaskRowCount

      boolean hasTaskRowCount()
       Output only. The total number of rows in the report result. This field
 will be populated when the state is active. You can utilize
 `task_row_count` for pagination within the confines of their existing
 report.
      optional int32 task_row_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the taskRowCount field is set.

    • getTaskRowCount

      int getTaskRowCount()
       Output only. The total number of rows in the report result. This field
 will be populated when the state is active. You can utilize
 `task_row_count` for pagination within the confines of their existing
 report.
      optional int32 task_row_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The taskRowCount.

    • hasErrorMessage

      boolean hasErrorMessage()
       Output only. Error message is populated if a report task fails during
 creation.
      optional string error_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the errorMessage field is set.

    • getErrorMessage

      String getErrorMessage()
       Output only. Error message is populated if a report task fails during
 creation.
      optional string error_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       Output only. Error message is populated if a report task fails during
 creation.
      optional string error_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for errorMessage.

    • hasTotalRowCount

      boolean hasTotalRowCount()
       Output only. The total number of rows in Google Analytics storage. If you
 want to query additional data rows beyond the current report, they can
 initiate a new report task based on the `total_row_count`.

 The `task_row_count` represents the number of rows specifically
 pertaining to the current report, whereas `total_row_count` encompasses
 the total count of rows across all data retrieved from Google
 Analytics storage.

 For example, suppose the current report's `task_row_count` is 20,
 displaying the data from the first 20 rows. Simultaneously, the
 `total_row_count` is 30, indicating the presence of data for all 30 rows.
 The `task_row_count` can be utilizated to paginate through the initial 20
 rows. To expand the report and include data from all 30 rows, a new
 report task can be created using the total_row_count to access the full
 set of 30 rows' worth of data.
      optional int32 total_row_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the totalRowCount field is set.

    • getTotalRowCount

      int getTotalRowCount()
       Output only. The total number of rows in Google Analytics storage. If you
 want to query additional data rows beyond the current report, they can
 initiate a new report task based on the `total_row_count`.

 The `task_row_count` represents the number of rows specifically
 pertaining to the current report, whereas `total_row_count` encompasses
 the total count of rows across all data retrieved from Google
 Analytics storage.

 For example, suppose the current report's `task_row_count` is 20,
 displaying the data from the first 20 rows. Simultaneously, the
 `total_row_count` is 30, indicating the presence of data for all 30 rows.
 The `task_row_count` can be utilizated to paginate through the initial 20
 rows. To expand the report and include data from all 30 rows, a new
 report task can be created using the total_row_count to access the full
 set of 30 rows' worth of data.
      optional int32 total_row_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The totalRowCount.