Package com.google.iam.admin.v1

Class Role

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.iam.admin.v1.Role
All Implemented Interfaces:
RoleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Role extends com.google.protobuf.GeneratedMessage implements RoleOrBuilder
 A role in the Identity and Access Management API.
Protobuf type google.iam.admin.v1.Role
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Role.Builder
    A role in the Identity and Access Management API.
    static enum 
    Role.RoleLaunchStage
    A stage representing a role's lifecycle phase.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DELETED_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    ETAG_FIELD_NUMBER
     
    static final int
    INCLUDED_PERMISSIONS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    STAGE_FIELD_NUMBER
     
    static final int
    TITLE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Role
    getDefaultInstance()
     
    Role
    getDefaultInstanceForType()
     
    boolean
    getDeleted()
    The current deleted state of the role.
    String
    getDescription()
    Optional.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Optional.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.ByteString
    getEtag()
    Used to perform a consistent read-modify-write.
    String
    getIncludedPermissions(int index)
    The names of the permissions this role grants when bound in an IAM policy.
    com.google.protobuf.ByteString
    getIncludedPermissionsBytes(int index)
    The names of the permissions this role grants when bound in an IAM policy.
    int
    getIncludedPermissionsCount()
    The names of the permissions this role grants when bound in an IAM policy.
    com.google.protobuf.ProtocolStringList
    getIncludedPermissionsList()
    The names of the permissions this role grants when bound in an IAM policy.
    String
    getName()
    The name of the role.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the role.
    com.google.protobuf.Parser<Role>
    getParserForType()
     
    int
    getSerializedSize()
     
    Role.RoleLaunchStage
    getStage()
    The current launch stage of the role.
    int
    getStageValue()
    The current launch stage of the role.
    String
    getTitle()
    Optional.
    com.google.protobuf.ByteString
    getTitleBytes()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Role.Builder
    newBuilder()
     
    static Role.Builder
    newBuilder(Role prototype)
     
    Role.Builder
    newBuilderForType()
     
    protected Role.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Role
    parseDelimitedFrom(InputStream input)
     
    static Role
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Role
    parseFrom(byte[] data)
     
    static Role
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Role
    parseFrom(com.google.protobuf.ByteString data)
     
    static Role
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Role
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Role
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Role
    parseFrom(InputStream input)
     
    static Role
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Role
    parseFrom(ByteBuffer data)
     
    static Role
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Role>
    parser()
     
    Role.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       The name of the role.

 When Role is used in CreateRole, the role name must not be set.

 When Role is used in output and other input such as UpdateRole, the role
 name is the complete path, e.g., roles/logging.viewer for predefined roles
 and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
      string name = 1;
      Specified by:
      getName in interface RoleOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the role.

 When Role is used in CreateRole, the role name must not be set.

 When Role is used in output and other input such as UpdateRole, the role
 name is the complete path, e.g., roles/logging.viewer for predefined roles
 and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
      string name = 1;
      Specified by:
      getNameBytes in interface RoleOrBuilder
      Returns:
      The bytes for name.

    • getTitle

      public String getTitle()
       Optional. A human-readable title for the role.  Typically this
 is limited to 100 UTF-8 bytes.
      string title = 2;
      Specified by:
      getTitle in interface RoleOrBuilder
      Returns:
      The title.

    • getTitleBytes

      public com.google.protobuf.ByteString getTitleBytes()
       Optional. A human-readable title for the role.  Typically this
 is limited to 100 UTF-8 bytes.
      string title = 2;
      Specified by:
      getTitleBytes in interface RoleOrBuilder
      Returns:
      The bytes for title.

    • getDescription

      public String getDescription()
       Optional. A human-readable description for the role.
      string description = 3;
      Specified by:
      getDescription in interface RoleOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A human-readable description for the role.
      string description = 3;
      Specified by:
      getDescriptionBytes in interface RoleOrBuilder
      Returns:
      The bytes for description.

    • getIncludedPermissionsList

      public com.google.protobuf.ProtocolStringList getIncludedPermissionsList()
       The names of the permissions this role grants when bound in an IAM policy.
      repeated string included_permissions = 7;
      Specified by:
      getIncludedPermissionsList in interface RoleOrBuilder
      Returns:
      A list containing the includedPermissions.

    • getIncludedPermissionsCount

      public int getIncludedPermissionsCount()
       The names of the permissions this role grants when bound in an IAM policy.
      repeated string included_permissions = 7;
      Specified by:
      getIncludedPermissionsCount in interface RoleOrBuilder
      Returns:
      The count of includedPermissions.

    • getIncludedPermissions

      public String getIncludedPermissions(int index)
       The names of the permissions this role grants when bound in an IAM policy.
      repeated string included_permissions = 7;
      Specified by:
      getIncludedPermissions in interface RoleOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The includedPermissions at the given index.

    • getIncludedPermissionsBytes

      public com.google.protobuf.ByteString getIncludedPermissionsBytes(int index)
       The names of the permissions this role grants when bound in an IAM policy.
      repeated string included_permissions = 7;
      Specified by:
      getIncludedPermissionsBytes in interface RoleOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includedPermissions at the given index.

    • getStageValue

      public int getStageValue()
       The current launch stage of the role. If the `ALPHA` launch stage has been
 selected for a role, the `stage` field will not be included in the
 returned definition for the role.
      .google.iam.admin.v1.Role.RoleLaunchStage stage = 8;
      Specified by:
      getStageValue in interface RoleOrBuilder
      Returns:
      The enum numeric value on the wire for stage.

    • getStage

      public Role.RoleLaunchStage getStage()
       The current launch stage of the role. If the `ALPHA` launch stage has been
 selected for a role, the `stage` field will not be included in the
 returned definition for the role.
      .google.iam.admin.v1.Role.RoleLaunchStage stage = 8;
      Specified by:
      getStage in interface RoleOrBuilder
      Returns:
      The stage.

    • getEtag

      public com.google.protobuf.ByteString getEtag()
       Used to perform a consistent read-modify-write.
      bytes etag = 9;
      Specified by:
      getEtag in interface RoleOrBuilder
      Returns:
      The etag.

    • getDeleted

      public boolean getDeleted()
       The current deleted state of the role. This field is read only.
 It will be ignored in calls to CreateRole and UpdateRole.
      bool deleted = 11;
      Specified by:
      getDeleted in interface RoleOrBuilder
      Returns:
      The deleted.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Role parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Role parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Role parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Role parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Role parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Role parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Role parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Role parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Role parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Role parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Role parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Role parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Role.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Role.Builder newBuilder()

    • newBuilder

      public static Role.Builder newBuilder(Role prototype)

    • toBuilder

      public Role.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Role.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Role getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Role> parser()

    • getParserForType

      public com.google.protobuf.Parser<Role> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Role getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder