com.google.analytics.data.v1alpha

Class AudienceList

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1alpha.AudienceList

All Implemented Interfaces:

AudienceListOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AudienceList
extends com.google.protobuf.GeneratedMessageV3
implements AudienceListOrBuilder

 An audience list is a list of users in an audience at the time of the list's
 creation. One audience may have multiple audience lists created for different
 days.
 

Protobuf type google.analytics.data.v1alpha.AudienceList

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AudienceList.Builder An audience list is a list of users in an audience at the time of the list's creation.
static class	AudienceList.State The AudienceList currently exists in this state.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUDIENCE_DISPLAY_NAME_FIELD_NUMBER
static int	AUDIENCE_FIELD_NUMBER
static int	BEGIN_CREATING_TIME_FIELD_NUMBER
static int	DIMENSIONS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	STATE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAudience() Required.
com.google.protobuf.ByteString	getAudienceBytes() Required.
String	getAudienceDisplayName() Output only.
com.google.protobuf.ByteString	getAudienceDisplayNameBytes() Output only.
com.google.protobuf.Timestamp	getBeginCreatingTime() Output only.
com.google.protobuf.TimestampOrBuilder	getBeginCreatingTimeOrBuilder() Output only.
static AudienceList	getDefaultInstance()
AudienceList	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
AudienceDimension	getDimensions(int index) Required.
int	getDimensionsCount() Required.
List<AudienceDimension>	getDimensionsList() Required.
AudienceDimensionOrBuilder	getDimensionsOrBuilder(int index) Required.
List<? extends AudienceDimensionOrBuilder>	getDimensionsOrBuilderList() Required.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.Parser<AudienceList>	getParserForType()
int	getSerializedSize()
AudienceList.State	getState() Output only.
int	getStateValue() Output only.
boolean	hasBeginCreatingTime() Output only.
int	hashCode()
boolean	hasState() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AudienceList.Builder	newBuilder()
static AudienceList.Builder	newBuilder(AudienceList prototype)
AudienceList.Builder	newBuilderForType()
protected AudienceList.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AudienceList	parseDelimitedFrom(InputStream input)
static AudienceList	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudienceList	parseFrom(byte[] data)
static AudienceList	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudienceList	parseFrom(ByteBuffer data)
static AudienceList	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudienceList	parseFrom(com.google.protobuf.ByteString data)
static AudienceList	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudienceList	parseFrom(com.google.protobuf.CodedInputStream input)
static AudienceList	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudienceList	parseFrom(InputStream input)
static AudienceList	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AudienceList>	parser()
AudienceList.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER

See Also:

Constant Field Values

AUDIENCE_DISPLAY_NAME_FIELD_NUMBER

public static final int AUDIENCE_DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

BEGIN_CREATING_TIME_FIELD_NUMBER

public static final int BEGIN_CREATING_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getName

public String getName()

 Output only. The audience list resource name assigned during creation. This
 resource name identifies this `AudienceList`.

 Format: `properties/{propertyId}/audienceLists/{audienceListId}`
 

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

Specified by:

getName in interface AudienceListOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. The audience list resource name assigned during creation. This
 resource name identifies this `AudienceList`.

 Format: `properties/{propertyId}/audienceLists/{audienceListId}`
 

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

Specified by:

getNameBytes in interface AudienceListOrBuilder

Returns:

The bytes for name.

getAudience

public String getAudience()

 Required. The audience resource name. This resource name identifies the
 audience being listed and is shared between the Analytics Data & Admin
 APIs.

 Format: `properties/{propertyId}/audiences/{audienceId}`
 

string audience = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getAudience in interface AudienceListOrBuilder

Returns:

The audience.

getAudienceBytes

public com.google.protobuf.ByteString getAudienceBytes()

 Required. The audience resource name. This resource name identifies the
 audience being listed and is shared between the Analytics Data & Admin
 APIs.

 Format: `properties/{propertyId}/audiences/{audienceId}`
 

string audience = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getAudienceBytes in interface AudienceListOrBuilder

Returns:

The bytes for audience.

getAudienceDisplayName

public String getAudienceDisplayName()

 Output only. The descriptive display name for this audience. For example,
 "Purchasers".
 

string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getAudienceDisplayName in interface AudienceListOrBuilder

Returns:

The audienceDisplayName.

getAudienceDisplayNameBytes

public com.google.protobuf.ByteString getAudienceDisplayNameBytes()

 Output only. The descriptive display name for this audience. For example,
 "Purchasers".
 

string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getAudienceDisplayNameBytes in interface AudienceListOrBuilder

Returns:

The bytes for audienceDisplayName.

getDimensionsList

public List<AudienceDimension> getDimensionsList()

 Required. The dimensions requested and displayed in the report response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensionsList in interface AudienceListOrBuilder

getDimensionsOrBuilderList

public List<? extends AudienceDimensionOrBuilder> getDimensionsOrBuilderList()

 Required. The dimensions requested and displayed in the report response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensionsOrBuilderList in interface AudienceListOrBuilder

getDimensionsCount

public int getDimensionsCount()

 Required. The dimensions requested and displayed in the report response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensionsCount in interface AudienceListOrBuilder

getDimensions

public AudienceDimension getDimensions(int index)

 Required. The dimensions requested and displayed in the report response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensions in interface AudienceListOrBuilder

getDimensionsOrBuilder

public AudienceDimensionOrBuilder getDimensionsOrBuilder(int index)

 Required. The dimensions requested and displayed in the report response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensionsOrBuilder in interface AudienceListOrBuilder

hasState

public boolean hasState()

 Output only. The current state for this AudienceList.
 

optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasState in interface AudienceListOrBuilder

Returns:

Whether the state field is set.

getStateValue

public int getStateValue()

 Output only. The current state for this AudienceList.
 

optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getStateValue in interface AudienceListOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public AudienceList.State getState()

 Output only. The current state for this AudienceList.
 

optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getState in interface AudienceListOrBuilder

Returns:

The state.

hasBeginCreatingTime

public boolean hasBeginCreatingTime()

 Output only. The time when CreateAudienceList was called and the
 AudienceList began the `CREATING` state.
 

optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasBeginCreatingTime in interface AudienceListOrBuilder

Returns:

Whether the beginCreatingTime field is set.

getBeginCreatingTime

public com.google.protobuf.Timestamp getBeginCreatingTime()

 Output only. The time when CreateAudienceList was called and the
 AudienceList began the `CREATING` state.
 

optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getBeginCreatingTime in interface AudienceListOrBuilder

Returns:

The beginCreatingTime.

getBeginCreatingTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getBeginCreatingTimeOrBuilder()

 Output only. The time when CreateAudienceList was called and the
 AudienceList began the `CREATING` state.
 

optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getBeginCreatingTimeOrBuilder in interface AudienceListOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AudienceList parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudienceList parseFrom(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudienceList parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudienceList parseFrom(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudienceList parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudienceList parseFrom(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudienceList parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static AudienceList parseFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static AudienceList parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static AudienceList parseDelimitedFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static AudienceList parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static AudienceList parseFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public AudienceList.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AudienceList.Builder newBuilder()

newBuilder

public static AudienceList.Builder newBuilder(AudienceList prototype)

toBuilder

public AudienceList.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AudienceList.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AudienceList getDefaultInstance()

parser

public static com.google.protobuf.Parser<AudienceList> parser()

getParserForType

public com.google.protobuf.Parser<AudienceList> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AudienceList getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder