ReportMetadata

google.analytics.data.v1alpha.ReportTask. ReportMetadata

Represents a ReportMetadata.

Constructor

new ReportMetadata(propertiesopt)

Constructs a new ReportMetadata.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1alpha.ReportTask.IReportMetadata <optional>

Properties to set

Implements:
  • IReportMetadata

Members

_beginCreatingTime

ReportMetadata _beginCreatingTime.

_errorMessage

ReportMetadata _errorMessage.

_state

ReportMetadata _state.

_taskRowCount

ReportMetadata _taskRowCount.

_totalRowCount

ReportMetadata _totalRowCount.

beginCreatingTime

ReportMetadata beginCreatingTime.

creationQuotaTokensCharged

ReportMetadata creationQuotaTokensCharged.

errorMessage

ReportMetadata errorMessage.

state

ReportMetadata state.

taskRowCount

ReportMetadata taskRowCount.

totalRowCount

ReportMetadata totalRowCount.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

CREATING number

CREATING value

ACTIVE number

ACTIVE value

FAILED number

FAILED value

Methods

toJSON() → {Object.<string, *>}

Converts this ReportMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.analytics.data.v1alpha.ReportTask.ReportMetadata}

Creates a new ReportMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1alpha.ReportTask.IReportMetadata <optional>

Properties to set

Returns:
Type Description
google.analytics.data.v1alpha.ReportTask.ReportMetadata

ReportMetadata instance

(static) decode(reader, lengthopt) → {google.analytics.data.v1alpha.ReportTask.ReportMetadata}

Decodes a ReportMetadata message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.analytics.data.v1alpha.ReportTask.ReportMetadata

ReportMetadata

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.analytics.data.v1alpha.ReportTask.ReportMetadata}

Decodes a ReportMetadata message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.analytics.data.v1alpha.ReportTask.ReportMetadata

ReportMetadata

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified ReportMetadata message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.ReportTask.IReportMetadata

ReportMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified ReportMetadata message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.ReportTask.IReportMetadata

ReportMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.analytics.data.v1alpha.ReportTask.ReportMetadata}

Creates a ReportMetadata message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.analytics.data.v1alpha.ReportTask.ReportMetadata

ReportMetadata

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ReportMetadata

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a ReportMetadata message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.ReportTask.ReportMetadata

ReportMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a ReportMetadata message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not