Class UserGroup.Builder (0.48.0)

public static final class UserGroup.Builder extends GeneratedMessage.Builder<UserGroup.Builder> implements UserGroupOrBuilder

A resource message representing a user group in a GMP organization.

Protobuf type google.marketingplatform.admin.v1alpha.UserGroup

Implements

UserGroupOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public UserGroup build()
Returns
Type Description
UserGroup

buildPartial()

public UserGroup buildPartial()
Returns
Type Description
UserGroup

clear()

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

clearDescription()

public UserGroup.Builder clearDescription()

Optional. The description of the user group.

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

Returns
Type Description
UserGroup.Builder

This builder for chaining.

clearDisplayName()

public UserGroup.Builder clearDisplayName()

Optional. The human-readable name for the user group.

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

Returns
Type Description
UserGroup.Builder

This builder for chaining.

clearName()

public UserGroup.Builder clearName()

Identifier. Resource name of this UserGroup.

Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"

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

Returns
Type Description
UserGroup.Builder

This builder for chaining.

getDefaultInstanceForType()

public UserGroup getDefaultInstanceForType()
Returns
Type Description
UserGroup

getDescription()

public String getDescription()

Optional. The description of the user group.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the user group.

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

getDisplayName()

public String getDisplayName()

Optional. The human-readable name for the user group.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The human-readable name for the user group.

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

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. Resource name of this UserGroup.

Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name of this UserGroup.

Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"

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

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UserGroup other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setDescription(String value)

public UserGroup.Builder setDescription(String value)

Optional. The description of the user group.

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
UserGroup.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public UserGroup.Builder setDescriptionBytes(ByteString value)

Optional. The description of the user group.

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
UserGroup.Builder

This builder for chaining.

setDisplayName(String value)

public UserGroup.Builder setDisplayName(String value)

Optional. The human-readable name for the user group.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
UserGroup.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public UserGroup.Builder setDisplayNameBytes(ByteString value)

Optional. The human-readable name for the user group.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
UserGroup.Builder

This builder for chaining.

setName(String value)

public UserGroup.Builder setName(String value)

Identifier. Resource name of this UserGroup.

Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
UserGroup.Builder

This builder for chaining.

setNameBytes(ByteString value)

public UserGroup.Builder setNameBytes(ByteString value)

Identifier. Resource name of this UserGroup.

Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
UserGroup.Builder

This builder for chaining.