Package com.google.analytics.data.v1alpha

Class ReportTask.ReportMetadata.Builder

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

  • 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.Builder<ReportTask.ReportMetadata.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ReportTask.ReportMetadata.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ReportTask.ReportMetadata.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReportTask.ReportMetadata.Builder>

    • mergeFrom

      public ReportTask.ReportMetadata.Builder mergeFrom(ReportTask.ReportMetadata other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ReportTask.ReportMetadata.Builder>

    • mergeFrom

      public ReportTask.ReportMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReportTask.ReportMetadata.Builder>
      Throws:
      IOException

    • 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.

    • setStateValue

      public ReportTask.ReportMetadata.Builder setStateValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.

    • 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.

    • setState

      public ReportTask.ReportMetadata.Builder setState(ReportTask.ReportMetadata.State value)
       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];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.

    • clearState

      public ReportTask.ReportMetadata.Builder clearState()
       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:
      This builder for chaining.

    • 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.

    • setBeginCreatingTime

      public ReportTask.ReportMetadata.Builder setBeginCreatingTime(com.google.protobuf.Timestamp value)
       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];

    • setBeginCreatingTime

      public ReportTask.ReportMetadata.Builder setBeginCreatingTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];

    • mergeBeginCreatingTime

      public ReportTask.ReportMetadata.Builder mergeBeginCreatingTime(com.google.protobuf.Timestamp value)
       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];

    • clearBeginCreatingTime

      public ReportTask.ReportMetadata.Builder clearBeginCreatingTime()
       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];

    • getBeginCreatingTimeBuilder

      public com.google.protobuf.Timestamp.Builder getBeginCreatingTimeBuilder()
       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];

    • 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.

    • setCreationQuotaTokensCharged

      public ReportTask.ReportMetadata.Builder setCreationQuotaTokensCharged(int value)
       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];
      Parameters:
      value - The creationQuotaTokensCharged to set.
      Returns:
      This builder for chaining.

    • clearCreationQuotaTokensCharged

      public ReportTask.ReportMetadata.Builder clearCreationQuotaTokensCharged()
       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:
      This builder for chaining.

    • 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.

    • setTaskRowCount

      public ReportTask.ReportMetadata.Builder setTaskRowCount(int value)
       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];
      Parameters:
      value - The taskRowCount to set.
      Returns:
      This builder for chaining.

    • clearTaskRowCount

      public ReportTask.ReportMetadata.Builder clearTaskRowCount()
       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:
      This builder for chaining.

    • 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.

    • setErrorMessage

      public ReportTask.ReportMetadata.Builder setErrorMessage(String value)
       Output only. Error message is populated if a report task fails during
 creation.
      optional string error_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The errorMessage to set.
      Returns:
      This builder for chaining.

    • clearErrorMessage

      public ReportTask.ReportMetadata.Builder clearErrorMessage()
       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:
      This builder for chaining.

    • setErrorMessageBytes

      public ReportTask.ReportMetadata.Builder setErrorMessageBytes(com.google.protobuf.ByteString value)
       Output only. Error message is populated if a report task fails during
 creation.
      optional string error_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for errorMessage to set.
      Returns:
      This builder for chaining.

    • 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.

    • setTotalRowCount

      public ReportTask.ReportMetadata.Builder setTotalRowCount(int value)
       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];
      Parameters:
      value - The totalRowCount to set.
      Returns:
      This builder for chaining.

    • clearTotalRowCount

      public ReportTask.ReportMetadata.Builder clearTotalRowCount()
       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:
      This builder for chaining.