Class ListProfilesRequest

Stay organized with collections Save and categorize content based on your preferences.
public final class ListProfilesRequest extends GeneratedMessageV3 implements ListProfilesRequestOrBuilder

List profiles request.

Protobuf type google.cloud.talent.v4beta1.ListProfilesRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListProfilesRequest getDefaultInstance()
Returns
TypeDescription
ListProfilesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ListProfilesRequest.Builder newBuilder()
Returns
TypeDescription
ListProfilesRequest.Builder

newBuilder(ListProfilesRequest prototype)

public static ListProfilesRequest.Builder newBuilder(ListProfilesRequest prototype)
Parameter
NameDescription
prototypeListProfilesRequest
Returns
TypeDescription
ListProfilesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListProfilesRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListProfilesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListProfilesRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListProfilesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListProfilesRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListProfilesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListProfilesRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListProfilesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListProfilesRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListProfilesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListProfilesRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListProfilesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListProfilesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListProfilesRequest> parser()
Returns
TypeDescription
Parser<ListProfilesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ListProfilesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListProfilesRequest

getFilter()

public 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
TypeDescription
String

The filter.

getFilterBytes()

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

The bytes for filter.

getPageSize()

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

The pageSize.

getPageToken()

public 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
TypeDescription
String

The pageToken.

getPageTokenBytes()

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

The bytes for pageToken.

getParent()

public 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
TypeDescription
String

The parent.

getParentBytes()

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

The bytes for parent.

getParserForType()

public Parser<ListProfilesRequest> getParserForType()
Returns
TypeDescription
Parser<ListProfilesRequest>
Overrides

getReadMask()

public 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
TypeDescription
FieldMask

The readMask.

getReadMaskOrBuilder()

public 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
TypeDescription
FieldMaskOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasReadMask()

public 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
TypeDescription
boolean

Whether the readMask field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListProfilesRequest.Builder newBuilderForType()
Returns
TypeDescription
ListProfilesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListProfilesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListProfilesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListProfilesRequest.Builder toBuilder()
Returns
TypeDescription
ListProfilesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException