Class ExpandedDataSet.Builder (0.56.0) 

public static final class ExpandedDataSet.Builder extends GeneratedMessageV3.Builder<ExpandedDataSet.Builder> implements ExpandedDataSetOrBuilder

A resource message representing a GA4 ExpandedDataSet.

Protobuf type google.analytics.admin.v1alpha.ExpandedDataSet

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExpandedDataSet.Builder

Static Methods

getDescriptor()

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

Methods

addAllDimensionNames(Iterable<String> values)

public ExpandedDataSet.Builder addAllDimensionNames(Iterable<String> values)

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
values Iterable<String>

The dimensionNames to add.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

addAllMetricNames(Iterable<String> values)

public ExpandedDataSet.Builder addAllMetricNames(Iterable<String> values)

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
values Iterable<String>

The metricNames to add.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

addDimensionNames(String value)

public ExpandedDataSet.Builder addDimensionNames(String value)

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The dimensionNames to add.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

addDimensionNamesBytes(ByteString value)

public ExpandedDataSet.Builder addDimensionNamesBytes(ByteString value)

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes of the dimensionNames to add.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

addMetricNames(String value)

public ExpandedDataSet.Builder addMetricNames(String value)

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The metricNames to add.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

addMetricNamesBytes(ByteString value)

public ExpandedDataSet.Builder addMetricNamesBytes(ByteString value)

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes of the metricNames to add.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExpandedDataSet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExpandedDataSet.Builder
Overrides

build()

public ExpandedDataSet build()
Returns
Type Description
ExpandedDataSet

buildPartial()

public ExpandedDataSet buildPartial()
Returns
Type Description
ExpandedDataSet

clear()

public ExpandedDataSet.Builder clear()
Returns
Type Description
ExpandedDataSet.Builder
Overrides

clearDataCollectionStartTime()

public ExpandedDataSet.Builder clearDataCollectionStartTime()

Output only. Time when expanded data set began (or will begin) collecing data.

.google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ExpandedDataSet.Builder

clearDescription()

public ExpandedDataSet.Builder clearDescription()

Optional. The description of the ExpandedDataSet. Max 50 chars.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

clearDimensionFilterExpression()

public ExpandedDataSet.Builder clearDimensionFilterExpression()

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ExpandedDataSet.Builder

clearDimensionNames()

public ExpandedDataSet.Builder clearDimensionNames()

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

clearDisplayName()

public ExpandedDataSet.Builder clearDisplayName()

Required. The display name of the ExpandedDataSet. Max 200 chars.

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

Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExpandedDataSet.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExpandedDataSet.Builder
Overrides

clearMetricNames()

public ExpandedDataSet.Builder clearMetricNames()

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

clearName()

public ExpandedDataSet.Builder clearName()

Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

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

Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExpandedDataSet.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExpandedDataSet.Builder
Overrides

clone()

public ExpandedDataSet.Builder clone()
Returns
Type Description
ExpandedDataSet.Builder
Overrides

getDataCollectionStartTime()

public Timestamp getDataCollectionStartTime()

Output only. Time when expanded data set began (or will begin) collecing data.

.google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The dataCollectionStartTime.

getDataCollectionStartTimeBuilder()

public Timestamp.Builder getDataCollectionStartTimeBuilder()

Output only. Time when expanded data set began (or will begin) collecing data.

.google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDataCollectionStartTimeOrBuilder()

public TimestampOrBuilder getDataCollectionStartTimeOrBuilder()

Output only. Time when expanded data set began (or will begin) collecing data.

.google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ExpandedDataSet getDefaultInstanceForType()
Returns
Type Description
ExpandedDataSet

getDescription()

public String getDescription()

Optional. The description of the ExpandedDataSet. Max 50 chars.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the ExpandedDataSet. Max 50 chars.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDimensionFilterExpression()

public ExpandedDataSetFilterExpression getDimensionFilterExpression()

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ExpandedDataSetFilterExpression

The dimensionFilterExpression.

getDimensionFilterExpressionBuilder()

public ExpandedDataSetFilterExpression.Builder getDimensionFilterExpressionBuilder()

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ExpandedDataSetFilterExpression.Builder

getDimensionFilterExpressionOrBuilder()

public ExpandedDataSetFilterExpressionOrBuilder getDimensionFilterExpressionOrBuilder()

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ExpandedDataSetFilterExpressionOrBuilder

getDimensionNames(int index)

public String getDimensionNames(int index)

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The dimensionNames at the given index.

getDimensionNamesBytes(int index)

public ByteString getDimensionNamesBytes(int index)

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the dimensionNames at the given index.

getDimensionNamesCount()

public int getDimensionNamesCount()

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The count of dimensionNames.

getDimensionNamesList()

public ProtocolStringList getDimensionNamesList()

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ProtocolStringList

A list containing the dimensionNames.

getDisplayName()

public String getDisplayName()

Required. The display name of the ExpandedDataSet. Max 200 chars.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the ExpandedDataSet. Max 200 chars.

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

Returns
Type Description
ByteString

The bytes for displayName.

getMetricNames(int index)

public String getMetricNames(int index)

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The metricNames at the given index.

getMetricNamesBytes(int index)

public ByteString getMetricNamesBytes(int index)

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the metricNames at the given index.

getMetricNamesCount()

public int getMetricNamesCount()

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The count of metricNames.

getMetricNamesList()

public ProtocolStringList getMetricNamesList()

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ProtocolStringList

A list containing the metricNames.

getName()

public String getName()

Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

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

Returns
Type Description
ByteString

The bytes for name.

hasDataCollectionStartTime()

public boolean hasDataCollectionStartTime()

Output only. Time when expanded data set began (or will begin) collecing data.

.google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dataCollectionStartTime field is set.

hasDimensionFilterExpression()

public boolean hasDimensionFilterExpression()

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the dimensionFilterExpression field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDataCollectionStartTime(Timestamp value)

public ExpandedDataSet.Builder mergeDataCollectionStartTime(Timestamp value)

Output only. Time when expanded data set began (or will begin) collecing data.

.google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ExpandedDataSet.Builder

mergeDimensionFilterExpression(ExpandedDataSetFilterExpression value)

public ExpandedDataSet.Builder mergeDimensionFilterExpression(ExpandedDataSetFilterExpression value)

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ExpandedDataSetFilterExpression
Returns
Type Description
ExpandedDataSet.Builder

mergeFrom(ExpandedDataSet other)

public ExpandedDataSet.Builder mergeFrom(ExpandedDataSet other)
Parameter
Name Description
other ExpandedDataSet
Returns
Type Description
ExpandedDataSet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExpandedDataSet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExpandedDataSet.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExpandedDataSet.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExpandedDataSet.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExpandedDataSet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExpandedDataSet.Builder
Overrides

setDataCollectionStartTime(Timestamp value)

public ExpandedDataSet.Builder setDataCollectionStartTime(Timestamp value)

Output only. Time when expanded data set began (or will begin) collecing data.

.google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ExpandedDataSet.Builder

setDataCollectionStartTime(Timestamp.Builder builderForValue)

public ExpandedDataSet.Builder setDataCollectionStartTime(Timestamp.Builder builderForValue)

Output only. Time when expanded data set began (or will begin) collecing data.

.google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExpandedDataSet.Builder

setDescription(String value)

public ExpandedDataSet.Builder setDescription(String value)

Optional. The description of the ExpandedDataSet. Max 50 chars.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public ExpandedDataSet.Builder setDescriptionBytes(ByteString value)

Optional. The description of the ExpandedDataSet. Max 50 chars.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

setDimensionFilterExpression(ExpandedDataSetFilterExpression value)

public ExpandedDataSet.Builder setDimensionFilterExpression(ExpandedDataSetFilterExpression value)

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ExpandedDataSetFilterExpression
Returns
Type Description
ExpandedDataSet.Builder

setDimensionFilterExpression(ExpandedDataSetFilterExpression.Builder builderForValue)

public ExpandedDataSet.Builder setDimensionFilterExpression(ExpandedDataSetFilterExpression.Builder builderForValue)

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue ExpandedDataSetFilterExpression.Builder
Returns
Type Description
ExpandedDataSet.Builder

setDimensionNames(int index, String value)

public ExpandedDataSet.Builder setDimensionNames(int index, String value)

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];

Parameters
Name Description
index int

The index to set the value at.
value String

The dimensionNames to set.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

setDisplayName(String value)

public ExpandedDataSet.Builder setDisplayName(String value)

Required. The display name of the ExpandedDataSet. Max 200 chars.

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

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ExpandedDataSet.Builder setDisplayNameBytes(ByteString value)

Required. The display name of the ExpandedDataSet. Max 200 chars.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExpandedDataSet.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExpandedDataSet.Builder
Overrides

setMetricNames(int index, String value)

public ExpandedDataSet.Builder setMetricNames(int index, String value)

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameters
Name Description
index int

The index to set the value at.
value String

The metricNames to set.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

setName(String value)

public ExpandedDataSet.Builder setName(String value)

Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ExpandedDataSet.Builder setNameBytes(ByteString value)

Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
ExpandedDataSet.Builder

This builder for chaining.

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

public ExpandedDataSet.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExpandedDataSet.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExpandedDataSet.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExpandedDataSet.Builder
Overrides