Class Role.Builder

  • All Implemented Interfaces:
    RoleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Role

    public static final class Role.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
    implements RoleOrBuilder
     A role in the Identity and Access Management API.
     
    Protobuf type google.iam.admin.v1.Role
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • clear

        public Role.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • getDefaultInstanceForType

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

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

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

        public Role.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • setField

        public Role.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • clearField

        public Role.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • clearOneof

        public Role.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • setRepeatedField

        public Role.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • addRepeatedField

        public Role.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • mergeFrom

        public Role.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Role.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • mergeFrom

        public Role.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Role.Builder>
        Throws:
        IOException
      • 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.
      • setName

        public Role.Builder setName​(String value)
         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;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public Role.Builder clearName()
         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;
        Returns:
        This builder for chaining.
      • setNameBytes

        public Role.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • 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.
      • setTitle

        public Role.Builder setTitle​(String value)
         Optional. A human-readable title for the role.  Typically this
         is limited to 100 UTF-8 bytes.
         
        string title = 2;
        Parameters:
        value - The title to set.
        Returns:
        This builder for chaining.
      • clearTitle

        public Role.Builder clearTitle()
         Optional. A human-readable title for the role.  Typically this
         is limited to 100 UTF-8 bytes.
         
        string title = 2;
        Returns:
        This builder for chaining.
      • setTitleBytes

        public Role.Builder setTitleBytes​(com.google.protobuf.ByteString value)
         Optional. A human-readable title for the role.  Typically this
         is limited to 100 UTF-8 bytes.
         
        string title = 2;
        Parameters:
        value - The bytes for title to set.
        Returns:
        This builder for chaining.
      • 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.
      • setDescription

        public Role.Builder setDescription​(String value)
         Optional. A human-readable description for the role.
         
        string description = 3;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.
      • clearDescription

        public Role.Builder clearDescription()
         Optional. A human-readable description for the role.
         
        string description = 3;
        Returns:
        This builder for chaining.
      • setDescriptionBytes

        public Role.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         Optional. A human-readable description for the role.
         
        string description = 3;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.
      • 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.
      • setIncludedPermissions

        public Role.Builder setIncludedPermissions​(int index,
                                                   String value)
         The names of the permissions this role grants when bound in an IAM policy.
         
        repeated string included_permissions = 7;
        Parameters:
        index - The index to set the value at.
        value - The includedPermissions to set.
        Returns:
        This builder for chaining.
      • addIncludedPermissions

        public Role.Builder addIncludedPermissions​(String value)
         The names of the permissions this role grants when bound in an IAM policy.
         
        repeated string included_permissions = 7;
        Parameters:
        value - The includedPermissions to add.
        Returns:
        This builder for chaining.
      • addAllIncludedPermissions

        public Role.Builder addAllIncludedPermissions​(Iterable<String> values)
         The names of the permissions this role grants when bound in an IAM policy.
         
        repeated string included_permissions = 7;
        Parameters:
        values - The includedPermissions to add.
        Returns:
        This builder for chaining.
      • clearIncludedPermissions

        public Role.Builder clearIncludedPermissions()
         The names of the permissions this role grants when bound in an IAM policy.
         
        repeated string included_permissions = 7;
        Returns:
        This builder for chaining.
      • addIncludedPermissionsBytes

        public Role.Builder addIncludedPermissionsBytes​(com.google.protobuf.ByteString value)
         The names of the permissions this role grants when bound in an IAM policy.
         
        repeated string included_permissions = 7;
        Parameters:
        value - The bytes of the includedPermissions to add.
        Returns:
        This builder for chaining.
      • 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.
      • setStageValue

        public Role.Builder setStageValue​(int value)
         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;
        Parameters:
        value - The enum numeric value on the wire for stage to set.
        Returns:
        This builder for chaining.
      • 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.
      • setStage

        public Role.Builder setStage​(Role.RoleLaunchStage value)
         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;
        Parameters:
        value - The stage to set.
        Returns:
        This builder for chaining.
      • clearStage

        public Role.Builder clearStage()
         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;
        Returns:
        This builder for chaining.
      • 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.
      • setEtag

        public Role.Builder setEtag​(com.google.protobuf.ByteString value)
         Used to perform a consistent read-modify-write.
         
        bytes etag = 9;
        Parameters:
        value - The etag to set.
        Returns:
        This builder for chaining.
      • clearEtag

        public Role.Builder clearEtag()
         Used to perform a consistent read-modify-write.
         
        bytes etag = 9;
        Returns:
        This builder for chaining.
      • 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.
      • setDeleted

        public Role.Builder setDeleted​(boolean value)
         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;
        Parameters:
        value - The deleted to set.
        Returns:
        This builder for chaining.
      • clearDeleted

        public Role.Builder clearDeleted()
         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;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final Role.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>
      • mergeUnknownFields

        public final Role.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Role.Builder>