Class RunReportResponse (0.44.0)

public final class RunReportResponse extends GeneratedMessageV3 implements RunReportResponseOrBuilder

The response report table corresponding to a request.

Protobuf type google.analytics.data.v1beta.RunReportResponse

Static Fields

DIMENSION_HEADERS_FIELD_NUMBER

public static final int DIMENSION_HEADERS_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

MAXIMUMS_FIELD_NUMBER

public static final int MAXIMUMS_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_HEADERS_FIELD_NUMBER

public static final int METRIC_HEADERS_FIELD_NUMBER
Field Value
TypeDescription
int

MINIMUMS_FIELD_NUMBER

public static final int MINIMUMS_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTY_QUOTA_FIELD_NUMBER

public static final int PROPERTY_QUOTA_FIELD_NUMBER
Field Value
TypeDescription
int

ROWS_FIELD_NUMBER

public static final int ROWS_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

TOTALS_FIELD_NUMBER

public static final int TOTALS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RunReportResponse getDefaultInstance()
Returns
TypeDescription
RunReportResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RunReportResponse.Builder newBuilder()
Returns
TypeDescription
RunReportResponse.Builder

newBuilder(RunReportResponse prototype)

public static RunReportResponse.Builder newBuilder(RunReportResponse prototype)
Parameter
NameDescription
prototypeRunReportResponse
Returns
TypeDescription
RunReportResponse.Builder

parseDelimitedFrom(InputStream input)

public static RunReportResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunReportResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RunReportResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunReportResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunReportResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunReportResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunReportResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunReportResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RunReportResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunReportResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RunReportResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunReportResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunReportResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RunReportResponse> parser()
Returns
TypeDescription
Parser<RunReportResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public RunReportResponse getDefaultInstanceForType()
Returns
TypeDescription
RunReportResponse

getDimensionHeaders(int index)

public DimensionHeader getDimensionHeaders(int index)

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
DimensionHeader

getDimensionHeadersCount()

public int getDimensionHeadersCount()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 1;

Returns
TypeDescription
int

getDimensionHeadersList()

public List<DimensionHeader> getDimensionHeadersList()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 1;

Returns
TypeDescription
List<DimensionHeader>

getDimensionHeadersOrBuilder(int index)

public DimensionHeaderOrBuilder getDimensionHeadersOrBuilder(int index)

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
DimensionHeaderOrBuilder

getDimensionHeadersOrBuilderList()

public List<? extends DimensionHeaderOrBuilder> getDimensionHeadersOrBuilderList()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 1;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.DimensionHeaderOrBuilder>

getKind()

public String getKind()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runReport". Useful to distinguish between response types in JSON.

string kind = 10;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runReport". Useful to distinguish between response types in JSON.

string kind = 10;

Returns
TypeDescription
ByteString

The bytes for kind.

getMaximums(int index)

public Row getMaximums(int index)

If requested, the maximum values of metrics.

repeated .google.analytics.data.v1beta.Row maximums = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Row

getMaximumsCount()

public int getMaximumsCount()

If requested, the maximum values of metrics.

repeated .google.analytics.data.v1beta.Row maximums = 5;

Returns
TypeDescription
int

getMaximumsList()

public List<Row> getMaximumsList()

If requested, the maximum values of metrics.

repeated .google.analytics.data.v1beta.Row maximums = 5;

Returns
TypeDescription
List<Row>

getMaximumsOrBuilder(int index)

public RowOrBuilder getMaximumsOrBuilder(int index)

If requested, the maximum values of metrics.

repeated .google.analytics.data.v1beta.Row maximums = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
RowOrBuilder

getMaximumsOrBuilderList()

public List<? extends RowOrBuilder> getMaximumsOrBuilderList()

If requested, the maximum values of metrics.

repeated .google.analytics.data.v1beta.Row maximums = 5;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

getMetadata()

public ResponseMetaData getMetadata()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 8;

Returns
TypeDescription
ResponseMetaData

The metadata.

getMetadataOrBuilder()

public ResponseMetaDataOrBuilder getMetadataOrBuilder()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 8;

Returns
TypeDescription
ResponseMetaDataOrBuilder

getMetricHeaders(int index)

public MetricHeader getMetricHeaders(int index)

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricHeader

getMetricHeadersCount()

public int getMetricHeadersCount()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 2;

Returns
TypeDescription
int

getMetricHeadersList()

public List<MetricHeader> getMetricHeadersList()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 2;

Returns
TypeDescription
List<MetricHeader>

