Class ListRolesRequest.Builder (3.39.0)

public static final class ListRolesRequest.Builder extends GeneratedMessageV3.Builder<ListRolesRequest.Builder> implements ListRolesRequestOrBuilder

The request to get all roles defined under a resource.

Protobuf type google.iam.admin.v1.ListRolesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListRolesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListRolesRequest.Builder
Overrides

build()

public ListRolesRequest build()
Returns
Type Description
ListRolesRequest

buildPartial()

public ListRolesRequest buildPartial()
Returns
Type Description
ListRolesRequest

clear()

public ListRolesRequest.Builder clear()
Returns
Type Description
ListRolesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListRolesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListRolesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListRolesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListRolesRequest.Builder
Overrides

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
Type Description
ListRolesRequest.Builder

This builder for chaining.

clearPageToken()

public ListRolesRequest.Builder clearPageToken()

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

clearParent()

public ListRolesRequest.Builder clearParent()

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:

string parent = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

clearShowDeleted()

public ListRolesRequest.Builder clearShowDeleted()

Include Roles that have been deleted.

bool show_deleted = 6;

Returns
Type Description
ListRolesRequest.Builder

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
Type Description
ListRolesRequest.Builder

This builder for chaining.

clone()

public ListRolesRequest.Builder clone()
Returns
Type Description
ListRolesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListRolesRequest getDefaultInstanceForType()
Returns
Type Description
ListRolesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Returns
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:

string parent = 1 [(.google.api.resource_reference) = { ... }

Returns
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:

string parent = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getShowDeleted()

public boolean getShowDeleted()

Include Roles that have been deleted.

bool show_deleted = 6;

Returns
Type Description
boolean

The showDeleted.

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;

Returns
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;

Returns
Type Description
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListRolesRequest other)

public ListRolesRequest.Builder mergeFrom(ListRolesRequest other)
Parameter
Name Description
other ListRolesRequest
Returns
Type Description
ListRolesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListRolesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListRolesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListRolesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListRolesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListRolesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListRolesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListRolesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListRolesRequest.Builder
Overrides

setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListRolesRequest.Builder setPageToken(String value)

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListRolesRequest.Builder setPageTokenBytes(ByteString value)

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

setParent(String value)

public ListRolesRequest.Builder setParent(String value)

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:

string parent = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListRolesRequest.Builder setParentBytes(ByteString value)

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:

string parent = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListRolesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListRolesRequest.Builder
Overrides

setShowDeleted(boolean value)

public ListRolesRequest.Builder setShowDeleted(boolean value)

Include Roles that have been deleted.

bool show_deleted = 6;

Parameter
Name Description
value boolean

The showDeleted to set.

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListRolesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListRolesRequest.Builder
Overrides

setView(RoleView value)

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;

Parameter
Name Description
value RoleView

The view to set.

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.

setViewValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for view to set.

Returns
Type Description
ListRolesRequest.Builder

This builder for chaining.