public static final class QueryAudienceListRequest.Builder extends GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder> implements QueryAudienceListRequestOrBuilderA request to list users in an audience list.
Protobuf type google.analytics.data.v1alpha.QueryAudienceListRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > QueryAudienceListRequest.BuilderImplements
QueryAudienceListRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public QueryAudienceListRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
build()
public QueryAudienceListRequest build()| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest | |
buildPartial()
public QueryAudienceListRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest | |
clear()
public QueryAudienceListRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public QueryAudienceListRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
clearLimit()
public QueryAudienceListRequest.Builder clearLimit() Optional. The number of rows to return. 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.
To learn more about this pagination parameter, see Pagination.
int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | This builder for chaining. |
clearName()
public QueryAudienceListRequest.Builder clearName() Required. The name of the audience list to retrieve users from.
Format: properties/{property}/audienceLists/{audience_list}
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | This builder for chaining. |
clearOffset()
public QueryAudienceListRequest.Builder clearOffset()Optional. The row count of the start row. 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 |
QueryAudienceListRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public QueryAudienceListRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
clone()
public QueryAudienceListRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
getDefaultInstanceForType()
public QueryAudienceListRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getLimit()
public long getLimit() Optional. The number of rows to return. 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.
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 name of the audience list to retrieve users from.
Format: properties/{property}/audienceLists/{audience_list}
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes() Required. The name of the audience list to retrieve users from.
Format: properties/{property}/audienceLists/{audience_list}
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. 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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(QueryAudienceListRequest other)
public QueryAudienceListRequest.Builder mergeFrom(QueryAudienceListRequest other)| Parameter | |
|---|---|
| Name | Description |
other | QueryAudienceListRequest |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public QueryAudienceListRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public QueryAudienceListRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final QueryAudienceListRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public QueryAudienceListRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
setLimit(long value)
public QueryAudienceListRequest.Builder setLimit(long value) Optional. The number of rows to return. 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.
To learn more about this pagination parameter, see Pagination.
int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | longThe limit to set. |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | This builder for chaining. |
setName(String value)
public QueryAudienceListRequest.Builder setName(String value) Required. The name of the audience list to retrieve users from.
Format: properties/{property}/audienceLists/{audience_list}
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public QueryAudienceListRequest.Builder setNameBytes(ByteString value) Required. The name of the audience list to retrieve users from.
Format: properties/{property}/audienceLists/{audience_list}
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | This builder for chaining. |
setOffset(long value)
public QueryAudienceListRequest.Builder setOffset(long value)Optional. The row count of the start row. 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 | longThe offset to set. |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public QueryAudienceListRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final QueryAudienceListRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest.Builder | |