Package com.google.iam.admin.v1

Class 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.GeneratedMessageV3.Builder<ListRolesRequest.Builder>
implements ListRolesRequestOrBuilder
     The request to get all roles defined under a resource.
    Protobuf type google.iam.admin.v1.ListRolesRequest

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

      • clone

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

      • setField

        public ListRolesRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>

      • clearField

        public ListRolesRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>

      • clearOneof

        public ListRolesRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>

      • setRepeatedField

        public ListRolesRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>

      • addRepeatedField

        public ListRolesRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.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>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.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.

      • setUnknownFields

        public final ListRolesRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>

      • mergeUnknownFields

        public final ListRolesRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListRolesRequest.Builder>