Package com.google.iam.admin.v1

Class ListRolesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListRolesRequest.Builder>
com.google.iam.admin.v1.ListRolesRequest.Builder
All Implemented Interfaces:
ListRolesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListRolesRequest
public static final class ListRolesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListRolesRequest.Builder> implements ListRolesRequestOrBuilder
 The request to get all roles defined under a resource.
Protobuf type google.iam.admin.v1.ListRolesRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    ListRolesRequest
    build()
     
    ListRolesRequest
    buildPartial()
     
    ListRolesRequest.Builder
    clear()
     
    ListRolesRequest.Builder
    clearPageSize()
    Optional limit on the number of roles to include in the response.
    ListRolesRequest.Builder
    clearPageToken()
    Optional pagination token returned in an earlier ListRolesResponse.
    ListRolesRequest.Builder
    clearParent()
    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).
    ListRolesRequest.Builder
    clearShowDeleted()
    Include Roles that have been deleted.
    ListRolesRequest.Builder
    clearView()
    Optional view for the returned Role objects.
    ListRolesRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    ListRolesRequest.Builder
    mergeFrom(ListRolesRequest other)
     
    ListRolesRequest.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    ListRolesRequest.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    ListRolesRequest.Builder
    setPageSize(int value)
    Optional limit on the number of roles to include in the response.
    ListRolesRequest.Builder
    setPageToken(String value)
    Optional pagination token returned in an earlier ListRolesResponse.
    ListRolesRequest.Builder
    setPageTokenBytes(com.google.protobuf.ByteString value)
    Optional pagination token returned in an earlier ListRolesResponse.
    ListRolesRequest.Builder
    setParent(String value)
    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).
    ListRolesRequest.Builder
    setParentBytes(com.google.protobuf.ByteString value)
    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).
    ListRolesRequest.Builder
    setShowDeleted(boolean value)
    Include Roles that have been deleted.
    ListRolesRequest.Builder
    setView(RoleView value)
    Optional view for the returned Role objects.
    ListRolesRequest.Builder
    setViewValue(int value)
    Optional view for the returned Role objects.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • 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.Builder<ListRolesRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListRolesRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ListRolesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListRolesRequest.Builder>

    • mergeFrom

      public ListRolesRequest.Builder mergeFrom(ListRolesRequest other)

    • isInitialized

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

    • mergeFrom

      public ListRolesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListRolesRequest.Builder>
      Throws:
      IOException

    • 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.

    • setParent

      public ListRolesRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListRolesRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public ListRolesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPageSize

      public ListRolesRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListRolesRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • 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.

    • setPageToken

      public ListRolesRequest.Builder setPageToken(String value)
       Optional pagination token returned in an earlier ListRolesResponse.
      string page_token = 3;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListRolesRequest.Builder clearPageToken()
       Optional pagination token returned in an earlier ListRolesResponse.
      string page_token = 3;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListRolesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Optional pagination token returned in an earlier ListRolesResponse.
      string page_token = 3;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setViewValue

      public ListRolesRequest.Builder setViewValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for view to set.
      Returns:
      This builder for chaining.

    • 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.

    • setView

      public ListRolesRequest.Builder setView(RoleView value)
       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;
      Parameters:
      value - The view to set.
      Returns:
      This builder for chaining.

    • clearView

      public ListRolesRequest.Builder clearView()
       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:
      This builder for chaining.

    • getShowDeleted

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

    • setShowDeleted

      public ListRolesRequest.Builder setShowDeleted(boolean value)
       Include Roles that have been deleted.
      bool show_deleted = 6;
      Parameters:
      value - The showDeleted to set.
      Returns:
      This builder for chaining.

    • clearShowDeleted

      public ListRolesRequest.Builder clearShowDeleted()
       Include Roles that have been deleted.
      bool show_deleted = 6;
      Returns:
      This builder for chaining.