Package com.google.iam.admin.v1

Interface ListRolesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListRolesRequest, ListRolesRequest.Builder
@Generated public interface ListRolesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    Optional limit on the number of roles to include in the response.
    String
    getPageToken()
    Optional pagination token returned in an earlier ListRolesResponse.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional pagination token returned in an earlier ListRolesResponse.
    String
    getParent()
    The `parent` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
    com.google.protobuf.ByteString
    getParentBytes()
    The `parent` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
    boolean
    getShowDeleted()
    Include Roles that have been deleted.
    RoleView
    getView()
    Optional view for the returned Role objects.
    int
    getViewValue()
    Optional view for the returned Role objects.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getParent

      String getParent()
       The `parent` parameter's value depends on the target resource for the
 request, namely
 [`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
 [`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
 or
 [`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
 Each resource type's `parent` value format is described below:

 * [`roles.list()`](https://cloud.google.com/iam/reference/rest/v1/roles/list): An empty string.
 This method doesn't require a resource; it simply returns all
 [predefined
 roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
 in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles`

 * [`projects.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/list):
 `projects/{PROJECT_ID}`. This method lists all project-level
 [custom
 roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
 Example request URL:
 `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`

 * [`organizations.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/list):
 `organizations/{ORGANIZATION_ID}`. This method lists all
 organization-level [custom
 roles](https://cloud.google.com/iam/docs/understanding-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.
      string parent = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       The `parent` parameter's value depends on the target resource for the
 request, namely
 [`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
 [`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
 or
 [`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
 Each resource type's `parent` value format is described below:

 * [`roles.list()`](https://cloud.google.com/iam/reference/rest/v1/roles/list): An empty string.
 This method doesn't require a resource; it simply returns all
 [predefined
 roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
 in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles`

 * [`projects.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/list):
 `projects/{PROJECT_ID}`. This method lists all project-level
 [custom
 roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
 Example request URL:
 `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`

 * [`organizations.roles.list()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/list):
 `organizations/{ORGANIZATION_ID}`. This method lists all
 organization-level [custom
 roles](https://cloud.google.com/iam/docs/understanding-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.
      string parent = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       Optional limit on the number of roles to include in the response.

 The default is 300, and the maximum is 1,000.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional pagination token returned in an earlier ListRolesResponse.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional pagination token returned in an earlier ListRolesResponse.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • getViewValue

      int getViewValue()
       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.
      .google.iam.admin.v1.RoleView view = 4;
      Returns:
      The enum numeric value on the wire for view.

    • getView

      RoleView 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.
      .google.iam.admin.v1.RoleView view = 4;
      Returns:
      The view.

    • getShowDeleted

      boolean getShowDeleted()
       Include Roles that have been deleted.
      bool show_deleted = 6;
      Returns:
      The showDeleted.