Class QueryAudienceListRequest (0.57.0)

public final class QueryAudienceListRequest extends GeneratedMessageV3 implements QueryAudienceListRequestOrBuilder

A request to list users in an audience list.

Protobuf type google.analytics.data.v1alpha.QueryAudienceListRequest

Static Fields

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OFFSET_FIELD_NUMBER

public static final int OFFSET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryAudienceListRequest getDefaultInstance()
Returns
Type Description
QueryAudienceListRequest

getDescriptor()

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

newBuilder()

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

newBuilder(QueryAudienceListRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public QueryAudienceListRequest getDefaultInstanceForType()
Returns
Type Description
QueryAudienceListRequest

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 QueryAudienceListRequest.Builder newBuilderForType()
Returns
Type Description
QueryAudienceListRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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