Struct google_api_proto::google::iam::admin::v1::ListRolesRequest

pub struct ListRolesRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub view: i32,
    pub show_deleted: bool,
}

The request to get all roles defined under a resource.

Fields

parent: String

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:

• roles.list(): An empty string. 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.

page_size: i32

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

The default is 300, and the maximum is 1,000.

page_token: String

Optional pagination token returned in an earlier ListRolesResponse.

view: i32

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.

show_deleted: bool

Include Roles that have been deleted.

Implementations

impl ListRolesRequest

pub fn view(&self) -> RoleView

Returns the enum value of view, or the default if the field is set to an invalid enum value.

pub fn set_view(&mut self, value: RoleView)

Sets view to the provided enum value.

Trait Implementations

impl Clone for ListRolesRequest

fn clone(&self) -> ListRolesRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListRolesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListRolesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListRolesRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListRolesRequest

fn eq(&self, other: &ListRolesRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListRolesRequest