Class ChannelGroup (0.56.0)

public final class ChannelGroup extends GeneratedMessageV3 implements ChannelGroupOrBuilder

A resource message representing a Channel Group.

Protobuf type google.analytics.admin.v1alpha.ChannelGroup

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

GROUPING_RULE_FIELD_NUMBER

public static final int GROUPING_RULE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SYSTEM_DEFINED_FIELD_NUMBER

public static final int SYSTEM_DEFINED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ChannelGroup getDefaultInstance()
Returns
Type Description
ChannelGroup

getDescriptor()

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

newBuilder()

public static ChannelGroup.Builder newBuilder()
Returns
Type Description
ChannelGroup.Builder

newBuilder(ChannelGroup prototype)

public static ChannelGroup.Builder newBuilder(ChannelGroup prototype)
Parameter
Name Description
prototype ChannelGroup
Returns
Type Description
ChannelGroup.Builder

parseDelimitedFrom(InputStream input)

public static ChannelGroup parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ChannelGroup
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ChannelGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChannelGroup
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ChannelGroup parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ChannelGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ChannelGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChannelGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ChannelGroup parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ChannelGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ChannelGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChannelGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ChannelGroup parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ChannelGroup
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ChannelGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChannelGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ChannelGroup parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ChannelGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ChannelGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChannelGroup
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ChannelGroup parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ChannelGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ChannelGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChannelGroup
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ChannelGroup> parser()
Returns
Type Description
Parser<ChannelGroup>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ChannelGroup getDefaultInstanceForType()
Returns
Type Description
ChannelGroup

getDescription()

public String getDescription()

The description of the Channel Group. Max length of 256 characters.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the Channel Group. Max length of 256 characters.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. The display name of the Channel Group. Max length of 80 characters.

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 Channel Group. Max length of 80 characters.

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

Returns
Type Description
ByteString

The bytes for displayName.

getGroupingRule(int index)

public GroupingRule getGroupingRule(int index)

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
GroupingRule

getGroupingRuleCount()

public int getGroupingRuleCount()

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getGroupingRuleList()

public List<GroupingRule> getGroupingRuleList()

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<GroupingRule>

getGroupingRuleOrBuilder(int index)

public GroupingRuleOrBuilder getGroupingRuleOrBuilder(int index)

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
GroupingRuleOrBuilder

getGroupingRuleOrBuilderList()

public List<? extends GroupingRuleOrBuilder> getGroupingRuleOrBuilderList()

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.analytics.admin.v1alpha.GroupingRuleOrBuilder>

getName()

public String getName()

Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}

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 Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ChannelGroup> getParserForType()
Returns
Type Description
Parser<ChannelGroup>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSystemDefined()

public boolean getSystemDefined()

Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.

bool system_defined = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The systemDefined.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ChannelGroup.Builder newBuilderForType()
Returns
Type Description
ChannelGroup.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ChannelGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ChannelGroup.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ChannelGroup.Builder toBuilder()
Returns
Type Description
ChannelGroup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException