Class QueryReportTaskRequest.Builder (0.94.0)

public static final class QueryReportTaskRequest.Builder extends GeneratedMessage.Builder<QueryReportTaskRequest.Builder> implements QueryReportTaskRequestOrBuilder

A request to fetch the report content for a report task.

Protobuf type google.analytics.data.v1alpha.QueryReportTaskRequest

Static Methods

getDescriptor()

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

Methods

build()

public QueryReportTaskRequest build()
Returns
Type Description
QueryReportTaskRequest

buildPartial()

public QueryReportTaskRequest buildPartial()
Returns
Type Description
QueryReportTaskRequest

clear()

public QueryReportTaskRequest.Builder clear()
Returns
Type Description
QueryReportTaskRequest.Builder
Overrides

clearLimit()

public QueryReportTaskRequest.Builder clearLimit()

Optional. The number of rows to return from the report. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. The number of rows available to a QueryReportTaskRequest is further limited by the limit of the associated ReportTask. A query can retrieve at most ReportTask.limit rows. For example, if the ReportTask has a limit of 1,000, then a QueryReportTask request with offset=900 and limit=500 will return at most 100 rows.

To learn more about this pagination parameter, see Pagination.

int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueryReportTaskRequest.Builder

This builder for chaining.

clearName()

public QueryReportTaskRequest.Builder clearName()

Required. The report source name. Format: properties/{property}/reportTasks/{report}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
QueryReportTaskRequest.Builder

This builder for chaining.

clearOffset()

public QueryReportTaskRequest.Builder clearOffset()

Optional. The row count of the start row in the report. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

To learn more about this pagination parameter, see Pagination.

int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueryReportTaskRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public QueryReportTaskRequest getDefaultInstanceForType()
Returns
Type Description
QueryReportTaskRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLimit()

public long getLimit()

Optional. The number of rows to return from the report. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. The number of rows available to a QueryReportTaskRequest is further limited by the limit of the associated ReportTask. A query can retrieve at most ReportTask.limit rows. For example, if the ReportTask has a limit of 1,000, then a QueryReportTask request with offset=900 and limit=500 will return at most 100 rows.

To learn more about this pagination parameter, see Pagination.

int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The limit.

getName()

public String getName()

Required. The report source name. Format: properties/{property}/reportTasks/{report}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The report source name. Format: properties/{property}/reportTasks/{report}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getOffset()

public long getOffset()

Optional. The row count of the start row in the report. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

To learn more about this pagination parameter, see Pagination.

int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The offset.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(QueryReportTaskRequest other)

public QueryReportTaskRequest.Builder mergeFrom(QueryReportTaskRequest other)
Parameter
Name Description
other QueryReportTaskRequest
Returns
Type Description
QueryReportTaskRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryReportTaskRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryReportTaskRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public QueryReportTaskRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
QueryReportTaskRequest.Builder
Overrides

setLimit(long value)

public QueryReportTaskRequest.Builder setLimit(long value)

Optional. The number of rows to return from the report. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. The number of rows available to a QueryReportTaskRequest is further limited by the limit of the associated ReportTask. A query can retrieve at most ReportTask.limit rows. For example, if the ReportTask has a limit of 1,000, then a QueryReportTask request with offset=900 and limit=500 will return at most 100 rows.

To learn more about this pagination parameter, see Pagination.

int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The limit to set.

Returns
Type Description
QueryReportTaskRequest.Builder

This builder for chaining.

setName(String value)

public QueryReportTaskRequest.Builder setName(String value)

Required. The report source name. Format: properties/{property}/reportTasks/{report}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
QueryReportTaskRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public QueryReportTaskRequest.Builder setNameBytes(ByteString value)

Required. The report source name. Format: properties/{property}/reportTasks/{report}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
QueryReportTaskRequest.Builder

This builder for chaining.

setOffset(long value)

public QueryReportTaskRequest.Builder setOffset(long value)

Optional. The row count of the start row in the report. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

To learn more about this pagination parameter, see Pagination.

int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The offset to set.

Returns
Type Description
QueryReportTaskRequest.Builder

This builder for chaining.