public static final class ReportTask.ReportMetadata extends GeneratedMessageV3 implements ReportTask.ReportMetadataOrBuilder
The report metadata for a specific report task.
Protobuf type google.analytics.data.v1alpha.ReportTask.ReportMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int BEGIN_CREATING_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ERROR_MESSAGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TASK_ROW_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOTAL_ROW_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ReportTask.ReportMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ReportTask.ReportMetadata.Builder newBuilder()
public static ReportTask.ReportMetadata.Builder newBuilder(ReportTask.ReportMetadata prototype)
public static ReportTask.ReportMetadata parseDelimitedFrom(InputStream input)
public static ReportTask.ReportMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ReportTask.ReportMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ReportTask.ReportMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReportTask.ReportMetadata parseFrom(ByteString data)
public static ReportTask.ReportMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReportTask.ReportMetadata parseFrom(CodedInputStream input)
public static ReportTask.ReportMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ReportTask.ReportMetadata parseFrom(InputStream input)
public static ReportTask.ReportMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ReportTask.ReportMetadata parseFrom(ByteBuffer data)
public static ReportTask.ReportMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ReportTask.ReportMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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];
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.
|
public ReportTask.ReportMetadata getDefaultInstanceForType()
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.
|
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.
|
public Parser<ReportTask.ReportMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ReportTask.ReportMetadata.Builder newBuilderForType()
protected ReportTask.ReportMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ReportTask.ReportMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
