Package com.google.analytics.data.v1alpha

Class ReportTask.ReportMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1alpha.ReportTask.ReportMetadata
All Implemented Interfaces:
ReportTask.ReportMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
ReportTask
public static final class ReportTask.ReportMetadata extends com.google.protobuf.GeneratedMessage implements ReportTask.ReportMetadataOrBuilder
 The report metadata for a specific report task.
Protobuf type google.analytics.data.v1alpha.ReportTask.ReportMetadata
See Also:

  • Field Details

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • BEGIN_CREATING_TIME_FIELD_NUMBER

      public static final int BEGIN_CREATING_TIME_FIELD_NUMBER
      See Also:

    • CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER

      public static final int CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER
      See Also:

    • TASK_ROW_COUNT_FIELD_NUMBER

      public static final int TASK_ROW_COUNT_FIELD_NUMBER
      See Also:

    • ERROR_MESSAGE_FIELD_NUMBER

      public static final int ERROR_MESSAGE_FIELD_NUMBER
      See Also:

    • TOTAL_ROW_COUNT_FIELD_NUMBER

      public static final int TOTAL_ROW_COUNT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasState

      public 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];
      Specified by:
      hasState in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      Whether the state field is set.

    • getStateValue

      public 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];
      Specified by:
      getStateValue in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public 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];
      Specified by:
      getState in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      The state.

    • hasBeginCreatingTime

      public 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];
      Specified by:
      hasBeginCreatingTime in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      Whether the beginCreatingTime field is set.

    • getBeginCreatingTime

      public 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];
      Specified by:
      getBeginCreatingTime in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      The beginCreatingTime.

    • getBeginCreatingTimeOrBuilder

      public 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];
      Specified by:
      getBeginCreatingTimeOrBuilder in interface ReportTask.ReportMetadataOrBuilder

    • getCreationQuotaTokensCharged

      public 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];
      Specified by:
      getCreationQuotaTokensCharged in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      The creationQuotaTokensCharged.

    • hasTaskRowCount

      public 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];
      Specified by:
      hasTaskRowCount in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      Whether the taskRowCount field is set.

    • getTaskRowCount

      public 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];
      Specified by:
      getTaskRowCount in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      The taskRowCount.

    • hasErrorMessage

      public 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];
      Specified by:
      hasErrorMessage in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      Whether the errorMessage field is set.

    • getErrorMessage

      public 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];
      Specified by:
      getErrorMessage in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      public 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];
      Specified by:
      getErrorMessageBytes in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      The bytes for errorMessage.

    • hasTotalRowCount

      public 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];
      Specified by:
      hasTotalRowCount in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      Whether the totalRowCount field is set.

    • getTotalRowCount

      public 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];
      Specified by:
      getTotalRowCount in interface ReportTask.ReportMetadataOrBuilder
      Returns:
      The totalRowCount.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ReportTask.ReportMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ReportTask.ReportMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReportTask.ReportMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ReportTask.ReportMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ReportTask.ReportMetadata.Builder newBuilder()

    • newBuilder

      public static ReportTask.ReportMetadata.Builder newBuilder(ReportTask.ReportMetadata prototype)

    • toBuilder

      public ReportTask.ReportMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ReportTask.ReportMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ReportTask.ReportMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ReportTask.ReportMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<ReportTask.ReportMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ReportTask.ReportMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder