Class ExpandedDataSet (0.23.0)

public final class ExpandedDataSet extends GeneratedMessageV3 implements ExpandedDataSetOrBuilder

A resource message representing a GA4 ExpandedDataSet.

Protobuf type google.analytics.admin.v1alpha.ExpandedDataSet

Static Fields

DATA_COLLECTION_START_TIME_FIELD_NUMBER

public static final int DATA_COLLECTION_START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSION_FILTER_EXPRESSION_FIELD_NUMBER

public static final int DIMENSION_FILTER_EXPRESSION_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSION_NAMES_FIELD_NUMBER

public static final int DIMENSION_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_NAMES_FIELD_NUMBER

public static final int METRIC_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExpandedDataSet getDefaultInstance()
Returns
TypeDescription
ExpandedDataSet

getDescriptor()

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

newBuilder()

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

newBuilder(ExpandedDataSet prototype)

public static ExpandedDataSet.Builder newBuilder(ExpandedDataSet prototype)
Parameter
NameDescription
prototypeExpandedDataSet
Returns
TypeDescription
ExpandedDataSet.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
Timestamp

The dataCollectionStartTime.

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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ExpandedDataSet getDefaultInstanceForType()
Returns
TypeDescription
ExpandedDataSet

getDescription()

public String getDescription()

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

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

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

The bytes for description.

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 change of encountering other row.

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

Returns
TypeDescription
ExpandedDataSetFilterExpression

The dimensionFilterExpression.

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 change of encountering other row.

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

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

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

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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 change of encountering other row.

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

Returns
TypeDescription
boolean

Whether the dimensionFilterExpression field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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