Class AudienceList.Builder (0.32.0)

public static final class AudienceList.Builder extends GeneratedMessageV3.Builder<AudienceList.Builder> 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

Static Methods

getDescriptor()

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

Methods

addAllDimensions(Iterable<? extends AudienceDimension> values)

public AudienceList.Builder addAllDimensions(Iterable<? extends AudienceDimension> values)

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.analytics.data.v1alpha.AudienceDimension>
Returns
TypeDescription
AudienceList.Builder

addDimensions(AudienceDimension value)

public AudienceList.Builder addDimensions(AudienceDimension value)

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

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

Parameter
NameDescription
valueAudienceDimension
Returns
TypeDescription
AudienceList.Builder

addDimensions(AudienceDimension.Builder builderForValue)

public AudienceList.Builder addDimensions(AudienceDimension.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueAudienceDimension.Builder
Returns
TypeDescription
AudienceList.Builder

addDimensions(int index, AudienceDimension value)

public AudienceList.Builder addDimensions(int index, AudienceDimension value)

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

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

Parameters
NameDescription
indexint
valueAudienceDimension
Returns
TypeDescription
AudienceList.Builder

addDimensions(int index, AudienceDimension.Builder builderForValue)

public AudienceList.Builder addDimensions(int index, AudienceDimension.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueAudienceDimension.Builder
Returns
TypeDescription
AudienceList.Builder

addDimensionsBuilder()

public AudienceDimension.Builder addDimensionsBuilder()

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

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

Returns
TypeDescription
AudienceDimension.Builder

addDimensionsBuilder(int index)

public AudienceDimension.Builder addDimensionsBuilder(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
AudienceDimension.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AudienceList.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AudienceList.Builder
Overrides

build()

public AudienceList build()
Returns
TypeDescription
AudienceList

buildPartial()

public AudienceList buildPartial()
Returns
TypeDescription
AudienceList

clear()

public AudienceList.Builder clear()
Returns
TypeDescription
AudienceList.Builder
Overrides

clearAudience()

public AudienceList.Builder clearAudience()

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];

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

clearAudienceDisplayName()

public AudienceList.Builder clearAudienceDisplayName()

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

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

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

clearBeginCreatingTime()

public AudienceList.Builder clearBeginCreatingTime()

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];

Returns
TypeDescription
AudienceList.Builder

clearDimensions()

public AudienceList.Builder clearDimensions()

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

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

Returns
TypeDescription
AudienceList.Builder

clearField(Descriptors.FieldDescriptor field)

public AudienceList.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AudienceList.Builder
Overrides

clearName()

public AudienceList.Builder clearName()

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];

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AudienceList.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AudienceList.Builder
Overrides

clearState()

public AudienceList.Builder clearState()

Output only. The current state for this AudienceList.

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

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

clone()

public AudienceList.Builder clone()
Returns
TypeDescription
AudienceList.Builder
Overrides

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];

Returns
TypeDescription
String

The audience.

getAudienceBytes()

public 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];

Returns
TypeDescription
ByteString

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];

Returns
TypeDescription
String

The audienceDisplayName.

getAudienceDisplayNameBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for audienceDisplayName.

getBeginCreatingTime()

public 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];

Returns
TypeDescription
Timestamp

The beginCreatingTime.

getBeginCreatingTimeBuilder()

public Timestamp.Builder getBeginCreatingTimeBuilder()

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];

Returns
TypeDescription
Builder

getBeginCreatingTimeOrBuilder()

public 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];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public AudienceList getDefaultInstanceForType()
Returns
TypeDescription
AudienceList

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDimensions(int index)

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
AudienceDimension

getDimensionsBuilder(int index)

public AudienceDimension.Builder getDimensionsBuilder(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
AudienceDimension.Builder

getDimensionsBuilderList()

public List<AudienceDimension.Builder> getDimensionsBuilderList()

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

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

Returns
TypeDescription
List<Builder>

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];

Returns
TypeDescription
int

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];

Returns
TypeDescription
List<AudienceDimension>

getDimensionsOrBuilder(int index)

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
AudienceDimensionOrBuilder

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];

Returns
TypeDescription
List<? extends com.google.analytics.data.v1alpha.AudienceDimensionOrBuilder>

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];

Returns
TypeDescription
String

The name.

getNameBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for name.

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];

Returns
TypeDescription
AudienceList.State

The state.

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];

Returns
TypeDescription
int

The enum numeric value on the wire for 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];

Returns
TypeDescription
boolean

Whether the beginCreatingTime field is set.

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];

Returns
TypeDescription
boolean

Whether the state field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBeginCreatingTime(Timestamp value)

public AudienceList.Builder mergeBeginCreatingTime(Timestamp value)

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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
AudienceList.Builder

mergeFrom(AudienceList other)

public AudienceList.Builder mergeFrom(AudienceList other)
Parameter
NameDescription
otherAudienceList
Returns
TypeDescription
AudienceList.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AudienceList.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudienceList.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AudienceList.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AudienceList.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AudienceList.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AudienceList.Builder
Overrides

removeDimensions(int index)

public AudienceList.Builder removeDimensions(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
AudienceList.Builder

setAudience(String value)

public AudienceList.Builder setAudience(String value)

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];

Parameter
NameDescription
valueString

The audience to set.

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

setAudienceBytes(ByteString value)

public AudienceList.Builder setAudienceBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for audience to set.

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

setAudienceDisplayName(String value)

public AudienceList.Builder setAudienceDisplayName(String value)

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

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

Parameter
NameDescription
valueString

The audienceDisplayName to set.

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

setAudienceDisplayNameBytes(ByteString value)

public AudienceList.Builder setAudienceDisplayNameBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for audienceDisplayName to set.

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

setBeginCreatingTime(Timestamp value)

public AudienceList.Builder setBeginCreatingTime(Timestamp value)

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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
AudienceList.Builder

setBeginCreatingTime(Timestamp.Builder builderForValue)

public AudienceList.Builder setBeginCreatingTime(Timestamp.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
AudienceList.Builder

setDimensions(int index, AudienceDimension value)

public AudienceList.Builder setDimensions(int index, AudienceDimension value)

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

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

Parameters
NameDescription
indexint
valueAudienceDimension
Returns
TypeDescription
AudienceList.Builder

setDimensions(int index, AudienceDimension.Builder builderForValue)

public AudienceList.Builder setDimensions(int index, AudienceDimension.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueAudienceDimension.Builder
Returns
TypeDescription
AudienceList.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AudienceList.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AudienceList.Builder
Overrides

setName(String value)

public AudienceList.Builder setName(String value)

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];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AudienceList.Builder setNameBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AudienceList.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AudienceList.Builder
Overrides

setState(AudienceList.State value)

public AudienceList.Builder setState(AudienceList.State value)

Output only. The current state for this AudienceList.

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

Parameter
NameDescription
valueAudienceList.State

The state to set.

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

setStateValue(int value)

public AudienceList.Builder setStateValue(int value)

Output only. The current state for this AudienceList.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
AudienceList.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AudienceList.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AudienceList.Builder
Overrides