Class ChannelGroup.Builder (0.63.0)

public static final class ChannelGroup.Builder extends GeneratedMessageV3.Builder<ChannelGroup.Builder> implements ChannelGroupOrBuilder

A resource message representing a Channel Group.

Protobuf type google.analytics.admin.v1alpha.ChannelGroup

Static Methods

getDescriptor()

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

Methods

addAllGroupingRule(Iterable<? extends GroupingRule> values)

public ChannelGroup.Builder addAllGroupingRule(Iterable<? extends GroupingRule> values)

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
values Iterable<? extends com.google.analytics.admin.v1alpha.GroupingRule>
Returns
Type Description
ChannelGroup.Builder

addGroupingRule(GroupingRule value)

public ChannelGroup.Builder addGroupingRule(GroupingRule value)

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
value GroupingRule
Returns
Type Description
ChannelGroup.Builder

addGroupingRule(GroupingRule.Builder builderForValue)

public ChannelGroup.Builder addGroupingRule(GroupingRule.Builder builderForValue)

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
builderForValue GroupingRule.Builder
Returns
Type Description
ChannelGroup.Builder

addGroupingRule(int index, GroupingRule value)

public ChannelGroup.Builder addGroupingRule(int index, GroupingRule value)

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

Parameters
Name Description
index int
value GroupingRule
Returns
Type Description
ChannelGroup.Builder

addGroupingRule(int index, GroupingRule.Builder builderForValue)

public ChannelGroup.Builder addGroupingRule(int index, GroupingRule.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue GroupingRule.Builder
Returns
Type Description
ChannelGroup.Builder

addGroupingRuleBuilder()

public GroupingRule.Builder addGroupingRuleBuilder()

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
GroupingRule.Builder

addGroupingRuleBuilder(int index)

public GroupingRule.Builder addGroupingRuleBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ChannelGroup build()
Returns
Type Description
ChannelGroup

buildPartial()

public ChannelGroup buildPartial()
Returns
Type Description
ChannelGroup

clear()

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

clearDescription()

public ChannelGroup.Builder clearDescription()

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

string description = 3;

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

clearDisplayName()

public ChannelGroup.Builder clearDisplayName()

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
ChannelGroup.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearGroupingRule()

public ChannelGroup.Builder clearGroupingRule()

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
ChannelGroup.Builder

clearName()

public ChannelGroup.Builder clearName()

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
ChannelGroup.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPrimary()

public ChannelGroup.Builder clearPrimary()

Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as primary at any time. If the primary field gets set on a channel group, it will get unset on the previous primary channel group.

The Google Analytics predefined channel group is the primary by default.

bool primary = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

clearSystemDefined()

public ChannelGroup.Builder clearSystemDefined()

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
ChannelGroup.Builder

This builder for chaining.

clone()

public ChannelGroup.Builder clone()
Returns
Type Description
ChannelGroup.Builder
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.

getDescriptorForType()

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

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

getGroupingRuleBuilder(int index)

public GroupingRule.Builder getGroupingRuleBuilder(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.Builder

getGroupingRuleBuilderList()

public List<GroupingRule.Builder> getGroupingRuleBuilderList()

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<Builder>

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.

getPrimary()

public boolean getPrimary()

Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as primary at any time. If the primary field gets set on a channel group, it will get unset on the previous primary channel group.

The Google Analytics predefined channel group is the primary by default.

bool primary = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The primary.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ChannelGroup other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeGroupingRule(int index)

public ChannelGroup.Builder removeGroupingRule(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
ChannelGroup.Builder

setDescription(String value)

public ChannelGroup.Builder setDescription(String value)

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

string description = 3;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public ChannelGroup.Builder setDescriptionBytes(ByteString value)

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

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

setDisplayName(String value)

public ChannelGroup.Builder setDisplayName(String value)

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

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ChannelGroup.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setGroupingRule(int index, GroupingRule value)

public ChannelGroup.Builder setGroupingRule(int index, GroupingRule value)

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

Parameters
Name Description
index int
value GroupingRule
Returns
Type Description
ChannelGroup.Builder

setGroupingRule(int index, GroupingRule.Builder builderForValue)

public ChannelGroup.Builder setGroupingRule(int index, GroupingRule.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue GroupingRule.Builder
Returns
Type Description
ChannelGroup.Builder

setName(String value)

public ChannelGroup.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ChannelGroup.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

setPrimary(boolean value)

public ChannelGroup.Builder setPrimary(boolean value)

Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as primary at any time. If the primary field gets set on a channel group, it will get unset on the previous primary channel group.

The Google Analytics predefined channel group is the primary by default.

bool primary = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The primary to set.

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

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

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

setSystemDefined(boolean value)

public ChannelGroup.Builder setSystemDefined(boolean value)

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

Parameter
Name Description
value boolean

The systemDefined to set.

Returns
Type Description
ChannelGroup.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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