Send feedback
Class Role (0.29.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class Role extends GeneratedMessageV3 implements RoleOrBuilder
The Role resource.
Protobuf type google.ads.admanager.v1.Role
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BUILT_IN_FIELD_NUMBER
public static final int BUILT_IN_FIELD_NUMBER
Field Value
Type Description
int
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
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
ROLE_ID_FIELD_NUMBER
public static final int ROLE_ID_FIELD_NUMBER
Field Value
Type Description
int
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Role getDefaultInstance ()
Returns
Type Description
Role
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Role . Builder newBuilder ()
newBuilder(Role prototype)
public static Role . Builder newBuilder ( Role prototype )
Parameter
Name Description
prototypeRole
public static Role parseDelimitedFrom ( InputStream input )
Returns
Type Description
Role
public static Role parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Role
parseFrom(byte[] data)
public static Role parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Role
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Role parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Role
parseFrom(ByteString data)
public static Role parseFrom ( ByteString data )
Returns
Type Description
Role
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Role parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Role
public static Role parseFrom ( CodedInputStream input )
Returns
Type Description
Role
public static Role parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Role
public static Role parseFrom ( InputStream input )
Returns
Type Description
Role
public static Role parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Role
parseFrom(ByteBuffer data)
public static Role parseFrom ( ByteBuffer data )
Returns
Type Description
Role
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Role parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Role
parser()
public static Parser<Role> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getBuiltIn()
public boolean getBuiltIn ()
Output only. Whether the Role is a built-in or custom user role.
optional bool built_in = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean The builtIn.
getDefaultInstanceForType()
public Role getDefaultInstanceForType ()
Returns
Type Description
Role
getDescription()
public String getDescription ()
Optional. The description of the Role.
optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
Optional. The description of the Role.
optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for description.
getDisplayName()
public String getDisplayName ()
Required. The display name of the Role.
optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
Required. The display name of the Role.
optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for displayName.
getName()
Identifier. The resource name of the Role.
Format: networks/{network_code}/roles/{role_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Identifier. The resource name of the Role.
Format: networks/{network_code}/roles/{role_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<Role> getParserForType ()
Overrides
getRoleId()
Output only. Role ID.
optional int64 role_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
long The roleId.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getStatus()
public RoleStatusEnum . RoleStatus getStatus ()
Output only. The status of the Role.
optional .google.ads.admanager.v1.RoleStatusEnum.RoleStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatusValue()
public int getStatusValue ()
Output only. The status of the Role.
optional .google.ads.admanager.v1.RoleStatusEnum.RoleStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
int The enum numeric value on the wire for status.
hasBuiltIn()
public boolean hasBuiltIn ()
Output only. Whether the Role is a built-in or custom user role.
optional bool built_in = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the builtIn field is set.
hasDescription()
public boolean hasDescription ()
Optional. The description of the Role.
optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the description field is set.
hasDisplayName()
public boolean hasDisplayName ()
Required. The display name of the Role.
optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
boolean Whether the displayName field is set.
hasRoleId()
public boolean hasRoleId ()
Output only. Role ID.
optional int64 role_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the roleId field is set.
hasStatus()
public boolean hasStatus ()
Output only. The status of the Role.
optional .google.ads.admanager.v1.RoleStatusEnum.RoleStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the status field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Role . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Role . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Role . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["The webpage provides documentation for the `Role` class within the Google Ad Manager API's Java library, detailing its structure and functionality."],["The latest version of the `Role` class documentation is version 0.19.0, with links to previous versions ranging from 0.18.0 down to 0.1.0."],["The `Role` class extends `GeneratedMessageV3` and implements `RoleOrBuilder`, inheriting numerous methods for message management and field access."],["The documentation lists static fields for various attributes of the `Role` class, such as `BUILT_IN_FIELD_NUMBER`, `DESCRIPTION_FIELD_NUMBER`, `DISPLAY_NAME_FIELD_NUMBER`, `NAME_FIELD_NUMBER`, `ROLE_ID_FIELD_NUMBER`, and `STATUS_FIELD_NUMBER`."],["The class has many methods that allow for interactions, including static methods for creating instances and parsing data, and instance methods to get various properties, including the role's ID, name, and status."]]],[]]
