Represents a ReportMetadata.
Package
@google-analytics/dataConstructors
(constructor)(properties)
constructor(properties?: google.analytics.data.v1alpha.ReportTask.IReportMetadata);Constructs a new ReportMetadata.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReportMetadata
Properties to set |
Properties
_beginCreatingTime
public _beginCreatingTime?: "beginCreatingTime";ReportMetadata _beginCreatingTime.
_errorMessage
public _errorMessage?: "errorMessage";ReportMetadata _errorMessage.
_state
public _state?: "state";ReportMetadata _state.
_taskRowCount
public _taskRowCount?: "taskRowCount";ReportMetadata _taskRowCount.
_totalRowCount
public _totalRowCount?: "totalRowCount";ReportMetadata _totalRowCount.
beginCreatingTime
public beginCreatingTime?: (google.protobuf.ITimestamp|null);ReportMetadata beginCreatingTime.
creationQuotaTokensCharged
public creationQuotaTokensCharged: number;ReportMetadata creationQuotaTokensCharged.
errorMessage
public errorMessage?: (string|null);ReportMetadata errorMessage.
state
public state?: (google.analytics.data.v1alpha.ReportTask.ReportMetadata.State|keyof typeof google.analytics.data.v1alpha.ReportTask.ReportMetadata.State|null);ReportMetadata state.
taskRowCount
public taskRowCount?: (number|null);ReportMetadata taskRowCount.
totalRowCount
public totalRowCount?: (number|null);ReportMetadata totalRowCount.
Methods
create(properties)
public static create(properties?: google.analytics.data.v1alpha.ReportTask.IReportMetadata): google.analytics.data.v1alpha.ReportTask.ReportMetadata;Creates a new ReportMetadata instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReportMetadata
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ReportMetadata |
ReportMetadata instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1alpha.ReportTask.ReportMetadata;Decodes a ReportMetadata message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
ReportMetadata |
ReportMetadata |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1alpha.ReportTask.ReportMetadata;Decodes a ReportMetadata message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ReportMetadata |
ReportMetadata |
encode(message, writer)
public static encode(message: google.analytics.data.v1alpha.ReportTask.IReportMetadata, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ReportMetadata message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReportMetadata
ReportMetadata message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.analytics.data.v1alpha.ReportTask.IReportMetadata, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ReportMetadata message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReportMetadata
ReportMetadata message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.analytics.data.v1alpha.ReportTask.ReportMetadata;Creates a ReportMetadata message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
ReportMetadata |
ReportMetadata |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ReportMetadata
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ReportMetadata to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.analytics.data.v1alpha.ReportTask.ReportMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ReportMetadata message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ReportMetadata
ReportMetadata |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a ReportMetadata message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|