Interface ListProfilesRequestOrBuilder (2.2.9)

public interface ListProfilesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

The filter string specifies the profiles to be enumerated. Supported operator: =, AND The field(s) eligible for filtering are:

externalId
groupId externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error. Sample Query:
externalId = "externalId-1"
groupId = "groupId-1"

string filter = 5;

Returns

Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

The filter string specifies the profiles to be enumerated. Supported operator: =, AND The field(s) eligible for filtering are:

externalId
groupId externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error. Sample Query:
externalId = "externalId-1"
groupId = "groupId-1"

string filter = 5;

Returns

Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int getPageSize()

The maximum number of profiles to be returned, at most 100. Default is 100 unless a positive number smaller than 100 is specified.

int32 page_size = 3;

Returns

Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

The token that specifies the current offset (that is, starting result). Please set the value to ListProfilesResponse.next_page_token to continue the list.

string page_token = 2;

Returns

Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The token that specifies the current offset (that is, starting result). Please set the value to ListProfilesResponse.next_page_token to continue the list.

string page_token = 2;

Returns

Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The resource name of the tenant under which the profile is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

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

Returns

Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The resource name of the tenant under which the profile is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

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

Returns

Type	Description
ByteString	The bytes for parent.

getReadMask()

public abstract FieldMask getReadMask()

A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset. Valid values are:

name

.google.protobuf.FieldMask read_mask = 4;

Returns

Type	Description
FieldMask	The readMask.

getReadMaskOrBuilder()

public abstract FieldMaskOrBuilder getReadMaskOrBuilder()

A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset. Valid values are:

name

.google.protobuf.FieldMask read_mask = 4;

Returns

Type	Description
FieldMaskOrBuilder

hasReadMask()

public abstract boolean hasReadMask()

A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset. Valid values are:

name

.google.protobuf.FieldMask read_mask = 4;

Returns

Type	Description
boolean	Whether the readMask field is set.