getMetricHeadersOrBuilder(int index)

public MetricHeaderOrBuilder getMetricHeadersOrBuilder(int index)

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricHeaderOrBuilder

getMetricHeadersOrBuilderList()

public List<? extends MetricHeaderOrBuilder> getMetricHeadersOrBuilderList()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 2;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.MetricHeaderOrBuilder>

getMinimums(int index)

public Row getMinimums(int index)

If requested, the minimum values of metrics.

repeated .google.analytics.data.v1beta.Row minimums = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
Row

getMinimumsCount()

public int getMinimumsCount()

If requested, the minimum values of metrics.

repeated .google.analytics.data.v1beta.Row minimums = 6;

Returns
TypeDescription
int

getMinimumsList()

public List<Row> getMinimumsList()

If requested, the minimum values of metrics.

repeated .google.analytics.data.v1beta.Row minimums = 6;

Returns
TypeDescription
List<Row>

getMinimumsOrBuilder(int index)

public RowOrBuilder getMinimumsOrBuilder(int index)

If requested, the minimum values of metrics.

repeated .google.analytics.data.v1beta.Row minimums = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
RowOrBuilder

getMinimumsOrBuilderList()

public List<? extends RowOrBuilder> getMinimumsOrBuilderList()

If requested, the minimum values of metrics.

repeated .google.analytics.data.v1beta.Row minimums = 6;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

getParserForType()

public Parser<RunReportResponse> getParserForType()
Returns
TypeDescription
Parser<RunReportResponse>
Overrides

getPropertyQuota()

public PropertyQuota getPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 9;

Returns
TypeDescription
PropertyQuota

The propertyQuota.

getPropertyQuotaOrBuilder()

public PropertyQuotaOrBuilder getPropertyQuotaOrBuilder()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 9;

Returns
TypeDescription
PropertyQuotaOrBuilder

getRowCount()

public int getRowCount()

The total number of rows in the query result. rowCount is independent of the number of rows returned in the response, the limit request parameter, and the offset request parameter. For example if a query returns 175 rows and includes limit of 50 in the API request, the response will contain rowCount of 175 but only 50 rows.

To learn more about this pagination parameter, see Pagination.

int32 row_count = 7;

Returns
TypeDescription
int

The rowCount.

getRows(int index)

public Row getRows(int index)

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Row

getRowsCount()

public int getRowsCount()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 3;

Returns
TypeDescription
int

getRowsList()

public List<Row> getRowsList()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 3;

Returns
TypeDescription
List<Row>

getRowsOrBuilder(int index)

public RowOrBuilder getRowsOrBuilder(int index)

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
RowOrBuilder

getRowsOrBuilderList()

public List<? extends RowOrBuilder> getRowsOrBuilderList()

Rows of dimension value combinations and metric values in the report.

repeated .google.analytics.data.v1beta.Row rows = 3;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTotals(int index)

public Row getTotals(int index)

If requested, the totaled values of metrics.

repeated .google.analytics.data.v1beta.Row totals = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
Row

getTotalsCount()

public int getTotalsCount()

If requested, the totaled values of metrics.

repeated .google.analytics.data.v1beta.Row totals = 4;

Returns
TypeDescription
int

getTotalsList()

public List<Row> getTotalsList()

If requested, the totaled values of metrics.

repeated .google.analytics.data.v1beta.Row totals = 4;

Returns
TypeDescription
List<Row>

getTotalsOrBuilder(int index)

public RowOrBuilder getTotalsOrBuilder(int index)

If requested, the totaled values of metrics.

repeated .google.analytics.data.v1beta.Row totals = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
RowOrBuilder

getTotalsOrBuilderList()

public List<? extends RowOrBuilder> getTotalsOrBuilderList()

If requested, the totaled values of metrics.

repeated .google.analytics.data.v1beta.Row totals = 4;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1beta.RowOrBuilder>

hasMetadata()

public boolean hasMetadata()

Metadata for the report.

.google.analytics.data.v1beta.ResponseMetaData metadata = 8;

Returns
TypeDescription
boolean

Whether the metadata field is set.

hasPropertyQuota()

public boolean hasPropertyQuota()

This Analytics Property's quota state including this request.

.google.analytics.data.v1beta.PropertyQuota property_quota = 9;

Returns
TypeDescription
boolean

Whether the propertyQuota field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RunReportResponse.Builder newBuilderForType()
Returns
TypeDescription
RunReportResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunReportResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RunReportResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RunReportResponse.Builder toBuilder()
Returns
TypeDescription
RunReportResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException