public final class ListRolesRequest extends GeneratedMessageV3 implements ListRolesRequestOrBuilder
The request to get all roles defined under a resource.
Protobuf type google.iam.admin.v1.ListRolesRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListRolesRequestImplements
ListRolesRequestOrBuilderStatic Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Type | Description |
int |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Type | Description |
int |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Type | Description |
int |
SHOW_DELETED_FIELD_NUMBER
public static final int SHOW_DELETED_FIELD_NUMBER
Type | Description |
int |
VIEW_FIELD_NUMBER
public static final int VIEW_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static ListRolesRequest getDefaultInstance()
Type | Description |
ListRolesRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static ListRolesRequest.Builder newBuilder()
Type | Description |
ListRolesRequest.Builder |
newBuilder(ListRolesRequest prototype)
public static ListRolesRequest.Builder newBuilder(ListRolesRequest prototype)
Name | Description |
prototype | ListRolesRequest |
Type | Description |
ListRolesRequest.Builder |
parseDelimitedFrom(InputStream input)
public static ListRolesRequest parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
ListRolesRequest |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListRolesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListRolesRequest |
Type | Description |
IOException |
parseFrom(byte[] data)
public static ListRolesRequest parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
ListRolesRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListRolesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListRolesRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ListRolesRequest parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
ListRolesRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListRolesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListRolesRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ListRolesRequest parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
ListRolesRequest |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListRolesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListRolesRequest |
Type | Description |
IOException |
parseFrom(InputStream input)
public static ListRolesRequest parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
ListRolesRequest |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListRolesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListRolesRequest |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static ListRolesRequest parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
ListRolesRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListRolesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListRolesRequest |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<ListRolesRequest> parser()
Type | Description |
Parser<ListRolesRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
getDefaultInstanceForType()
public ListRolesRequest getDefaultInstanceForType()
Type | Description |
ListRolesRequest |
getPageSize()
public 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;
Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional pagination token returned in an earlier ListRolesResponse.
string page_token = 3;
Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public String 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:
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.
string parent = 1 [(.google.api.resource_reference) = { ... }
Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes()
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.
string parent = 1 [(.google.api.resource_reference) = { ... }
Type | Description |
ByteString | The bytes for parent. |
getParserForType()
public Parser<ListRolesRequest> getParserForType()
Type | Description |
Parser<ListRolesRequest> |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getShowDeleted()
public boolean getShowDeleted()
Include Roles that have been deleted.
bool show_deleted = 6;
Type | Description |
boolean | The showDeleted. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
getView()
public 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;
Type | Description |
RoleView | The view. |
getViewValue()
public 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;
Type | Description |
int | The enum numeric value on the wire for view. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public ListRolesRequest.Builder newBuilderForType()
Type | Description |
ListRolesRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListRolesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
ListRolesRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public ListRolesRequest.Builder toBuilder()
Type | Description |
ListRolesRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |