The request to get all roles defined under a resource.

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

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

    Optional limit on the number of roles to include in the response.

    Generated from protobuf field int32 page_size = 2;

    • return int
    public getPageToken()
     

    Optional pagination token returned in an earlier ListRolesResponse.

    Generated from protobuf field string page_token = 3;

    • return string
    public getParent()
     

    The parent parameter's value depends on the target resource for the
    request, namely
    roles,
    projects, or
    organizations. Each
    resource type's parent value format is described below:

    This method doesn't require a resource; it simply returns all
    predefined roles in
    Cloud IAM. Example request URL:
    https://iam.googleapis.com/v1/roles

    • projects.roles.list():
      projects/{PROJECT_ID}. This method lists all project-level
      custom roles.
      Example request URL:
      https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles
    • organizations.roles.list():
      organizations/{ORGANIZATION_ID}. This method lists all
      organization-level custom roles.
      Example request URL:
      https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles
      Note: Wildcard (*) values are invalid; you must specify a complete project
      ID or organization ID.

    Generated from protobuf field string parent = 1 [(.google.api.resource_reference) = {

    • return string
    public getShowDeleted()
     

    Include Roles that have been deleted.

    Generated from protobuf field bool show_deleted = 6;

    • return bool
    public getView()
     

    Optional view for the returned Role objects. When FULL is specified,
    the includedPermissions field is returned, which includes a list of all
    permissions in the role. The default value is BASIC, which does not
    return the includedPermissions field.

    Generated from protobuf field .google.iam.admin.v1.RoleView view = 4;

    • return int
    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 setPageSize( $var)
     

    Optional limit on the number of roles to include in the response.

    Generated from protobuf field int32 page_size = 2;

    • return $this
    public setPageToken( $var)
     

    Optional pagination token returned in an earlier ListRolesResponse.

    Generated from protobuf field string page_token = 3;

    • return $this
    public setParent( $var)
     

    The parent parameter's value depends on the target resource for the
    request, namely
    roles,
    projects, or
    organizations. Each
    resource type's parent value format is described below:

    This method doesn't require a resource; it simply returns all
    predefined roles in
    Cloud IAM. Example request URL:
    https://iam.googleapis.com/v1/roles

    • projects.roles.list():
      projects/{PROJECT_ID}. This method lists all project-level
      custom roles.
      Example request URL:
      https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles
    • organizations.roles.list():
      organizations/{ORGANIZATION_ID}. This method lists all
      organization-level custom roles.
      Example request URL:
      https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles
      Note: Wildcard (*) values are invalid; you must specify a complete project
      ID or organization ID.

    Generated from protobuf field string parent = 1 [(.google.api.resource_reference) = {

    • return $this
    public setShowDeleted( $var)
     

    Include Roles that have been deleted.

    Generated from protobuf field bool show_deleted = 6;

    • return $this
    public setView( $var)
     

    Optional view for the returned Role objects. When FULL is specified,
    the includedPermissions field is returned, which includes a list of all
    permissions in the role. The default value is BASIC, which does not
    return the includedPermissions field.

    Generated from protobuf field .google.iam.admin.v1.RoleView view = 4;

    • 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 $page_size
     

    Optional limit on the number of roles to include in the response.

    Generated from protobuf field int32 page_size = 2;

    private $page_token
     

    Optional pagination token returned in an earlier ListRolesResponse.

    Generated from protobuf field string page_token = 3;

    private $parent
     

    The parent parameter's value depends on the target resource for the
    request, namely
    roles,
    projects, or
    organizations. Each
    resource type's parent value format is described below:

    This method doesn't require a resource; it simply returns all
    predefined roles in
    Cloud IAM. Example request URL:
    https://iam.googleapis.com/v1/roles

    • projects.roles.list():
      projects/{PROJECT_ID}. This method lists all project-level
      custom roles.
      Example request URL:
      https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles
    • organizations.roles.list():
      organizations/{ORGANIZATION_ID}. This method lists all
      organization-level custom roles.
      Example request URL:
      https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles
      Note: Wildcard (*) values are invalid; you must specify a complete project
      ID or organization ID.

    Generated from protobuf field string parent = 1 [(.google.api.resource_reference) = {

    private $show_deleted
     

    Include Roles that have been deleted.

    Generated from protobuf field bool show_deleted = 6;

    private $view
     

    Optional view for the returned Role objects. When FULL is specified,
    the includedPermissions field is returned, which includes a list of all
    permissions in the role. The default value is BASIC, which does not
    return the includedPermissions field.

    Generated from protobuf field .google.iam.admin.v1.RoleView view = 4;

    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