A role in the Identity and Access Management API.

Generated from protobuf message google.iam.admin.v1.Role

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

    • return
    public Google\Protobuf\Internal\Message::discardUnknownFields()
     

    Clear all unknown fields previously parsed.

    • return
    public getDeleted()
     

    The current deleted state of the role. This field is read only.

    It will be ignored in calls to CreateRole and UpdateRole.

    Generated from protobuf field bool deleted = 11;

    • return bool
    public getDescription()
     

    Optional. A human-readable description for the role.

    Generated from protobuf field string description = 3;

    • return string
    public getEtag()
     

    Used to perform a consistent read-modify-write.

    Generated from protobuf field bytes etag = 9;

    • return string
    public getIncludedPermissions()
     

    The names of the permissions this role grants when bound in an IAM policy.

    Generated from protobuf field repeated string included_permissions = 7;

    public 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.

    Generated from protobuf field string name = 1;

    • return string
    public 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.

    Generated from protobuf field .google.iam.admin.v1.Role.RoleLaunchStage stage = 8;

    • return int
    public getTitle()
     

    Optional. A human-readable title for the role. Typically this
    is limited to 100 UTF-8 bytes.

    Generated from protobuf field string title = 2;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
     

    Merges the contents of the specified message into current message.

    This method merges the contents of the specified message into the
    current message. Singular fields that are set in the specified message
    overwrite the corresponding fields in the current message. Repeated
    fields are appended. Map fields key-value pairs are overwritten.
    Singular/Oneof sub-messages are recursively merged. All overwritten
    sub-messages are deep-copied.

    • return
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
     

    Parses a json string to protobuf message.

    This function takes a string in the json wire format, matching the
    encoding output by serializeToJsonString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
     

    Parses a protocol buffer contained in a string.

    This function takes a string in the (non-human-readable) binary wire
    format, matching the encoding output by serializeToString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
     
    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     

    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     

    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setDeleted( $var)
     

    The current deleted state of the role. This field is read only.

    It will be ignored in calls to CreateRole and UpdateRole.

    Generated from protobuf field bool deleted = 11;

    • return $this
    public setDescription( $var)
     

    Optional. A human-readable description for the role.

    Generated from protobuf field string description = 3;

    • return $this
    public setEtag( $var)
     

    Used to perform a consistent read-modify-write.

    Generated from protobuf field bytes etag = 9;

    • return $this
    public setIncludedPermissions( $var)
     

    The names of the permissions this role grants when bound in an IAM policy.

    Generated from protobuf field repeated string included_permissions = 7;

    • return $this
    public setName( $var)
     

    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.

    Generated from protobuf field string name = 1;

    • return $this
    public setStage( $var)
     

    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.

    Generated from protobuf field .google.iam.admin.v1.Role.RoleLaunchStage stage = 8;

    • return $this
    public setTitle( $var)
     

    Optional. A human-readable title for the role. Typically this
    is limited to 100 UTF-8 bytes.

    Generated from protobuf field string title = 2;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
     

    Populates the message from a user-supplied PHP array. Array keys
    correspond to Message properties and nested message properties.

    Example:

    $message->mergeFromArray([
        'name' => 'This is a message name',
        'interval' => [
             'startTime' => time() - 60,
             'endTime' => time(),
        ]
    ]);
    

    This method will trigger an error if it is passed data that cannot
    be converted to the correct type. For example, a StringValue field
    must receive data that is either a string or a StringValue object.

    • return
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $deleted
     

    The current deleted state of the role. This field is read only.

    It will be ignored in calls to CreateRole and UpdateRole.

    Generated from protobuf field bool deleted = 11;

    private $description
     

    Optional. A human-readable description for the role.

    Generated from protobuf field string description = 3;

    private $etag
     

    Used to perform a consistent read-modify-write.

    Generated from protobuf field bytes etag = 9;

    private $included_permissions
     

    The names of the permissions this role grants when bound in an IAM policy.

    Generated from protobuf field repeated string included_permissions = 7;

    private $name
     

    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.

    Generated from protobuf field string name = 1;

    private $stage
     

    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.

    Generated from protobuf field .google.iam.admin.v1.Role.RoleLaunchStage stage = 8;

    private $title
     

    Optional. A human-readable title for the role. Typically this
    is limited to 100 UTF-8 bytes.

    Generated from protobuf field string title = 2;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    Tries to normalize the elements in $value into a provided protobuf
    wrapper type $class. If $value is any type other than array, we do
    not do any conversion, and instead rely on the existing protobuf
    type checking. If $value is an array, we process each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only