Console
    Contact Us Start free

    Class Role (0.32.0) 

      public 
  
 final 
  
 class 
 Role 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 RoleOrBuilder

    The Role resource.

    Protobuf type google.ads.admanager.v1.Role

    Inheritance

    Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Role

    Implements

    RoleOrBuilder

    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 
 ()
    Returns
    Type
    Description
    Descriptor

    newBuilder()

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

    newBuilder(Role prototype)

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

    parseDelimitedFrom(InputStream input)

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

    parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

    parseFrom(byte[] data)

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

    parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

    parseFrom(ByteString data)

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

    parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

    parseFrom(CodedInputStream input)

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

    parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

    parseFrom(InputStream input)

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

    parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

    parseFrom(ByteBuffer data)

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

    parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

    parser()

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

    Methods

    equals(Object obj)

      public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 )
    Parameter
    Name
    Description
    obj
    Object
    Returns
    Type
    Description
    boolean
    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()

      public 
  
 String 
  
 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 
 ()
    Returns
    Type
    Description
    Parser < Role >
    Overrides

    getRoleId()

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

    Returns
    Type
    Description
    RoleStatusEnum.RoleStatus

    The status.

    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()

      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 
  
 Role 
 . 
 Builder 
  
 newBuilderForType 
 ()
    Returns
    Type
    Description
    Role.Builder

    newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

    newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

    toBuilder()

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

    writeTo(CodedOutputStream output)

      public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 )
    Parameter
    Name
    Description
    output
    CodedOutputStream
    Overrides
    Exceptions
    Type
    Description
    IOException
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: