Struct google_api_proto::google::analytics::data::v1alpha::report_task::ReportMetadata

pub struct ReportMetadata {
    pub state: Option<i32>,
    pub begin_creating_time: Option<Timestamp>,
    pub creation_quota_tokens_charged: i32,
    pub task_row_count: Option<i32>,
    pub error_message: Option<String>,
    pub total_row_count: Option<i32>,
}

The report metadata for a specific report task.

Fields

state: Option<i32>

Output only. The current state for this report task.

begin_creating_time: Option<Timestamp>

Output only. The time when CreateReportTask was called and the report began the CREATING state.

creation_quota_tokens_charged: i32

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.

task_row_count: Option<i32>

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.

error_message: Option<String>

Output only. Error message is populated if a report task fails during creation.

total_row_count: Option<i32>

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.

Implementations

impl ReportMetadata

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is unset or set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn task_row_count(&self) -> i32

Returns the value of task_row_count, or the default value if task_row_count is unset.

pub fn error_message(&self) -> &str

Returns the value of error_message, or the default value if error_message is unset.

pub fn total_row_count(&self) -> i32

Returns the value of total_row_count, or the default value if total_row_count is unset.

Trait Implementations

impl Clone for ReportMetadata

fn clone(&self) -> ReportMetadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReportMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReportMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for ReportMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ReportMetadata

fn eq(&self, other: &ReportMetadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ReportMetadata