Class ListRolesRequest.Builder (3.1.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListRolesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListRolesRequest.Builder
Overrides

build()

public ListRolesRequest build()
Returns
TypeDescription
ListRolesRequest

buildPartial()

public ListRolesRequest buildPartial()
Returns
TypeDescription
ListRolesRequest

clear()

public ListRolesRequest.Builder clear()
Returns
TypeDescription
ListRolesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListRolesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListRolesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListRolesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
ListRolesRequest.Builder

This builder for chaining.

clearPageToken()

public ListRolesRequest.Builder clearPageToken()

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Returns
TypeDescription
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
TypeDescription
ListRolesRequest.Builder

This builder for chaining.

clearShowDeleted()

public ListRolesRequest.Builder clearShowDeleted()

Include Roles that have been deleted.

bool show_deleted = 6;

Returns
TypeDescription
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
TypeDescription
ListRolesRequest.Builder

This builder for chaining.

clone()

public ListRolesRequest.Builder clone()
Returns
TypeDescription
ListRolesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListRolesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListRolesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional pagination token returned in an earlier ListRolesResponse.

string page_token = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getShowDeleted()

public boolean getShowDeleted()

Include Roles that have been deleted.

bool show_deleted = 6;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListRolesRequest other)

public ListRolesRequest.Builder mergeFrom(ListRolesRequest other)
Parameter
NameDescription
otherListRolesRequest
Returns
TypeDescription
ListRolesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListRolesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListRolesRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListRolesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListRolesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListRolesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListRolesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListRolesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListRolesRequest.Builder
Overrides

setShowDeleted(boolean value)

public ListRolesRequest.Builder setShowDeleted(boolean value)

Include Roles that have been deleted.

bool show_deleted = 6;

Parameter
NameDescription
valueboolean

The showDeleted to set.

Returns
TypeDescription
ListRolesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListRolesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueRoleView

The view to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
ListRolesRequest.Builder

This builder for chaining.