Class ReportTask.ReportMetadata.Builder (0.54.0) 

public static final class ReportTask.ReportMetadata.Builder extends GeneratedMessageV3.Builder<ReportTask.ReportMetadata.Builder> implements ReportTask.ReportMetadataOrBuilder

The report metadata for a specific report task.

Protobuf type google.analytics.data.v1alpha.ReportTask.ReportMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReportTask.ReportMetadata.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReportTask.ReportMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

build()

public ReportTask.ReportMetadata build()
Returns
Type Description
ReportTask.ReportMetadata

buildPartial()

public ReportTask.ReportMetadata buildPartial()
Returns
Type Description
ReportTask.ReportMetadata

clear()

public ReportTask.ReportMetadata.Builder clear()
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

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];

Returns
Type Description
ReportTask.ReportMetadata.Builder

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

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReportTask.ReportMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ReportTask.ReportMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

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

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

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

This builder for chaining.

clone()

public ReportTask.ReportMetadata.Builder clone()
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

getBeginCreatingTime()

public 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
Type Description
Timestamp

The beginCreatingTime.

getBeginCreatingTimeBuilder()

public 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];

Returns
Type Description
Builder

getBeginCreatingTimeOrBuilder()

public 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];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
int

The creationQuotaTokensCharged.

getDefaultInstanceForType()

public ReportTask.ReportMetadata getDefaultInstanceForType()
Returns
Type Description
ReportTask.ReportMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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];

Returns
Type Description
String

The errorMessage.

getErrorMessageBytes()

public 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
Type Description
ByteString

The bytes for errorMessage.

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];

Returns
Type Description
ReportTask.ReportMetadata.State

The state.

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];

Returns
Type Description
int

The enum numeric value on the wire for state.

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];

Returns
Type Description
int

The taskRowCount.

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];

Returns
Type Description
int

The totalRowCount.

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];

Returns
Type Description
boolean

Whether the beginCreatingTime field is set.

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];

Returns
Type Description
boolean

Whether the errorMessage field is set.

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];

Returns
Type Description
boolean

Whether the state field is set.

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];

Returns
Type Description
boolean

Whether the taskRowCount field is set.

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];

Returns
Type Description
boolean

Whether the totalRowCount field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBeginCreatingTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ReportTask.ReportMetadata.Builder

mergeFrom(ReportTask.ReportMetadata other)

public ReportTask.ReportMetadata.Builder mergeFrom(ReportTask.ReportMetadata other)
Parameter
Name Description
other ReportTask.ReportMetadata
Returns
Type Description
ReportTask.ReportMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReportTask.ReportMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ReportTask.ReportMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReportTask.ReportMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

setBeginCreatingTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ReportTask.ReportMetadata.Builder

setBeginCreatingTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ReportTask.ReportMetadata.Builder

setCreationQuotaTokensCharged(int value)

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];

Parameter
Name Description
value int

The creationQuotaTokensCharged to set.
Returns
Type Description
ReportTask.ReportMetadata.Builder

This builder for chaining.

setErrorMessage(String value)

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];

Parameter
Name Description
value String

The errorMessage to set.
Returns
Type Description
ReportTask.ReportMetadata.Builder

This builder for chaining.

setErrorMessageBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for errorMessage to set.
Returns
Type Description
ReportTask.ReportMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReportTask.ReportMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReportTask.ReportMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides

setState(ReportTask.ReportMetadata.State value)

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];

Parameter
Name Description
value ReportTask.ReportMetadata.State

The state to set.
Returns
Type Description
ReportTask.ReportMetadata.Builder

This builder for chaining.

setStateValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
ReportTask.ReportMetadata.Builder

This builder for chaining.

setTaskRowCount(int value)

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];

Parameter
Name Description
value int

The taskRowCount to set.
Returns
Type Description
ReportTask.ReportMetadata.Builder

This builder for chaining.

setTotalRowCount(int value)

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];

Parameter
Name Description
value int

The totalRowCount to set.
Returns
Type Description
ReportTask.ReportMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReportTask.ReportMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReportTask.ReportMetadata.Builder
Overrides