Package com.google.iam.admin.v1

Class ListRolesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.iam.admin.v1.ListRolesRequest
All Implemented Interfaces:
ListRolesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListRolesRequest extends com.google.protobuf.GeneratedMessage implements ListRolesRequestOrBuilder
 The request to get all roles defined under a resource.
Protobuf type google.iam.admin.v1.ListRolesRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListRolesRequest.Builder
    The request to get all roles defined under a resource.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    PARENT_FIELD_NUMBER
     
    static final int
    SHOW_DELETED_FIELD_NUMBER
     
    static final int
    VIEW_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ListRolesRequest
    getDefaultInstance()
     
    ListRolesRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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).
    com.google.protobuf.Parser<ListRolesRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListRolesRequest.Builder
    newBuilder()
     
    static ListRolesRequest.Builder
    newBuilder(ListRolesRequest prototype)
     
    ListRolesRequest.Builder
    newBuilderForType()
     
    protected ListRolesRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ListRolesRequest
    parseDelimitedFrom(InputStream input)
     
    static ListRolesRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListRolesRequest
    parseFrom(byte[] data)
     
    static ListRolesRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListRolesRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListRolesRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListRolesRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListRolesRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListRolesRequest
    parseFrom(InputStream input)
     
    static ListRolesRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListRolesRequest
    parseFrom(ByteBuffer data)
     
    static ListRolesRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListRolesRequest>
    parser()
     
    ListRolesRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getParent

      public 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) = { ... }
      Specified by:
      getParent in interface ListRolesRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListRolesRequestOrBuilder
      Returns:
      The bytes for parent.

    • 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;
      Specified by:
      getPageSize in interface ListRolesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

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

    • getPageTokenBytes

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

    • 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;
      Specified by:
      getViewValue in interface ListRolesRequestOrBuilder
      Returns:
      The enum numeric value on the wire for view.

    • 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;
      Specified by:
      getView in interface ListRolesRequestOrBuilder
      Returns:
      The view.

    • getShowDeleted

      public boolean getShowDeleted()
       Include Roles that have been deleted.
      bool show_deleted = 6;
      Specified by:
      getShowDeleted in interface ListRolesRequestOrBuilder
      Returns:
      The showDeleted.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListRolesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRolesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRolesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRolesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRolesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRolesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRolesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListRolesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListRolesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListRolesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListRolesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListRolesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListRolesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListRolesRequest.Builder newBuilder()

    • newBuilder

      public static ListRolesRequest.Builder newBuilder(ListRolesRequest prototype)

    • toBuilder

      public ListRolesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListRolesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListRolesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListRolesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListRolesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ListRolesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder