Class SheetExportAudienceListRequest (0.46.0)

public final class SheetExportAudienceListRequest extends GeneratedMessageV3 implements SheetExportAudienceListRequestOrBuilder

A request to export users in an audience list to a Google Sheet.

Protobuf type google.analytics.data.v1alpha.SheetExportAudienceListRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SheetExportAudienceListRequest

Static Fields

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OFFSET_FIELD_NUMBER

public static final int OFFSET_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SheetExportAudienceListRequest getDefaultInstance()
Returns
TypeDescription
SheetExportAudienceListRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SheetExportAudienceListRequest prototype)

public static SheetExportAudienceListRequest.Builder newBuilder(SheetExportAudienceListRequest prototype)
Parameter
NameDescription
prototypeSheetExportAudienceListRequest
Returns
TypeDescription
SheetExportAudienceListRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SheetExportAudienceListRequest getDefaultInstanceForType()
Returns
TypeDescription
SheetExportAudienceListRequest

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
TypeDescription
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, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
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, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
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
TypeDescription
long

The offset.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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 SheetExportAudienceListRequest.Builder newBuilderForType()
Returns
TypeDescription
SheetExportAudienceListRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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