Class ReportTask (0.57.0)

public final class ReportTask extends GeneratedMessageV3 implements ReportTaskOrBuilder

A specific report task configuration.

Protobuf type google.analytics.data.v1alpha.ReportTask

Implements

ReportTaskOrBuilder

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REPORT_DEFINITION_FIELD_NUMBER

public static final int REPORT_DEFINITION_FIELD_NUMBER
Field Value
Type Description
int

REPORT_METADATA_FIELD_NUMBER

public static final int REPORT_METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReportTask getDefaultInstance()
Returns
Type Description
ReportTask

getDescriptor()

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

newBuilder()

public static ReportTask.Builder newBuilder()
Returns
Type Description
ReportTask.Builder

newBuilder(ReportTask prototype)

public static ReportTask.Builder newBuilder(ReportTask prototype)
Parameter
Name Description
prototype ReportTask
Returns
Type Description
ReportTask.Builder

parseDelimitedFrom(InputStream input)

public static ReportTask parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportTask
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportTask parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportTask
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReportTask parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReportTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReportTask parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReportTask parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReportTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReportTask parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReportTask parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReportTask
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportTask parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportTask
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReportTask parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportTask
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportTask parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportTask
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReportTask parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReportTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReportTask parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportTask
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReportTask> parser()
Returns
Type Description
Parser<ReportTask>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ReportTask getDefaultInstanceForType()
Returns
Type Description
ReportTask

getName()

public String getName()

Output only. Identifier. The report task resource name assigned during creation. Format: properties/{property}/reportTasks/{report_task}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. The report task resource name assigned during creation. Format: properties/{property}/reportTasks/{report_task}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ReportTask> getParserForType()
Returns
Type Description
Parser<ReportTask>
Overrides

getReportDefinition()

public ReportTask.ReportDefinition getReportDefinition()

Optional. A report definition to fetch report data, which describes the structure of a report. It typically includes the fields that will be included in the report and the criteria that will be used to filter the data.

.google.analytics.data.v1alpha.ReportTask.ReportDefinition report_definition = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportTask.ReportDefinition

The reportDefinition.

getReportDefinitionOrBuilder()

public ReportTask.ReportDefinitionOrBuilder getReportDefinitionOrBuilder()

Optional. A report definition to fetch report data, which describes the structure of a report. It typically includes the fields that will be included in the report and the criteria that will be used to filter the data.

.google.analytics.data.v1alpha.ReportTask.ReportDefinition report_definition = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportTask.ReportDefinitionOrBuilder

getReportMetadata()

public ReportTask.ReportMetadata getReportMetadata()

Output only. The report metadata for a specific report task, which provides information about a report. It typically includes the following information: the resource name of the report, the state of the report, the timestamp the report was created, etc,

.google.analytics.data.v1alpha.ReportTask.ReportMetadata report_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReportTask.ReportMetadata

The reportMetadata.

getReportMetadataOrBuilder()

public ReportTask.ReportMetadataOrBuilder getReportMetadataOrBuilder()

Output only. The report metadata for a specific report task, which provides information about a report. It typically includes the following information: the resource name of the report, the state of the report, the timestamp the report was created, etc,

.google.analytics.data.v1alpha.ReportTask.ReportMetadata report_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReportTask.ReportMetadataOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasReportDefinition()

public boolean hasReportDefinition()

Optional. A report definition to fetch report data, which describes the structure of a report. It typically includes the fields that will be included in the report and the criteria that will be used to filter the data.

.google.analytics.data.v1alpha.ReportTask.ReportDefinition report_definition = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the reportDefinition field is set.

hasReportMetadata()

public boolean hasReportMetadata()

Output only. The report metadata for a specific report task, which provides information about a report. It typically includes the following information: the resource name of the report, the state of the report, the timestamp the report was created, etc,

.google.analytics.data.v1alpha.ReportTask.ReportMetadata report_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the reportMetadata field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReportTask.Builder newBuilderForType()
Returns
Type Description
ReportTask.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReportTask.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReportTask.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReportTask.Builder toBuilder()
Returns
Type Description
ReportTask.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException