com.google.analytics.data.v1alpha

Class QueryAudienceListRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

com.google.analytics.data.v1alpha.QueryAudienceListRequest.Builder

All Implemented Interfaces:

QueryAudienceListRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

QueryAudienceListRequest

public static final class QueryAudienceListRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>
implements QueryAudienceListRequestOrBuilder

 A request to list users in an audience list.
 

Protobuf type google.analytics.data.v1alpha.QueryAudienceListRequest

Method Summary

Modifier and Type	Method and Description
QueryAudienceListRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
QueryAudienceListRequest	build()
QueryAudienceListRequest	buildPartial()
QueryAudienceListRequest.Builder	clear()
QueryAudienceListRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
QueryAudienceListRequest.Builder	clearLimit() The number of rows to return.
QueryAudienceListRequest.Builder	clearName() The name of the audience list to retrieve users from.
QueryAudienceListRequest.Builder	clearOffset() The row count of the start row.
QueryAudienceListRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
QueryAudienceListRequest.Builder	clone()
QueryAudienceListRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
long	getLimit() The number of rows to return.
String	getName() The name of the audience list to retrieve users from.
com.google.protobuf.ByteString	getNameBytes() The name of the audience list to retrieve users from.
long	getOffset() The row count of the start row.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
QueryAudienceListRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
QueryAudienceListRequest.Builder	mergeFrom(com.google.protobuf.Message other)
QueryAudienceListRequest.Builder	mergeFrom(QueryAudienceListRequest other)
QueryAudienceListRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
QueryAudienceListRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
QueryAudienceListRequest.Builder	setLimit(long value) The number of rows to return.
QueryAudienceListRequest.Builder	setName(String value) The name of the audience list to retrieve users from.
QueryAudienceListRequest.Builder	setNameBytes(com.google.protobuf.ByteString value) The name of the audience list to retrieve users from.
QueryAudienceListRequest.Builder	setOffset(long value) The row count of the start row.
QueryAudienceListRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
QueryAudienceListRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

clear

public QueryAudienceListRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

getDefaultInstanceForType

public QueryAudienceListRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public QueryAudienceListRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public QueryAudienceListRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public QueryAudienceListRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

setField

public QueryAudienceListRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

clearField

public QueryAudienceListRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

clearOneof

public QueryAudienceListRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

setRepeatedField

public QueryAudienceListRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

addRepeatedField

public QueryAudienceListRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

mergeFrom

public QueryAudienceListRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryAudienceListRequest.Builder>

mergeFrom

public QueryAudienceListRequest.Builder mergeFrom(QueryAudienceListRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

mergeFrom

public QueryAudienceListRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryAudienceListRequest.Builder>

Throws:

IOException

getName

public String getName()

 The name of the audience list to retrieve users from.
 Format: `properties/{propertyId}/audienceLists/{audienceListId}`
 

string name = 1;

Specified by:

getName in interface QueryAudienceListRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of the audience list to retrieve users from.
 Format: `properties/{propertyId}/audienceLists/{audienceListId}`
 

string name = 1;

Specified by:

getNameBytes in interface QueryAudienceListRequestOrBuilder

Returns:

The bytes for name.

setName

public QueryAudienceListRequest.Builder setName(String value)

 The name of the audience list to retrieve users from.
 Format: `properties/{propertyId}/audienceLists/{audienceListId}`
 

string name = 1;

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public QueryAudienceListRequest.Builder clearName()

 The name of the audience list to retrieve users from.
 Format: `properties/{propertyId}/audienceLists/{audienceListId}`
 

string name = 1;

Returns:

This builder for chaining.

setNameBytes

public QueryAudienceListRequest.Builder setNameBytes(com.google.protobuf.ByteString value)

 The name of the audience list to retrieve users from.
 Format: `properties/{propertyId}/audienceLists/{audienceListId}`
 

string name = 1;

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getOffset

public long getOffset()

 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
 

int64 offset = 2;

Specified by:

getOffset in interface QueryAudienceListRequestOrBuilder

Returns:

The offset.

setOffset

public QueryAudienceListRequest.Builder setOffset(long value)

 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
 

int64 offset = 2;

Parameters:

value - The offset to set.

Returns:

This builder for chaining.

clearOffset

public QueryAudienceListRequest.Builder clearOffset()

 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
 

int64 offset = 2;

Returns:

This builder for chaining.

getLimit

public long getLimit()

 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
 

int64 limit = 3;

Specified by:

getLimit in interface QueryAudienceListRequestOrBuilder

Returns:

The limit.

setLimit

public QueryAudienceListRequest.Builder setLimit(long value)

 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
 

int64 limit = 3;

Parameters:

value - The limit to set.

Returns:

This builder for chaining.

clearLimit

public QueryAudienceListRequest.Builder clearLimit()

 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
 

int64 limit = 3;

Returns:

This builder for chaining.

setUnknownFields

public final QueryAudienceListRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>

mergeUnknownFields

public final QueryAudienceListRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryAudienceListRequest.Builder>